Lumberyard
Legacy Reference

Common Parameters and Properties

This topic references tools and features that are legacy. If you want to use legacy tools in Lumberyard Editor, disable the CryEntity Removal gem using the Project Configurator or the command line. To learn about the latest features, see the Amazon Lumberyard User Guide.

Many entities share common parameters and properties, as follows.

Entity Properties

Use the Entity pane to modify basic entity properties, such as the name of your object or the currently selected layer. You can enter a new name for your object in the first text box in the pane.

Depending on their type, certain entities will have color schemes applied by default. Click the color next to the text box to open the color editor.

Click the layers icon to open the layer window and place your object in the appropriate layer. The layer text box displays the name of the layer that is currently selected.

Standard Parameters

Property Description
Area Increases or decreases the radius of the onscreen object placement helper.
Mtl button Opens the material window for you to pick a material to apply to the object. The custom material path displays in the Mtl text box.
MinSpec Sets the value at which the selected object appears in game detail settings.

Entity Parameters

Use the Entity Params panel to modify common entity parameters. These parameters enable effects that are added to an object, and toggle options such as hiding the object in-game.

Entity Parameters

Property Description
Outdoor Only Prevents an object from rendering when inside a vis area.
Cast Shadow MinSpec Casts a shadow on the selected quality setting and above.
LodRatio Defines the distance from the current camera position when different level of detail models for the object are used.
ViewDistRatio Defines the distance from the current camera position when the object will be rendered.
HiddenInGame Prevents an object from displaying in game mode. This is useful for debugging or prototyping.
Receive Wind Influences an object by any wind that is set up in your level.
RenderNearest Eliminates z-buffer artifacts when rendering in first person view.
NoStaticDecals When set to true, prevents decals from rendering on the object.
Created Through Pool Used for memory optimization for AI entities.

Scripting and Flow Graph Entity Parameters

Use this pane to modify the parameters that are related to entity scripting and Flow Graph.

Scripting and Flow Graph Parameters

Property Description
Edit Script Opens the script file in your associated program and allows you to modify the script for the selected entity. Clicking the > button displays more options for this file.
Reload Script Implements any changes made to the script. This is useful for reviewing particle effects because reloading reactivates the changes.
Entity Archetype Displays the entity name on the button, if the entity is an archetype entity. Opens the archetype in the Database View tool.
Create Creates a new flow graph.
List Lists the flow graphs that are associated with the selected entity.
Remove Removes a flow graph that was created for the entity.
Sequence Displays the name of the sequence, if the entity is used in a track view sequence. Opens the sequence in the Track View editor.
Save State Saves the physical state of a selected entity (when AI/Physics in enabled). This is useful for placing physical props realistically around your level without manually rotating and aligning their positions.
Clear State Clears any saved physical state.

Use this pane to view the entities that are linked to the main entity. Each entity can link to multiple entities. To create an entity link, you create a dynamic link that can be referenced in Lua script.

To create a link, click Pick Target and select the desired entity. You can select multiple entities one at a time while the button is still active.

Double-click a linked entity in the list to select it. Right-click to open a menu with additional commands.

Entity Links Parameters

Property Description
Change Target Entity Changes the entity associated with a link.
Rename Link Renames the selected link.
Delete Link Deletes the selected link.
Pick New Target Provides the same functionality as the Pick Target button.

Entity Events

Use this pane to edit and run the script behind objects. When AI/Physics is enabled, you can test the effect of any changes you have made to the entity script.

Enable AI/Physics to test events.

Entity Event Parameters

Property Description
Input/Output Displays a list of executable script commands.
Pick New Deprecated
Mission Handler Deprecated
Remove Deprecated
Send After choosing an input or output event, click Send to test the effect. For example, an input event called OnKill might kill an entity and OnSpawn might spawn an entity back to life.
Methods Displays a list of executable methods.
Run Displays a list of executable methods.
Goto Deprecated
Add Deprecated

Attached Entities

Use this pane to create links to other objects in the perspective viewport. This pane is visible for certain entities.

Attached Entity Parameters

Property Description
Pick Links two selected objects. You will see the link in the viewport and the object name in the target window.
Remove Removes a link between two objects.
Select Selects an object from the target window. You can also double-click the object name in the target window to select the object.

Shape Parameters

Use this pane to edit the effect area for a shape and create links to other objects in the viewport. This pane is visible for certain entities.

Shape Parameters

Property Description
Num Points Relates to the number of points the shape contains in the perspective viewpoint.
Edit Shape Allows you to edit the selected shape.
Use Transform Gizmo Enables the Transform Gizmo helper.
Reverse Path Used with objects like AIPath and reverses the AI path. The arrow onscreen points in the opposite direction to show the new path direction.
Split Click two parts of your shape to split your shape and create a new independent shape.
Reset Height Flattens the shape and all other points to the height of the selected point.
Pick Links a shape to an object. You will see the link in the viewport and the object name in the target window.
Remove Removes a link between the selected shape and an object.
Select Selects an object from the target window. You can also double-click the object name in the target window to select the object.