LocomotionActionsBroadcaster generates LocomotionEvents without a Translation or Rotation but decorates them with extra information regarding instantaneous locomotion actions that can be consumed by a Locomotor.

Decorations are only active during the WhenLocomotionPerformed event and should be consumed and managed by the specific implementations

Member Enumerations

Enumeration LocomotionAction

Crouch	No description available
StandUp	No description available
ToggleCrouch	No description available
Run	No description available
Walk	No description available
ToggleRun	No description available
Jump	No description available
InvalidTarget	No description available
Select	No description available

Fields

int Identifier[Get]

Events

Action< LocomotionEvent > WhenLocomotionPerformed

Protected Functions

virtual void Awake ( )

Member Functions

void SendLocomotionAction

( LocomotionAction action )

Sends an Action down the LocomotionEvent pipeline and inmediately disposes it

Parameters

action

The action to be sent

void SendLocomotionAction

( LocomotionAction action,

Pose target )

Sends an Action down the LocomotionEvent pipeline and inmediately disposes it

Parameters

action

The action to be sent

target

The pose to associate with the action

void Crouch ( )

Sends an immediate Crouch Action down the LocomotionEvent pipeline

void StandUp ( )

Sends an immediate StandUp Action down the LocomotionEvent pipeline

void ToggleCrouch ( )

Sends an immediate ToggleCrouch Action down the LocomotionEvent pipeline

void Run ( )

Sends an immediate Run Action down the LocomotionEvent pipeline

void Walk ( )

Sends an immediate Walk Action down the LocomotionEvent pipeline

void ToggleRun ( )

Sends an immediate ToggleRun Action down the LocomotionEvent pipeline

void Jump ( )

Sends an immediate default Jump Action down the LocomotionEvent pipeline

void Jump

( Vector3 force )

Sends an immediate Jump Action down the LocomotionEvent pipeline

Parameters

force

The force to be applied to the jump

void Invalid

( Pose pose )

Marks the locomotionEvent as an invalid target

void Select ( )

Marks the LocomotionEvent as a Select event

void InjectOptionalContext

( Context context )

Static Member Functions

static LocomotionEvent CreateLocomotionEventAction

( int identifier,

LocomotionAction action,

Pose pose,

Context context )

This utility method allows creating LocomotionAction decorations

Parameters

identifier

The identifier of the sender

action

The action to send

pose

The pose to be sent in the LocomotionEvent, note that this won't have any Translation or Rotation applied

context

The context used for storing the decoration

Returns

The LocomotionEvent decorated with the action

static bool TryGetLocomotionActions

( LocomotionEvent locomotionEvent,

out LocomotionAction action,

Context context )

This utility methods allows retrieving the LocomotionAction from a given LocomotionEvent, if it contains one.

Parameters

locomotionEvent

The LocomotionEvent potentially containing the LocomotionAction

action

The LocomotionAction that it contained

context

The context used for storing the decoration

Returns

True if the LocomotionEvent contained a valid LocomotionAction

static void DisposeLocomotionAction

( LocomotionEvent locomotionEvent,

Context context )

This utility method removes the LocomotionAction decoration from the LocomotionEvent.

These decorations are not automatically removed, so it is important to manually call this method to avoid filling the memory with obsolete decorations

Parameters

locomotionEvent

The event containing the LocomotionAction decoration.

context

The context storing the decoration

Did you find this page helpful?