Struct KinematicBodyShape

Namespace

Trailblazer.Pathing

Assembly

Trailblazer.dll

Defines the authoritative deterministic body geometry used by navigation and movement.

public readonly struct KinematicBodyShape : IEquatable<KinematicBodyShape>

Implements

IEquatable<KinematicBodyShape>

Inherited Members

ValueType.ToString()

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

KinematicBodyShape(Fixed64, Fixed64, Fixed64)

Creates an immutable body shape.

public KinematicBodyShape(Fixed64 radius, Fixed64 height, Fixed64 rootToFootOffsetY)

Parameters

radius Fixed64

height Fixed64

rootToFootOffsetY Fixed64

Exceptions

ArgumentOutOfRangeException

Thrown when a dimension is outside its valid range.

Properties

Height

Gets the positive body height measured upward from the foot position.

public Fixed64 Height { get; }

Property Value

Fixed64

Radius

Gets the non-negative horizontal body radius.

public Fixed64 Radius { get; }

Property Value

Fixed64

RootToFootOffsetY

Gets the non-negative vertical offset from the host root to its foot position.

public Fixed64 RootToFootOffsetY { get; }

Property Value

Fixed64

Methods

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

Equals(KinematicBodyShape)

public bool Equals(KinematicBodyShape other)

Parameters

other KinematicBodyShape

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

Operators

operator ==(KinematicBodyShape, KinematicBodyShape)

Returns whether two shapes have exactly equal dimensions.

public static bool operator ==(KinematicBodyShape left, KinematicBodyShape right)

Parameters

left KinematicBodyShape

right KinematicBodyShape

Returns

bool

operator !=(KinematicBodyShape, KinematicBodyShape)

Returns whether two shapes have different dimensions.

public static bool operator !=(KinematicBodyShape left, KinematicBodyShape right)

Parameters

left KinematicBodyShape

right KinematicBodyShape

Returns

bool