init(toAlignWith:maxDistance:maxAngle:)
Creates a goal whose effect is to make an agent align its orientation with that of other agents in a specified group.
Declaration
convenience init(toAlignWith agents: [GKAgent], maxDistance: Float, maxAngle: Float)Parameters
- agents:
The agents with whom to maintain alignment.
- maxDistance:
The maximum distance from other agents required for this goal to take effect.
- maxAngle:
The maximum angle, in radians, between an affected agent’s velocity and the direction toward the other agents required for this goal to take effect.
Return Value
A new goal object.
Discussion
The agents array can safely include the agent(s) affected by the goal—an agent pursuing this goal will ignore itself in the array. Therefore, you can use a single goal created with this method to cause an entire group of agents to mutually align with one another.
Changing the maxDistance parameter determines the minimum distance between agents in the group. Changing the maxAngle parameter determines how tightly an agent will turn to maintain alignment with the group.
You can combine separation, alignment, and cohesion goals to produce “flocking” behaviors in which a group of agents move together.