SCR_FadeUIComponent Class Reference

Inheritance diagram for SCR_FadeUIComponent:

Protected Member Functions
void	FadeIn (bool setOpacityZero=true)
void	DelayedFadeIn (int delay, bool setOpacityZero=true)
void	FadeOut (bool destroyOnFadeOut)
void	DelayedFadeOut (int delay, bool destroyOnFadeOut, bool setOpacityTofadeInTarget=true)
void	CancelFade (bool callFadeDone)
void	SetFadeInSpeed (float fadeInSpeed)
Widget	GetFadeWidget ()
bool	IsFading ()
bool	IsFadingIn ()
bool	IsFadingOut ()
float	GetTargetFadeInOpacity ()
ScriptInvoker	GetOnFadeDone ()
void	StartListenToFadeDone (bool isFadeIn)
void	FadeDoneCheck ()
override void	HandlerAttached (Widget w)
override void	HandlerDeattached (Widget w)

Protected Attributes
string	m_sFadeWidgetName
float	m_fFadeInOpacitytarget
float	m_fFadeInAnimationSpeed
float	m_fFadeOutAnimationSpeed
bool	m_bAutoFadeIn
float	m_bFadeDoneUpdateSpeed
Widget	m_wFadeWidget
string	m_sOnFadeInSfx
bool	m_bFadeInSfxHasPriority
string	m_sOnFadeOutSfx
bool	m_bFadeOutSfxHasPriority
bool	m_bIsWaitingForDelayedFadeIn
bool	m_bIsWaitingForDelayedFadeOut
bool	m_bIsFading
bool	m_bIsFadingIn
bool	m_bCheckingForFadeOutDestroy = false
ref ScriptInvoker	Event_OnFadeDone

Detailed Description

Definition at line 1 of file SCR_FadeUIComponent.c.

Member Function Documentation

CancelFade()

void SCR_FadeUIComponent::CancelFade ( bool callFadeDone )

inlineprotected

Cancel current fade

Parameters

[in]

callFadeDone

if true it will still call the fade done event

Definition at line 132 of file SCR_FadeUIComponent.c.

DelayedFadeIn()

void SCR_FadeUIComponent::DelayedFadeIn ( int delay, bool setOpacityZero = true )

inlineprotected

Fade in with delay (in miliseconds)

Parameters

[in]	delay	how long will the delay be fore fading
[in]

will set opacity to 0 if this is true. Else keeps current opacity

Definition at line 74 of file SCR_FadeUIComponent.c.

DelayedFadeOut()

void SCR_FadeUIComponent::DelayedFadeOut ( int delay, bool destroyOnFadeOut, bool setOpacityTofadeInTarget = true )

inlineprotected

Fade out with delay (in milliseconds)

Parameters

[in]	delay	how long will fading take
[in]	destroyOnFadeOut	will destroy widget if fade out animation is done
[in]	setOpacityTofadeInTarget	will set opacity to the given fade in amount if this is true. Else keeps current opacity

Definition at line 117 of file SCR_FadeUIComponent.c.

FadeDoneCheck()

void SCR_FadeUIComponent::FadeDoneCheck ( )

inlineprotected

Definition at line 225 of file SCR_FadeUIComponent.c.

FadeIn()

void SCR_FadeUIComponent::FadeIn ( bool setOpacityZero = true )

inlineprotected

Fade in widget

Parameters

[in]

setOpacityZero

will set opacity to 0 if this is true. Else keeps current opacity

Definition at line 47 of file SCR_FadeUIComponent.c.

FadeOut()

void SCR_FadeUIComponent::FadeOut ( bool destroyOnFadeOut )

inlineprotected

Fade out widget

Parameters

[in]

destroyOnFadeOut

will destroy widget if fade out animation is done

Definition at line 91 of file SCR_FadeUIComponent.c.

GetFadeWidget()

Widget SCR_FadeUIComponent::GetFadeWidget ( )

inlineprotected

Get Fade widget

Returns

the widget to be faded

Definition at line 168 of file SCR_FadeUIComponent.c.

GetOnFadeDone()

ScriptInvoker SCR_FadeUIComponent::GetOnFadeDone ( )

inlineprotected

Get Fade done Script Invoker

Returns

script invoker triggering when fade is done. Vars: SCR_FadeUIComponent bool isFadeIn

Definition at line 204 of file SCR_FadeUIComponent.c.

GetTargetFadeInOpacity()

float SCR_FadeUIComponent::GetTargetFadeInOpacity ( )

inlineprotected

Returns

fade in opacity target

Definition at line 196 of file SCR_FadeUIComponent.c.

HandlerAttached()

override void SCR_FadeUIComponent::HandlerAttached ( Widget w )

