A* Pathfinding Project
4.0.8
The A* Pathfinding Project for Unity 3D
|
Exposes properties of an Agent class. More...
Exposes properties of an Agent class.
Public Member Functions | |
void | ForceSetVelocity (Vector2 velocity) |
Set the current velocity of the agent. | |
void | SetCollisionNormal (Vector2 normal) |
Set the normal of a wall (or something else) the agent is currently colliding with. | |
void | SetTarget (Vector2 targetPoint, float desiredSpeed, float maxSpeed) |
Point towards which the agent should move. | |
Properties | |
float | AgentTimeHorizon [get, set] |
Max number of estimated seconds to look into the future for collisions with agents. | |
float | CalculatedSpeed [get] |
Optimal speed of the agent to avoid collisions. | |
Vector2 | CalculatedTargetPoint [get] |
Optimal point to move towards to avoid collisions. | |
RVOLayer | CollidesWith [get, set] |
Layer mask specifying which layers this agent will avoid. | |
bool | DebugDraw [get, set] |
Draw debug information. | |
float | ElevationCoordinate [get, set] |
Coordinate which separates characters in the height direction. | |
float | Height [get, set] |
Height of the agent in world units. | |
RVOLayer | Layer [get, set] |
Specifies the avoidance layer for this agent. | |
bool | Locked [get, set] |
Locked agents will be assumed not to move. | |
int | MaxNeighbours [get, set] |
Max number of agents to take into account. | |
int | NeighbourCount [get] |
Number of neighbours that the agent took into account during the last simulation step. | |
List< ObstacleVertex > | NeighbourObstacles [get] |
List of obstacle segments which were close to the agent during the last simulation step. | |
float | ObstacleTimeHorizon [get, set] |
Max number of estimated seconds to look into the future for collisions with obstacles. | |
Vector2 | Position [get, set] |
Position of the agent. | |
System.Action | PreCalculationCallback [set] |
Callback which will be called right before avoidance calculations are started. | |
float | Priority [get, set] |
How strongly other agents will avoid this agent. | |
float | Radius [get, set] |
Radius of the agent in world units. | |
void ForceSetVelocity | ( | Vector2 | velocity | ) |
Set the current velocity of the agent.
This will override the local avoidance input completely. It is useful if you have a player controlled character and want other agents to avoid it.
Calling this method will mark the agent as being externally controlled for 1 simulation step. Local avoidance calculations will be skipped for the next simulation step but will be resumed after that unless this method is called again.
void SetCollisionNormal | ( | Vector2 | normal | ) |
Set the normal of a wall (or something else) the agent is currently colliding with.
This is used to make the RVO system aware of things like physics or an agent being clamped to the navmesh. The velocity of this agent that other agents observe will be modified so that there is no component into the wall. The agent will however not start to avoid the wall, for that you will need to add RVO obstacles.
This value will be cleared after the next simulation step, normally it should be set every frame when the collision is still happening.
void SetTarget | ( | Vector2 | targetPoint, |
float | desiredSpeed, | ||
float | maxSpeed | ||
) |
Point towards which the agent should move.
Usually you set this once per frame. The agent will try move as close to the target point as possible. Will take effect at the next simulation step.
targetPoint | Target point in world space (XZ plane or XY plane depending on if the simulation is configured for 2D or 3D). Note that this is a Vector2, not a Vector3 since the system simulates everything internally in 2D. So if your agents move in the XZ plane you will have to supply it as a Vector2 with (x,z) coordinates. |
desiredSpeed | Desired speed of the agent. In world units per second. The agent will try to move with this speed if possible. |
maxSpeed | Max speed of the agent. In world units per second. If necessary (for example if another agent is on a collision trajectory towards this agent) the agent can move at this speed. Should be at least as high as desiredSpeed, but it is recommended to use a slightly higher value than desiredSpeed (for example desiredSpeed*1.2). |
|
getset |
Max number of estimated seconds to look into the future for collisions with agents.
As it turns out, this variable is also very good for controling agent avoidance priorities. Agents with lower values will avoid other agents less and thus you can make 'high priority agents' by giving them a lower value.
|
get |
Optimal speed of the agent to avoid collisions.
The movement script should move towards CalculatedTargetPoint with this speed.
|
get |
Optimal point to move towards to avoid collisions.
The movement script should move towards this point with a speed of CalculatedSpeed.
|
getset |
Layer mask specifying which layers this agent will avoid.
You can set it as CollidesWith = RVOLayer.DefaultAgent | RVOLayer.Layer3 | RVOLayer.Layer6 ...
|
getset |
Draw debug information.
|
getset |
Coordinate which separates characters in the height direction.
Since RVO can be used either in 2D or 3D, it is not as simple as just using the y coordinate of the 3D position. In 3D this will most likely be set to the y coordinate, but in 2D (top down) it should in most cases be set to 0 since all characters are always in the same plane, however it may be set to some other value, for example if the game is 2D isometric.
The position is assumed to be at the base of the character (near the feet).
|
getset |
Height of the agent in world units.
Agents are modelled as circles/cylinders.
|
getset |
Specifies the avoidance layer for this agent.
The CollidesWith mask on other agents will determine if they will avoid this agent.
|
getset |
Locked agents will be assumed not to move.
|
getset |
Max number of agents to take into account.
Decreasing this value can lead to better performance, increasing it can lead to better quality of the simulation.
|
get |
Number of neighbours that the agent took into account during the last simulation step.
|
get |
List of obstacle segments which were close to the agent during the last simulation step.
Can be used to apply additional wall avoidance forces for example. Segments are formed by the obstacle vertex and its .next property.
|
getset |
Max number of estimated seconds to look into the future for collisions with obstacles.
|
getset |
Position of the agent.
The agent does not move by itself, a movement script has to be responsible for reading the CalculatedTargetPoint and CalculatedSpeed properties and move towards that point with that speed. This property should ideally be set every frame.
Note that this is a Vector2, not a Vector3 since the RVO simulates everything internally in 2D. So if your agents move in the XZ plane you may have to convert it to a Vector3 like this.
|
set |
Callback which will be called right before avoidance calculations are started.
Used to update the other properties with the most up to date values
|
getset |
How strongly other agents will avoid this agent.
Usually a value between 0 and 1. Agents with similar priorities will avoid each other with an equal strength an agent with a much lower priority than another agent will avoid the other agent in a way similar to if the other agent was a moving obstacle.
|
getset |
Radius of the agent in world units.
Agents are modelled as circles/cylinders.