Menu
Lumberyard
Legacy Reference

Debug 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 configure various settings used for debugging purposes.

CSVDumper node

Used to store the cell values of the specified .csv file.

Inputs

Port Type Description
filename String CSV file to use
name String column/row name
value0 - value9 Any cell values

ConsoleVariable node

Used to set and get the value of a console variable.

Inputs

Port Type Description
Set Any Set console variable value
Get Any Get console variable value
CVar String Name of console variable
Value String Value of console variable to set

Outputs

Port Type Description
CurValue Current value of the console variable

DisplayMessage node

If an entity is not provided, the local player will be used instead.

Inputs

Port Type Description
Show Any Show message
Hide Any Hide message
message String Message to display on the HUD
DisplayTime FloatFloat Duration that the message will be visible for
posx Float Input x text position
posy Float Input y text position
fontSize Float Input font size
color Vec3 Color of the message text
centered Boolean Centers the text around the coordinates

Outputs

Port Type Description
Show Any Displays the message
Hide Any Hides the message

Draw2d nodes

Draw2d:Circle node

Used to draw a circle.

Inputs

Port Type Description
Draw Any Draws a 2D circle
ScreenX Float X-axis position of the center of the circle
ScreenY Float Y-axis position of the center of the circle
Radius Float Radius of the circle
Color Vec3 Color of the circle
Opacity Float Transparency of the circle
Time Float Number of seconds the circle will be visible for

Draw2d:Line node

Used to draw a line.

Inputs

Port Type Description
Draw Any Draws a line
StartX Float X-axis starting point of the line
StartY Float Y-axis starting point of the line
EndX Float X-axis ending point of the line
EndY Float Y-axis ending point of the line
Color Vec3 Color of the line
Opacity Float Transparency of the line
Time Float Number of seconds the line will be visible for

Draw2d:Rectangle node

Used to draw a rectangle.

Inputs

Port Type Description
Draw Any Draws a rectangle
ScreenX Float X-axis position of the center of the rectangle
ScreenY Float X-axis position of the center of the rectangle
Width Float Width of the rectangle
Height Float Height of the rectangle
Centered Boolean Rectangle centered at ScreenX and ScreenY
Color Vec3 Color of the rectangle
Opacity Float Transparency of the rectangle
Time Float Number of seconds the rectangle will be visible for

Draw2d:Text node

Used to output a text message.

Inputs

Port Type Description
Draw Any Displays text
Text String Text to display
ScreenX Float X-axis position of the text
ScreenY Float Y-axis position of the text
FontSize Float Text message font size
Color Vec3 Color of the text
Opacity Float Transparency of the text
Time Float Number of seconds the text will be visible for

Draw nodes

Draw:AABB node

Used to draw an AABB bounding box.

Inputs

Port Type Description
Draw Any Draws an AABB bounding box
MinPos Vec3 Minimum position of the bounding box
MaxPos Vec3 Maximum position of the bounding box
Color Vec3 Color of the bounding box
Time Float Number of seconds the bounding box will be visible for

Draw:Cone node

Used a draw a cone.

Inputs

Port Type Description
Draw Any Draws a cone
Pos Vec3 Position of the cone
Dir Vec3 Direction of the cone axis
Radius Float Radius of the cone base
Height Float Height of the cone
Color Vec3 Color of the cone
Time Float Number of seconds the cone will be visible for

Draw:Cylinder node

Used to draw a cylinder.

Inputs

Port Type Description
Draw Any Draws a cylinder
Pos Vec3 Position of the cylinder
Dir Vec3 Direction of the cylinder axis
Radius Float Radius of the cylinder
Height Float Height of the cylinder
Color Vec3 Color of the cylinder
Time Float Number of seconds the cylinder will be visible for

Draw:Direction node

Used to draw an arrow.

Inputs

