Class LocomotionBlendInfo

Defines a blend where multiple clips are blended to compose a character locomotion.

Index

Constructors

constructor

new LocomotionBlendInfo(
    forwardClip?: ResourceHandle<AnimationClip>,
    backwardClip?: ResourceHandle<AnimationClip>,
    leftClip?: ResourceHandle<AnimationClip>,
    rightClip?: ResourceHandle<AnimationClip>,
    idleClip?: ResourceHandle<AnimationClip>,
    compensateBackwardsMotion?: boolean,
): LocomotionBlendInfo
Parameters
- OptionalforwardClip: ResourceHandle<AnimationClip>
- OptionalbackwardClip: ResourceHandle<AnimationClip>
- OptionalleftClip: ResourceHandle<AnimationClip>
- OptionalrightClip: ResourceHandle<AnimationClip>
- OptionalidleClip: ResourceHandle<AnimationClip>
- OptionalcompensateBackwardsMotion: boolean
Returns LocomotionBlendInfo

Properties

`Protected`_backwardClip

_backwardClip: ResourceHandle<AnimationClip>

`Protected`_compensateBackwardsMotion

_compensateBackwardsMotion: boolean

`Protected`_forwardClip

_forwardClip: ResourceHandle<AnimationClip>

`Protected`_idleClip

_idleClip: ResourceHandle<AnimationClip>

`Protected`_leftClip

_leftClip: ResourceHandle<AnimationClip>

`Protected`_rightClip

_rightClip: ResourceHandle<AnimationClip>

Accessors

backwardClip

get backwardClip(): ResourceHandle<AnimationClip>

The backward motion clip.

Returns ResourceHandle<AnimationClip>
set backwardClip(value: ResourceHandle<AnimationClip>): void
Parameters
- value: ResourceHandle<AnimationClip>
Returns void

compensateBackwardsMotion

get compensateBackwardsMotion(): boolean

Compensate backwards motion by invertion left/right clips when walking backwards and adjusting weights dynamically. This is only used if BackwardLeftClip and BackwardRightClip are not available.

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

forwardClip

get forwardClip(): ResourceHandle<AnimationClip>

The forward motion clip.

Returns ResourceHandle<AnimationClip>
set forwardClip(value: ResourceHandle<AnimationClip>): void
Parameters
- value: ResourceHandle<AnimationClip>
Returns void

idleClip

get idleClip(): ResourceHandle<AnimationClip>

The idle clip.

Returns ResourceHandle<AnimationClip>
set idleClip(value: ResourceHandle<AnimationClip>): void
Parameters
- value: ResourceHandle<AnimationClip>
Returns void

leftClip

get leftClip(): ResourceHandle<AnimationClip>

The left motion clip.

Returns ResourceHandle<AnimationClip>
set leftClip(value: ResourceHandle<AnimationClip>): void
Parameters
- value: ResourceHandle<AnimationClip>
Returns void

rightClip

get rightClip(): ResourceHandle<AnimationClip>

The right motion clip.

Returns ResourceHandle<AnimationClip>
set rightClip(value: ResourceHandle<AnimationClip>): void
Parameters
- value: ResourceHandle<AnimationClip>
Returns void

Methods

assign

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

clone

clone(): LocomotionBlendInfo

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

Returns LocomotionBlendInfo

isEqual

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

`Static`isEqual

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

Class LocomotionBlendInfo

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns LocomotionBlendInfo

Properties

Protected_backwardClip

Protected_compensateBackwardsMotion

Protected_forwardClip

Protected_idleClip

Protected_leftClip

Protected_rightClip

Accessors

backwardClip

Returns ResourceHandle<AnimationClip>

Parameters

Returns void

compensateBackwardsMotion

Returns boolean

Parameters

Returns void

forwardClip

Returns ResourceHandle<AnimationClip>

Parameters

Returns void

idleClip

Returns ResourceHandle<AnimationClip>

Parameters

Returns void

leftClip

Returns ResourceHandle<AnimationClip>

Parameters

Returns void

rightClip

Returns ResourceHandle<AnimationClip>

Parameters

Returns void

Methods

assign

Parameters

Returns LocomotionBlendInfo

clone

Returns LocomotionBlendInfo

isEqual

Parameters

Returns boolean

StaticisEqual

Parameters

Returns boolean

Settings

On This Page

`Protected`_backwardClip

`Protected`_compensateBackwardsMotion

`Protected`_forwardClip

`Protected`_idleClip

`Protected`_leftClip

`Protected`_rightClip

`Static`isEqual