TeleportTransition Class Referenceabstract

Teleport transitions manage the actual relocation of the player from the current position and orientation to the teleport destination. All teleport transition behaviors derive from this class, primarily for type safety within the LocomotionTeleport to track the current transition type. More...

Inheritance diagram for TeleportTransition:
TeleportSupport TeleportTransitionBlink TeleportTransitionInstant TeleportTransitionWarp

Protected Member Functions

override void AddEventHandlers ()
 Derived classes that need to use event handlers need to override this method and call the base class to ensure all event handlers are added as intended. More...
 
override void RemoveEventHandlers ()
 Derived classes that need to use event handlers need to override this method and call the base class to ensure all event handlers are removed as intended. More...
 
abstract void LocomotionTeleportOnEnterStateTeleporting ()
 When the teleport state is entered, simply move the player to the new location without any delay or other side effects. If the transition is not immediate, the transition handler will need to set the LocomotionTeleport.IsTeleporting to true for the duration of the transition, setting it to false when the transition is finished which will then allow the teleport state machine to switch to the PostTeleport state. More...
 
- Protected Member Functions inherited from TeleportSupport
virtual void OnEnable ()
 OnEnable is virtual so that derived classes can set up references to objects before AddEventHandlers is called, as is required by TeleportSupport derivations. More...
 
virtual void OnDisable ()
 

Additional Inherited Members

- Properties inherited from TeleportSupport
LocomotionTeleport LocomotionTeleport [get]
 

Detailed Description

Teleport transitions manage the actual relocation of the player from the current position and orientation to the teleport destination. All teleport transition behaviors derive from this class, primarily for type safety within the LocomotionTeleport to track the current transition type.

Member Function Documentation

◆ AddEventHandlers()

override void TeleportTransition.AddEventHandlers ( )
protectedvirtual

Derived classes that need to use event handlers need to override this method and call the base class to ensure all event handlers are added as intended.

Reimplemented from TeleportSupport.

◆ LocomotionTeleportOnEnterStateTeleporting()

abstract void TeleportTransition.LocomotionTeleportOnEnterStateTeleporting ( )
protectedpure virtual

When the teleport state is entered, simply move the player to the new location without any delay or other side effects. If the transition is not immediate, the transition handler will need to set the LocomotionTeleport.IsTeleporting to true for the duration of the transition, setting it to false when the transition is finished which will then allow the teleport state machine to switch to the PostTeleport state.

Implemented in TeleportTransitionBlink, TeleportTransitionWarp, and TeleportTransitionInstant.

◆ RemoveEventHandlers()

override void TeleportTransition.RemoveEventHandlers ( )
protectedvirtual

Derived classes that need to use event handlers need to override this method and call the base class to ensure all event handlers are removed as intended.

Reimplemented from TeleportSupport.


The documentation for this class was generated from the following file: