Lumberyard
Legacy Reference

Iterator 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 iterator-related settings.

GetEntities node

Used to find and return all entities in the world.

Inputs

Port Type Description
Activate Any Triggers the node
Next Any Gets the next entity found
Limit Integer Limits how many entities are returned
Immediate Boolean Iterates immediately through the results
Type Integer Type of entity to iterate
ArchetypeFilter Any Returns archetype entities

Outputs

Port Type Description
OutEntityId Any Outputs the entity and entity ID
Count Integer Outputs the current of entities
Done Integer Triggered when all entities have been found, with the total count returned

GetEntitiesInArea node

Used to find and return all entities within the specified area shape.

Inputs

Port Type Description
Activate Any Triggers the node
Next Any Gets the next entity found
Limit Integer Limits how many entities are returned
Immediate Boolean Iterates immediately through the results
Type Integer Type of entity to iterate
ArchetypeFilter String Returns archetype entities
Area String Name of area shape to test against

Outputs

Port Type Description
OutEntityId Any Outputs the entity and entity ID
Count Integer Outputs the current of entities
Done Integer Triggered when all entities have been found, with the total count returned

GetEntitiesInBox node

Used to find and return all entities within the defined AABB box.

Inputs

Port Type Description
Activate Any Triggers the node
Next Any Gets the next entity found
Limit Integer Limits how many entities are returned
Immediate Any Iterates immediately through the results
Type Integer Type of entity to iterate
ArchetypeFilter String Returns archetype entities
Min Vec3 Minimum vector extents of the AABB bounding box to check for entities
Max Vec3 Maximum vector extents of the AABB bounding box to check for entities

Outputs

Port Type Description
OutEntityId Any Outputs the entity and entity ID
Count Integer Outputs the current of entities
Done Integer Triggered when all entities have been found, with the total count returned

GetEntitiesInSphere node

Used to find and return all entities within the defined sphere volume.

Inputs

Port Type Description
Activate Any Triggers the node
Next Any Gets the next entity found
Limit Integer Limits how many entities are returned
Immediate Boolean Iterates immediately through the results
Type Integer Type of entity to iterate
ArchetypeFilter String Returns archetype entities
Center Vec3 Center of the sphere
Radius Float Distance from the center of the sphere to check for entities

Outputs

Port Type Description
OutEntityId Any Outputs the entity and entity ID
Count Integer Outputs the current of entities
Done Integer Triggered when all entities have been found, with the total count returned