TeleportTransitionWarp Class Reference

This transition will move the player to the destination over the span of a fixed amount of time. It will not adjust the orientation of the player because this is very uncomfortable. Note there is custom editor for this behavior which is used to control the warp interpolation. More...

Inheritance diagram for TeleportTransitionWarp:
TeleportTransition TeleportSupport

Public Attributes

float TransitionDuration = 0.5f
 How much time the warp transition takes to complete. More...
 
AnimationCurve PositionLerp = AnimationCurve.Linear(0, 0, 1, 1)
 Curve to control the position lerp between the current location and the destination. There is a custom editor for this field to avoid a problem where inspector curves don't update as expected. The custom inspector code is here: ..cs More...
 

Protected Member Functions

override void LocomotionTeleportOnEnterStateTeleporting ()
 When the teleport state is entered, quickly move the player to the new location over the duration of the teleport. More...
 
- Protected Member Functions inherited from TeleportTransition
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...
 
- 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

This transition will move the player to the destination over the span of a fixed amount of time. It will not adjust the orientation of the player because this is very uncomfortable. Note there is custom editor for this behavior which is used to control the warp interpolation.

Member Function Documentation

◆ LocomotionTeleportOnEnterStateTeleporting()

override void TeleportTransitionWarp.LocomotionTeleportOnEnterStateTeleporting ( )
protectedvirtual

When the teleport state is entered, quickly move the player to the new location over the duration of the teleport.

Implements TeleportTransition.

Member Data Documentation

◆ PositionLerp

AnimationCurve TeleportTransitionWarp.PositionLerp = AnimationCurve.Linear(0, 0, 1, 1)

Curve to control the position lerp between the current location and the destination. There is a custom editor for this field to avoid a problem where inspector curves don't update as expected. The custom inspector code is here: ..cs

◆ TransitionDuration

float TeleportTransitionWarp.TransitionDuration = 0.5f

How much time the warp transition takes to complete.


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