API reference

StepLocomotionBroadcaster Class

Extends MonoBehaviour
Produces a Relative Translation Locomotion event in the XZ direction relative to an aiming transform.
This aiming transform will typically represent the head or the hand of the player.

Protected Fields

_started : bool
Signature
bool _started

Properties

Identifier : int
[Get]
Signature
int Identifier
Origin : Transform
[Get][Set]
Signature
Transform Origin
StepLength : float
[Get][Set]
Signature
float StepLength

Events

WhenLocomotionPerformed : Action< LocomotionEvent >
Signature
Action<LocomotionEvent> WhenLocomotionPerformed

Protected Methods

Start ()
Signature
virtual void Start()
Returns
void

Methods

Step ( relativeDirection )
Generates a relative translation locomotion event in the specified direction relative to the aiming transform.
Signature
void Step(Vector2Int relativeDirection)
Parameters
relativeDirection: Vector2Int  The XZ direction, relative to the aiming transform, for the step
Returns
void
StepBackward ()
Broadcasts a relative translation locomotion event to the back of the aiming transform.
Signature
void StepBackward()
Returns
void
StepForward ()
Broadcasts a relative translation locomotion event to the front of the aiming transform.
Signature
void StepForward()
Returns
void
StepLeft ()
Broadcasts a relative translation locomotion event to the left of the aiming transform.
Signature
void StepLeft()
Returns
void
StepRight ()
Broadcasts a relative translation locomotion event to the right of the aiming transform.
Signature
void StepRight()
Returns
void