TopDown Engine  v4.1
MoreMountains.Tools.MMFadeEvent Struct Reference

Events used to trigger faders on or off More...

Public Member Functions

 MMFadeEvent (float duration, float targetAlpha, MMTweenType tween, int id=0, bool ignoreTimeScale=true, Vector3 worldPosition=new Vector3())
 Initializes a new instance of the MoreMountains.MMInterface.MMFadeEvent struct. More...
 

Static Public Member Functions

static void Trigger (float duration, float targetAlpha)
 
static void Trigger (float duration, float targetAlpha, MMTweenType tween, int id=0, bool ignoreTimeScale=true, Vector3 worldPosition=new Vector3())
 

Public Attributes

int ID
 an ID that has to match the one on the fader More...
 
float Duration
 the duration of the fade, in seconds More...
 
float TargetAlpha
 the alpha to aim for More...
 
MMTweenType Curve
 the curve to apply to the fade More...
 
bool IgnoreTimeScale
 whether or not this fade should ignore timescale More...
 
Vector3 WorldPosition
 a world position for a target object. Useless for regular fades, but can be useful for alt implementations (circle fade for example) More...
 

Static Public Attributes

static MMFadeEvent e
 

Detailed Description

Events used to trigger faders on or off

Constructor & Destructor Documentation

◆ MMFadeEvent()

MoreMountains.Tools.MMFadeEvent.MMFadeEvent ( float  duration,
float  targetAlpha,
MMTweenType  tween,
int  id = 0,
bool  ignoreTimeScale = true,
Vector3  worldPosition = new Vector3() 
)

Initializes a new instance of the MoreMountains.MMInterface.MMFadeEvent struct.

Parameters
durationDuration, in seconds.
targetAlphaTarget alpha, from 0 to 1.

Member Function Documentation

◆ Trigger() [1/2]

static void MoreMountains.Tools.MMFadeEvent.Trigger ( float  duration,
float  targetAlpha 
)
static

◆ Trigger() [2/2]

static void MoreMountains.Tools.MMFadeEvent.Trigger ( float  duration,
float  targetAlpha,
MMTweenType  tween,
int  id = 0,
bool  ignoreTimeScale = true,
Vector3  worldPosition = new Vector3() 
)
static

Member Data Documentation

◆ Curve

MMTweenType MoreMountains.Tools.MMFadeEvent.Curve

the curve to apply to the fade

◆ Duration

float MoreMountains.Tools.MMFadeEvent.Duration

the duration of the fade, in seconds

◆ e

MMFadeEvent MoreMountains.Tools.MMFadeEvent.e
static

◆ ID

int MoreMountains.Tools.MMFadeEvent.ID

an ID that has to match the one on the fader

◆ IgnoreTimeScale

bool MoreMountains.Tools.MMFadeEvent.IgnoreTimeScale

whether or not this fade should ignore timescale

◆ TargetAlpha

float MoreMountains.Tools.MMFadeEvent.TargetAlpha

the alpha to aim for

◆ WorldPosition

Vector3 MoreMountains.Tools.MMFadeEvent.WorldPosition

a world position for a target object. Useless for regular fades, but can be useful for alt implementations (circle fade for example)


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