Class GraphCollision

bool collisionCheck = true

Toggle collision check.

float collisionOffset

Height above the ground that collision checks should be done.

For example, if the ground was found at y=0, collisionOffset = 2 type = Capsule and height = 3 then the physics system will be queried to see if there are any colliders in a capsule for which the bottom sphere that is made up of is centered at y=2 and the top sphere has its center at y=2+3=5.

If type = Sphere then the sphere's center would be at y=2 in this case.

float diameter = 1F

Diameter of capsule or sphere when checking for collision.

When checking for collisions the system will check if any colliders overlap a specific shape at the node's position. The shape is determined by the type field.

A diameter of 1 means that the shape has a diameter equal to the node's width, or in other words it is equal to nodeSize .

If type is set to Ray, this does not affect anything.

float fromHeight = 100

The height to check from when checking height ('ray length' in the inspector).

As the image below visualizes, different ray lengths can make the ray hit different things. The distance is measured up from the graph plane.

float height = 2F

Height of capsule or length of ray when checking for collision.

If type is set to Sphere, this does not affect anything.

bool heightCheck = true

Toggle height check.

If false, the grid will be flat.

This setting will be ignored when 2D physics is used.

LayerMask heightMask = -1

Layers to be included in the height check.

LayerMask mask

Layers to be treated as obstacles.

bool thickRaycast

Toggles thick raycast.

float thickRaycastDiameter = 1

Diameter of the thick raycast in nodes.

1 equals nodeSize

ColliderType type = ColliderType.Capsule

Collision shape to use.

bool unwalkableWhenNoGround = true

Make nodes unwalkable when no ground was found with the height raycast.

If height raycast is turned off, this doesn't affect anything.

Vector3 up

Direction to use as UP.

bool use2D

Use Unity 2D Physics API.

If enabled, the 2D Physics API will be used, and if disabled, the 3D Physics API will be used.

This changes the collider types (see type) from 3D versions to their corresponding 2D versions. For example the sphere shape becomes a circle.

The heightCheck setting will be ignored when 2D physics is used.

const float RaycastErrorMargin = 0.005F

Offset to apply after each raycast to make sure we don't hit the same point again in CheckHeightAll.

ContactFilter2D contactFilter

Used for 2D collision queries.

Collider2D[] dummyArray = new Collider2D[1]

Just so that the Physics2D.OverlapPoint method has some buffer to store things in.

We never actually read from this array, so we don't even care if this is thread safe.

float finalRadius

diameter * scale * 0.5.

Where scale usually is nodeSize

float finalRaycastRadius

thickRaycastDiameter * scale * 0.5.

Where scale usually is nodeSize

RaycastHit[] hitBuffer = new RaycastHit[8]

Internal buffer used by CheckHeightAll.

Vector3 upheight

up * height.

RayDirection rayDirection = RayDirection.Both

Direction of the ray when checking for collision.

If type is not Ray, this does not affect anything