Click or drag to resize

SceneDirector Class

Fade in/out screens or load scenes with it. Provides hooks.
Inheritance Hierarchy
SystemObject
  KitSceneDirector

Namespace:  Kit
Assembly:  Assembly-CSharp (in Assembly-CSharp.dll) Version: 0.0
Syntax
C#
public static class SceneDirector
Request Example View Source

The SceneDirector type exposes the following members.

Properties
  NameDescription
Public propertyStatic memberActiveName
Name of the active scene.
Public propertyStatic memberActiveScene
Reference to the active scene.
Top
Methods
  NameDescription
Public methodStatic memberFade

Fade the screen.

Can be await-ed upon.

Public methodStatic memberFadeIn

Fade in the screen.

Can be await-ed upon.

Public methodStatic memberFadeOut

Fade out the screen.

Can be await-ed upon.

Public methodStatic memberIsScene
Returns whether the active scene is a particular one.
Public methodStatic memberLoadScene

Load a scene.

Can be await-ed upon.

Public methodStatic memberReloadScene

Reload the active scene.

Can be await-ed upon.

Top
Events
  NameDescription
Public eventStatic memberFaded
Event that gets called when the scene has faded (in or out).
Public eventStatic memberFadedIn
Event that gets called when the scene has faded in.
Public eventStatic memberFadedOut
Event that gets called when the scene has faded out.
Public eventStatic memberFading
Event that gets called when the scene is fading (in or out).
Public eventStatic memberFadingIn
Event that gets called when the scene starts fading in.
Public eventStatic memberFadingOut
Event that gets called when the scene starts fading out.
Public eventStatic memberSceneChanged
Event that gets called when the scene has changed.
Public eventStatic memberSceneChanging
Event that gets called when the scene starts changing.
Top
Fields
  NameDescription
Public fieldStatic memberDefaultFadeColor
Default fade color to use in calls.
Public fieldStatic memberDefaultFadeMode
Default fade mode to use in calls.
Public fieldStatic memberDefaultFadeTime
Default fade time to use in calls.
Public fieldStatic memberFadeCanvasOrder
The sort order of the Canvas that's used for fading.
Top
See Also

Reference