inlineprotected

Definition at line 251 of file SCR_FadeUIComponent.c.

HandlerDeattached()

override void SCR_FadeUIComponent::HandlerDeattached ( Widget w )

inlineprotected

Definition at line 272 of file SCR_FadeUIComponent.c.

IsFading()

bool SCR_FadeUIComponent::IsFading ( )

inlineprotected

Returns

if the widget is being faded by the this specific component

Definition at line 175 of file SCR_FadeUIComponent.c.

IsFadingIn()

bool SCR_FadeUIComponent::IsFadingIn ( )

inlineprotected

Returns

true if the currently fading and if the fade is a fade in, false otherwise

Definition at line 182 of file SCR_FadeUIComponent.c.

IsFadingOut()

bool SCR_FadeUIComponent::IsFadingOut ( )

inlineprotected

Returns

true if the currently fading and if the fade is a fade out, false otherwise

Definition at line 189 of file SCR_FadeUIComponent.c.

SetFadeInSpeed()

void SCR_FadeUIComponent::SetFadeInSpeed ( float fadeInSpeed )

inlineprotected

Set the fade in speed

Parameters

[in]

fadeInSpeed

new fade in speed

Definition at line 160 of file SCR_FadeUIComponent.c.

StartListenToFadeDone()

void SCR_FadeUIComponent::StartListenToFadeDone ( bool isFadeIn )

inlineprotected

Definition at line 213 of file SCR_FadeUIComponent.c.

Member Data Documentation

Event_OnFadeDone

ref ScriptInvoker SCR_FadeUIComponent::Event_OnFadeDone

protected

Definition at line 42 of file SCR_FadeUIComponent.c.

m_bAutoFadeIn

bool SCR_FadeUIComponent::m_bAutoFadeIn

protected

Definition at line 16 of file SCR_FadeUIComponent.c.

m_bCheckingForFadeOutDestroy

bool SCR_FadeUIComponent::m_bCheckingForFadeOutDestroy = false

protected

Definition at line 40 of file SCR_FadeUIComponent.c.

m_bFadeDoneUpdateSpeed

float SCR_FadeUIComponent::m_bFadeDoneUpdateSpeed

protected

Definition at line 19 of file SCR_FadeUIComponent.c.

m_bFadeInSfxHasPriority

bool SCR_FadeUIComponent::m_bFadeInSfxHasPriority

protected

Definition at line 27 of file SCR_FadeUIComponent.c.

m_bFadeOutSfxHasPriority

bool SCR_FadeUIComponent::m_bFadeOutSfxHasPriority

protected

Definition at line 33 of file SCR_FadeUIComponent.c.

m_bIsFading

bool SCR_FadeUIComponent::m_bIsFading

protected

Definition at line 38 of file SCR_FadeUIComponent.c.

m_bIsFadingIn

bool SCR_FadeUIComponent::m_bIsFadingIn

protected

Definition at line 39 of file SCR_FadeUIComponent.c.

m_bIsWaitingForDelayedFadeIn

bool SCR_FadeUIComponent::m_bIsWaitingForDelayedFadeIn

protected

Definition at line 36 of file SCR_FadeUIComponent.c.

m_bIsWaitingForDelayedFadeOut

bool SCR_FadeUIComponent::m_bIsWaitingForDelayedFadeOut

protected

Definition at line 37 of file SCR_FadeUIComponent.c.

m_fFadeInAnimationSpeed

float SCR_FadeUIComponent::m_fFadeInAnimationSpeed

protected

Definition at line 10 of file SCR_FadeUIComponent.c.

m_fFadeInOpacitytarget

float SCR_FadeUIComponent::m_fFadeInOpacitytarget

protected

Definition at line 7 of file SCR_FadeUIComponent.c.

m_fFadeOutAnimationSpeed

float SCR_FadeUIComponent::m_fFadeOutAnimationSpeed

protected

Definition at line 13 of file SCR_FadeUIComponent.c.

m_sFadeWidgetName

string SCR_FadeUIComponent::m_sFadeWidgetName

protected

Definition at line 4 of file SCR_FadeUIComponent.c.

m_sOnFadeInSfx

string SCR_FadeUIComponent::m_sOnFadeInSfx

protected

Definition at line 24 of file SCR_FadeUIComponent.c.

m_sOnFadeOutSfx

string SCR_FadeUIComponent::m_sOnFadeOutSfx

protected

Definition at line 30 of file SCR_FadeUIComponent.c.

m_wFadeWidget

Widget SCR_FadeUIComponent::m_wFadeWidget

protected

Definition at line 21 of file SCR_FadeUIComponent.c.

---

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

• scripts/Game/UI/Components/Animations/SCR_FadeUIComponent.c