Lumberyard
Legacy Reference

Game Nodes

Flow Graph is deprecated and will be removed in a future version of Lumberyard. Learn about Script Canvas, Lumberyard's new visual scripting environment.

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.

You can use the following flow graph nodes to check and to configure various game settings.

CheckPlatform node

Used to change game events depending on what platform you are running on.

Inputs

Port Type Description
Check Any Triggers a check of the current platform

Outputs

Port Type Description
PC Any Triggers if the platform is PC
Android Any Triggers if the platform is Android
iOS Any Triggers if the platform is iOS

ForceFeedback node

Used to start and stop force feedback effects.

Inputs

Port Type Description
Effect Name String Name of the force feedback effect
Play Any Plays the effect
Intensity Float Intensity level of effect
Delay Float Delays effect start by specified seconds
Stop Any Stops the effect
StopAll Any Stops all effects

ForceFeedbackSetDeviceIndex node

Used to set the receiving device ID for force feedback effects.

Inputs

Port Type Description
DeviceIndex Integer Sets the receiving device ID for force feedback effects

ForceFeedbackTriggerTweaker node

Used to control individual left and right trigger force feedback effects.

Inputs

Port Type Description
LeftTouchActivate Boolean Activates the left touch trigger
LeftGain Float Left trigger gain
LeftEnvelope Integer Left trigger envelope
RightTouchToActivate Boolean Activates the right touch trigger
RightGain Float Right trigger gain
RightEnvelope Integer Right trigger envelope
Activate Any Activates both triggers
Deactivate Any Deactivates both triggers

ForceFeedbackTweaker node

Used to control individual low and high frequency force feedback effects.

Inputs

Port Type Description
LowPass Float Low-frequency force feedback signal
HighPass Float High-frequency force feedback signal
Activate Any Activates force feedback effect
Deactivate Any Deactivates force feedback effect

GetClientActorId node

Used to output the client actor ID.

Inputs

Port Type Description
In Any Gets client actor ID

Outputs

Port Type Description
id Any Outputs client actor ID

GetEntityState node

Used to output the current state of an entity.

Inputs

Port Type Description
Get Any Gets the entity state

Outputs

Port Type Description
State String Outputs the entity state

GetGameRulesEntityId node

Used to get the game rules entity ID.

Inputs

Port Type Description
Get Any Gets the entity ID of the rules script

Outputs

Port Type Description
EntityId Any The entity ID of the rules script

GetSupportedGameRulesForMap node

Used to get and output the supported game rules for a map.

Inputs

Port Type Description
Get Any Gets the game rules
Mapname String Map name

Outputs

Port Type Description
GameRules String Outputs the game rules

GetUsername node

Used to get the user name.

Inputs

Port Type Description
GetUsername Any Gets the user name

Outputs

Port Type Description
Username String Outputs the user name
Error String Triggers if an error occurs

IsLevelOfType node

Used to check if a level is of a given type.

Inputs

Port Type Description
Check Any Checks if a level is of a given type
Type String Level type to check against

Outputs

Port Type Description
Result Boolean The result of the check

ObjectEvent node

Used to broadcast a game object event or send it to a specific entity.

Inputs

Port Type Description
Trigger Any Triggers the node
EventName String Game object event name
EventParam String Game object event parameter

Start node

Fires on the start of a game and used to trigger flow graphs upon level start.

Inputs

Port Type Description
InGame Boolean Triggers game mode to start
InEditor Boolean Triggers editor game mode to start

Outputs

Port Type Description
output Boolean Outputs the game mode