TeleportTransitionBlink Class Reference

This transition will cause the screen to quickly fade to black, perform the repositioning, and then fade the view back to normal. More...

Inheritance diagram for TeleportTransitionBlink:
TeleportTransition TeleportSupport

Public Attributes

float TransitionDuration = 0.5f
 How long the transition takes. Usually this is greater than Teleport Delay. More...
 
float TeleportDelay = 0.5f
 At what percentage of the elapsed transition time does the teleport occur? More...
 
AnimationCurve FadeLevels = new AnimationCurve(new Keyframe[3] { new Keyframe(0,0), new Keyframe(0.5f, 1.0f), new Keyframe(1.0f, 0.0f) })
 Fade to black over the duration of the transition. More...
 

Protected Member Functions

override void LocomotionTeleportOnEnterStateTeleporting ()
 When the teleport state is entered, start a coroutine that will handle the actual transition effect. More...
 
IEnumerator BlinkCoroutine ()
 This coroutine will fade out the view, perform the teleport, and then fade the view back in. 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 cause the screen to quickly fade to black, perform the repositioning, and then fade the view back to normal.

Member Function Documentation

◆ BlinkCoroutine()

IEnumerator TeleportTransitionBlink.BlinkCoroutine ( )
protected

This coroutine will fade out the view, perform the teleport, and then fade the view back in.

Returns

◆ LocomotionTeleportOnEnterStateTeleporting()

override void TeleportTransitionBlink.LocomotionTeleportOnEnterStateTeleporting ( )
protectedvirtual

When the teleport state is entered, start a coroutine that will handle the actual transition effect.

Implements TeleportTransition.

Member Data Documentation

◆ FadeLevels

AnimationCurve TeleportTransitionBlink.FadeLevels = new AnimationCurve(new Keyframe[3] { new Keyframe(0,0), new Keyframe(0.5f, 1.0f), new Keyframe(1.0f, 0.0f) })

Fade to black over the duration of the transition.

◆ TeleportDelay

float TeleportTransitionBlink.TeleportDelay = 0.5f

At what percentage of the elapsed transition time does the teleport occur?

◆ TransitionDuration

float TeleportTransitionBlink.TransitionDuration = 0.5f

How long the transition takes. Usually this is greater than Teleport Delay.


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