User Guide (Version 1.21)

Boids Entity Flow Graph Nodes

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 more about legacy features, see the Amazon Lumberyard Legacy Reference.

entity:Boid Entity Type


Entity Name

Selected entity's name or label. Displays <Graph Entity> if the flow graph is an entity file.


Activates the entity.


Deactivates the entity.


Attracts the entity to a specific XYZ coordinate in the level.

Applies only to the birds and bald eagles entities.



Triggers output when the entity is activated.


Triggers output when the entity is deactivated.


Triggers output when the entity's distance is less than 5 meters from the attraction point (AttractTo input).

Applies only to the birds and bald eagles entities.

Lua Bindings for Boids

Individual boids have Lua-specific behavior. These scripts are available in dev\Gems\Boids\Assets\Scripts\Entities\Boids.

The following boids functions are bound from C++ to Lua:

  • CreateFlock

  • SetFlockParams

  • EnableFlock

  • SetFlockPercentEnabled

  • OnBoidHit

  • SetAttractionPoint

  • CanPickup

  • GetUsableMessage

  • OnPickup

Console Variable for Boids

The console variable boids_enable is defined in dev\Gems\Boids\Code\source\ScriptBind_Boids.cpp.

The count value for boids can be modified by the console variable e_ObjQuality.