Struct PIDMovement

float Accelerate (

float	speed	The current speed of the agent.
float	timeToReachMaxSpeed	The time it takes for the agent to reach the maximum speed, starting from a standstill.
float	dt	The time to accelerate for. Can be negative to decelerate instead.

)

Accelerates as quickly as possible.

This follows the same curve as the Speed function, as a function of the remaining distance.

float CurveFollowingStrength (

float	signedDistToClearArea
float	radiusToWall
float	remainingDistance

)

void ScaleByAgentScale (

float

agentScale

)

float Speed (

float

remainingDistance

)

bool ClipLineByHalfPlaneX (

ref float2	a
ref float2	b
float	x
float	side

)

void ClipLineByHalfPlaneYt (

float2	a
float2	b
float	y
float	side
ref float	mnT
ref float	mxT

)

AnglePIDControlOutput2D Control (

refPIDMovement	settings
float	dt
refControlParams	controlParams
ref CommandBuilder	draw
out float	maxDesiredWallDistance

)

void DrawChisel (

float2	start
float2	direction
float	pointiness
float	length
float	width
CommandBuilder	draw
Color	col

)

Bounds InterestingEdgeBounds (

refPIDMovement	settings
float3	position
float3	nextCorner
float	height
NativeMovementPlane	plane

)

Finds the bounding box in which this controller is interested in navmesh edges.

The edges should be assigned to ControlParams.edges. The bounding box is relative to the given movement plane.

float2 Linecast (

float2	a
float2	b
NativeArray<float2>	edges

)

float2 MaxAngle (

float2	a
float2	b
float2	c
bool	clockwise

)

Returns either the most clockwise, or most counter-clockwise direction of the three given directions.

The directions are compared pairwise, not using any global reference angle.

float2 MaxAngle (

float2	a
float2	b
bool	clockwise

)

Returns either the most clockwise, or most counter-clockwise direction of the two given directions.

The directions are compared pairwise, not using any global reference angle.

float2 OffsetCornerForApproach (

float2	position2D
float2	endOfPath2D
float2	facingDir2D
refPIDMovement	settings
float2	nextCorner2D
ref float	gammaAngle
ref float	gammaAngleWeight
DebugFlags	debugFlags
ref CommandBuilder	draw
NativeArray<float2>	edges

)

float2 OptimizeDirection (

float2	start	Current position of the agent.
float2	end	Point the agent is moving towards.
float	desiredRadius	The distance the agent should try to keep from obstacles.
float	remainingDistance	Remaining distance in the path.
float	pointiness	Essentially controls how much the agent will cut corners. A higher value will lead to a smoother path, but it will also lead to the agent not staying as far away from corners as the desired wall distance parameter would suggest. It is a unitless quantity.
NativeArray<float2>	edges	Edges of obstacles. Each edge is represented by two points.
CommandBuilder	draw	CommandBuilder to use for drawing debug information.
DebugFlags	debugFlags	Flags to control what debug information to draw.

)

Finds a direction to move in that is as close as possible to the desired direction while being clear of obstacles, if possible.

This keeps the agent from moving too close to walls.

float SmallestDistanceWithinWedge (

float2	point	The origin point of the wedge (the pointy end).
float2	dir1	The first direction of the wedge.
float2	dir2	The second direction of the wedge.
float	shrinkAmount	The wedge is shrunk by this amount. In the same units as the input points.
NativeArray<float2>	edges	The edges to check for intersection with.

)

Calculates the closest point on any point of an edge that is inside a wedge.

void SplitSegment (

float2	e1
float2	e2
float	desiredRadius
float	length
float	pointiness
refEdgeBuffers	buffers

)

void SplitSegment2 (

float2	e1
float2	e2
float	desiredRadius
float	pointiness
refEdgeBuffers	buffers

)

void SplitSegment3 (

float2	e1
float2	e2
float	desiredRadius
bool	inTriangularRegion
refEdgeBuffers	buffers

)

void SplitSegment4 (

float2	e1
float2	e2
bool	inTriangularRegion
bool	left
refEdgeBuffers	buffers

)

bool? allowRotatingOnSpot

If rotation on the spot is allowed or not.

When the agent wants to turn significantly, enabling this will make it turn on the spot instead of moving in an arc. This can make for more responsive and natural movement for humanoid characters.

byte allowRotatingOnSpotBacking

If rotation on the spot is allowed or not.

1 for allowed, 0 for not allowed.

That we have to use a byte instead of a boolean is due to a Burst limitation.

float desiredWallDistance

How big of a distance to try to keep from obstacles.

Typically around 1 or 2 times the agent radius is a good value for this.

Try to avoid making it so large that there might not be enough space for the agent to keep this amount of distance from obstacles. It may start to move less optimally if it is not possible to keep this distance.

This works well in open spaces, but if your game consists of a lot of tight corridors, a low, or zero value may be better.

This will be multiplied by the agent's scale to get the actual distance.

float leadInRadiusWhenApproachingDestination

How wide of a turn to make when approaching a destination for which a desired facing direction has been set.

The following video shows three agents, one with no facing direction set, and then two agents with varying values of the lead in radius.

Setting this to zero will make the agent move directly to the end of the path and rotate on the spot to face the desired facing direction, once it is there.

When approaching a destination for which no desired facing direction has been set, this field has no effect.

This will be multiplied by the agent's scale to get the actual radius.

float maxOnSpotRotationSpeed

Maximum rotation speed in degrees per second while rotating on the spot.

Only used if allowRotatingOnSpot is enabled.

float maxRotationSpeed

Maximum rotation speed in degrees per second.

If the agent would have to rotate faster than this, it will instead slow down to get more time to rotate.

The agent may want to rotate faster than rotationSpeed if there's not enough space, so that it has to move in a more narrow arc. It may also want to rotate faster if it is very close to its destination and it wants to make sure it ends up on the right spot without any circling.

It is recommended to keep this at a value slightly larger than rotationSpeed.

float rotationSpeed

Desired rotation speed in degrees per second.

If the agent is in an open area and gets a new destination directly behind itself, it will start to rotate around with exactly this rotation speed.

The agent will slow down its rotation speed as it approaches its desired facing direction. So for example, when it is only 90 degrees away from its desired facing direction, it will only rotate with about half this speed.

float slowdownTime

Time for the agent to slow down to a complete stop when it approaches the destination point, in seconds.

One can calculate the deceleration like: speed/slowdownTime (with units m/s^2).

float slowdownTimeWhenTurningOnSpot

Time for the agent to slow down to a complete stop when rotating on the spot.

If set to zero, the agent will instantly stop and start to turn around.

Only used if allowRotatingOnSpot is enabled.

float speed

Desired speed of the agent in meters per second.

This will be multiplied by the agent's scale to get the actual speed.

const float ALLOWED_OVERLAP_FACTOR = 0.1f

const float DESTINATION_CLEARANCE_FACTOR = 4f

const float MAX_FRACTION_OF_REMAINING_DISTANCE = 0.9f

const int OPTIMIZATION_ITERATIONS = 8

const float STEP_MULTIPLIER = 1.0f

DebugFlags

ProfilerMarker MarkerConvertObstacles = new ProfilerMarker("ConvertObstacles")

ProfilerMarker MarkerOptimizeDirection = new ProfilerMarker("OptimizeDirection")

ProfilerMarker MarkerPID = new ProfilerMarker("PID")

ProfilerMarker MarkerSidewaysAvoidance = new ProfilerMarker("SidewaysAvoidance")

ProfilerMarker MarkerSmallestDistance = new ProfilerMarker("ClosestDistance")