Port Type Description
Draw Any Draws an arrow
Pos Vec3 Position of the arrow
Dir Vec3 Direction the arrow is pointing
Radius Float Radius of the arrow head
Color Vec3 Color of the arrow
Time Float Number of seconds the arrow will be visible for

Draw:EntityTag node

Used to draw a text message above an entity.

Inputs

Port Type Description
Draw Any Displays a text message above an entity
Message String Text message
FontSize Float Text message font size
Color Vec3 Text message color
Time Float Number of seconds the message will be visible for

Outputs

Port Type Description
Done Triggers when the text message is no longer visible

Draw:EntityTagAdvanced node

Used to draw a text message above an entity.

Inputs

Port Type Description
Draw Any Displays a text message above an entity
Message String Message to be displayed
FadeTime Float Number of seconds for text message to fade outr
FontSize Float Font size of the text message
ViewDistance Float Distance from camera the entity must be within for message to be displayed
StaticID String Static tag ID
ColumnNum Integer Which column above an entity the message will be displayed in
Color Vec3 Color of the text message
Time Float Number of seconds the text message will be visible for

Outputs

Port Type Description
Done Any Triggers when the text message is no longer visible

Draw:Line node

Used to draw a line.

Inputs

Port Type Description
Draw Any Draws a line in 3D space
Pos1 Vec3 Starting point of the line
Pos2 Vec3 Ending point of the line
Dir Vec3 Direction of the line
Length Float Length of the line
Color Vec3 Color of the line
Time Float Number of seconds the circle will be visible for

Draw:PlanarDisc node

Used to draw a disc.

Inputs

Port Type Description
Draw Any Draws a disc
Pos Vec3 Position of the disc center
InnerRadius Float Inner radius of the disc
OuterRadius Float Outer radius of the disc
Color Vec3 Color of the disc
Time Float Number of seconds the circle will be visible for

Draw:Sphere node

Used to draw a sphere.

Inputs

Port Type Description
Draw Any Draws a sphere
Pos Vec3 Position of the sphere center
Radius Float Radius of the sphere
Color Vec3 Color of the sphere
Time Float Number of seconds the circle will be visible for

ExecuteString node

Used to execute a string when using the console.

Inputs

Port Type Description
Set Any Executes the string
String String String to be executed
NextFrame Boolean String will be executed next frame

FloatToString node

Used to output a float value in string format with a limited number of decimals.

Inputs

Port Type Description
Activate Any Activates the node
Number Float Floating point number to convert
AmountOfDecimals Integer Nimber of decimal places for the floating point

Outputs

Port Type Description
Out String Outputs a string representation of the floating point input

Frame node

Used to output the current frame rate data.

Outputs

Port Type Description
frametime Float Current frame time
framerate Float Current frame rate
frameid Integer Frame ID

FrameExtended node

Used to output extended current frame rate data.

Inputs

Port Type Description
Start Any Start collecting frame rate data
Stop Any Stop collecting frame rate data
Reset Any Resets the data

Outputs

Port Type Description
FrameTime Float Current frame time
FrameRate Float Current frame rate
FrameId Integer Frame ID
MinFrameRate Float Minimum frame rate
MaxFrameRate Float Maximum frame rate
AverageFrameRate Float Average frame rate

InputKey node

Used to catch key inputs. The Entity input is required for multiplayer games.

Inputs

Port Type Description
Enable Any Activates the node
Disable Any Deactivates the node
Key String Key name
NonDevMode String Can be used in non-dev mode if set to true
Keyboard only Boolean Ignores non-keyword data if set to true

Outputs

Port Type Description
Pressed String Triggers when a key is pressed
Released String Triggers when a key is released

Log node

Used to log string input messages to the console.

Inputs

Port Type Description
input Any Activates the node
message String Message to be logged

Memory node

Used to display video memory data.

Inputs

Port Type Description
sysmem Integer Outputs system video memory data
videomem_thisframe Integer Outputs video memory used for current frame
videomem_recently Integer Outputs video memory recently used
meshmem Integer Outputs memory used for the mesh object