Class NavigationLink

The NavigationLink class is used to link areas on a navigation mesh together that are not directly connected. This can be used to implement ledges where agents can jump off, or jump to.

Index

Constructors

constructor

new NavigationLink(
    startPosition?: Immutable<Vector3>,
    endPosition?: Immutable<Vector3>,
    isBidirectional?: boolean,
    areaType?: EnumValue<NavigationAreaType>,
): NavigationLink
Parameters
- OptionalstartPosition: Immutable<Vector3>
- OptionalendPosition: Immutable<Vector3>
- OptionalisBidirectional: boolean
- OptionalareaType: EnumValue<NavigationAreaType>
Returns NavigationLink

Properties

`Protected`_areaType

_areaType: EnumValue<NavigationAreaType>

`Protected`_endPosition

_endPosition: Vector3

`Protected`_isBidirectional

_isBidirectional: boolean

`Protected`_startPosition

_startPosition: Vector3

Accessors

areaType

get areaType(): EnumValue<NavigationAreaType>

The area type.

Returns EnumValue<NavigationAreaType>
set areaType(value: EnumValue<NavigationAreaType>): void
Parameters
- value: EnumValue<NavigationAreaType>
Returns void

endPosition

get endPosition(): Vector3

The end position.

Returns Vector3
set endPosition(value: Immutable<Vector3>): void
Parameters
- value: Immutable<Vector3>
Returns void

isBidirectional

get isBidirectional(): boolean

Determines whether the link can be traversed in both directions.

Returns boolean
set isBidirectional(value: boolean): void
Parameters
- value: boolean
Returns void

startPosition

get startPosition(): Vector3

The start position.

Returns Vector3
set startPosition(value: Immutable<Vector3>): void
Parameters
- value: Immutable<Vector3>
Returns void

Methods

assign

assign(other: Immutable<NavigationLink>): NavigationLink
Copies all properties defined by the prototype of NavigationLink from other to this instance.
Parameters
- other: Immutable<NavigationLink>
Returns NavigationLink

clone

clone(): NavigationLink

Clones this instance and returns a new NavigationLink with identical values.

Returns NavigationLink

isEqual

isEqual(
this: Immutable<NavigationLink>,
other: Immutable<NavigationLink>,
): boolean
Determines if this NavigationLink instance is equal to the other instance.
Parameters
- this: Immutable<NavigationLink>
- other: Immutable<NavigationLink>
Returns boolean

`Static`isEqual

isEqual(lhs: Immutable<NavigationLink>, rhs: Immutable<NavigationLink>): boolean
Determines if both NavigationLink instances are equal.
Parameters
- lhs: Immutable<NavigationLink>
- rhs: Immutable<NavigationLink>
Returns boolean

Class NavigationLink

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns NavigationLink

Properties

Protected_areaType

Protected_endPosition

Protected_isBidirectional

Protected_startPosition

Accessors

areaType

Returns EnumValue<NavigationAreaType>

Parameters

Returns void

endPosition

Returns Vector3

Parameters

Returns void

isBidirectional

Returns boolean

Parameters

Returns void

startPosition

Returns Vector3

Parameters

Returns void

Methods

assign

Parameters

Returns NavigationLink

clone

Returns NavigationLink

isEqual

Parameters

Returns boolean

StaticisEqual

Parameters

Returns boolean

Settings

On This Page

`Protected`_areaType

`Protected`_endPosition

`Protected`_isBidirectional

`Protected`_startPosition

`Static`isEqual