Class ScreenFadeEffector

Inheritance
object
AFunction
AEffector
AUnityEffector
ScreenFadeEffector
Inherited Members
Namespace: Xareus.Scenarios.Unity
Assembly: Xareus.Unity.Libraries.dll
Syntax
[Renamed("SEVEN.Unity.ScreenFadeEffector", "Assembly-CSharp")]
[Renamed("Xareus.Scenarios.Unity.ScreenFadeEffector", "Xareus.Unity.Librairies")]
public class ScreenFadeEffector : AUnityEffector

Constructors

ScreenFadeEffector(Event, Dictionary<string, Parameter>, ContextHolder)

Declaration
public ScreenFadeEffector(Event @event, Dictionary<string, Parameter> parameters, ContextHolder contexts)
Parameters
Type Name Description
Event event
Dictionary<string, Parameter> parameters
ContextHolder contexts

Fields

CAMERAS

Declaration
public const string CAMERAS = "Cameras"
Field Value
Type Description
string

COLOR

Declaration
public const string COLOR = "Color"
Field Value
Type Description
string

DURATION

Declaration
public const string DURATION = "Duration"
Field Value
Type Description
string

END_ALPHA

Declaration
public const string END_ALPHA = "End Alpha"
Field Value
Type Description
string

FADE_TYPE

Declaration
public const string FADE_TYPE = "Fade Type"
Field Value
Type Description
string

FROM_CURRENT_COLOR

Declaration
public const string FROM_CURRENT_COLOR = "Fade From Current Color"
Field Value
Type Description
string

START_ALPHA

Declaration
public const string START_ALPHA = "Start Alpha"
Field Value
Type Description
string

WAIT_FOR_END

Declaration
public const string WAIT_FOR_END = "Wait For End"
Field Value
Type Description
string

camerasToFade

Declaration
[ConfigurationParameter("Cameras", "All if not/none specified", Necessity.Required)]
protected List<Camera> camerasToFade
Field Value
Type Description
List<Camera>

endAlpha

Declaration
[ConfigurationParameter("End Alpha", 1, "Ending alpha value for the fade in", Necessity.Required)]
protected float endAlpha
Field Value
Type Description
float

fadeColor

Declaration
[ConfigurationParameter("Color", "The solid color the fade effect will use. Default is black", Necessity.Required)]
[ProvideConstraint(ColorUtils.UseAlpha.No)]
protected Color fadeColor
Field Value
Type Description
Color

fadeDuration

Declaration
[ConfigurationParameter("Duration", 1, "Fade duration in seconds", Necessity.Required)]
protected float fadeDuration
Field Value
Type Description
float

fadeFromCurrentColor

Declaration
[ConfigurationParameter("Fade From Current Color", false, "Fade from the current fade color to the one specified in the effector.", Necessity.Required)]
protected bool fadeFromCurrentColor
Field Value
Type Description
bool

fadeType

Declaration
[ConfigurationParameter("Fade Type", "Fade in to color or Fade out from color", Necessity.Required)]
protected ScreenFadeEffector.FadeType fadeType
Field Value
Type Description
ScreenFadeEffector.FadeType

finished

Declaration
protected bool finished
Field Value
Type Description
bool

startAlpha

Declaration
[ConfigurationParameter("Start Alpha", 0, "Starting alpha value for the fade in", Necessity.Required)]
protected float startAlpha
Field Value
Type Description
float

waitForEnd

Declaration
[ConfigurationParameter("Wait For End", "Wait for the fading to finish once before passing the transition", Necessity.Required)]
protected bool waitForEnd
Field Value
Type Description
bool

Properties

Finished

Override to have a non-punctual effector

Declaration
public override bool Finished { get; }
Property Value
Type Description
bool
Overrides

Methods

SafeEffectorUpdate()

Actual effector code. Note that this code will be executed in unity's thread

Declaration
public override void SafeEffectorUpdate()
Overrides