User Guide (Version 1.21)

Boids Gem

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.

The Boids Gem provides entities that simulate animated animals that produce sound, exhibit group behavior, and avoid obstacles. Their complex behavior arises from the interaction of an individual agent boid with other boids and their environment.

A boids entity is a group of animals. You can control such aspects as the total number of boids, their mass, flocking behavior, speed, interaction with the player, and more. All boids entities exhibit by default a combination of basic motion, player avoidance, and flocking behavior.

The boids entity can also be affected by other entities; for example, a rain entity placed in the same scene with a turtles entity results in wet turtles.

To place Boids entities

  1. In the Rollup Bar, on the Objects tab, click Entity.

  2. Expand Boids.

  3. Drag one of the boids entities into your level in the Perspective viewport.