Class LemonUI::Scaleform::BaseScaleform

ClassList > LemonUI > Scaleform > BaseScaleform

Represents a generic Scaleform object.

Inherits the following classes: LemonUI::Scaleform::IScaleform

Inherited by the following classes: LemonUI::Scaleform::BigMessage, LemonUI::Scaleform::BruteForce, LemonUI::Scaleform::CelebrationCore, LemonUI::Scaleform::Countdown, LemonUI::Scaleform::InstructionalButtons, LemonUI::Scaleform::LoadingScreen, LemonUI::Scaleform::PopUp

Public Properties

Type	Name
property int	Handle The ID or Handle of the Scaleform .
property bool	IsLoaded If the Scaleform is loaded or not.
property string	Name The Name of the Scaleform .
property bool	Visible If the Scaleform should be visible or not.

Public Properties inherited from LemonUI::IProcessable

See LemonUI::IProcessable

Type	Name
property bool	Visible If this processable item is visible on the screen.

Public Functions

Type	Name
	BaseScaleform (string sc) Creates a new Scaleform class with the specifiedScaleform object name.
void	CallFunction (string function, params object[] parameters) Calls a Scaleform function.
int	CallFunctionReturn (string function, params object[] parameters) Calls a Scaleform function with a return value.
void	Dispose () Marks the scaleform as no longer needed.
virtual void	Draw () Draws the scaleform full screen.
virtual void	DrawFullScreen () Draws the scaleform full screen.
T	GetValue< T > (int id) Gets a specific value.
bool	IsValueReady (int id) Checks if the specified Scaleform Return Value is ready to be fetched.
virtual void	Process () Draws the scaleform full screen.
virtual abstract void	Update () = 0 Updates the parameters of the Scaleform .

Public Functions inherited from LemonUI::Scaleform::IScaleform

See LemonUI::Scaleform::IScaleform

Type	Name
void	DrawFullScreen () Draws the Scaleform in full screen.

Public Functions inherited from LemonUI::IDrawable

See LemonUI::IDrawable

Type	Name
void	Draw () Draws the item on the screen.

Public Functions inherited from LemonUI::IProcessable

See LemonUI::IProcessable

Type	Name
void	Process () Processes the object.

Public Properties Documentation

property Handle

int LemonUI.Scaleform.BaseScaleform.Handle;

property IsLoaded

bool LemonUI.Scaleform.BaseScaleform.IsLoaded;

property Name

string LemonUI.Scaleform.BaseScaleform.Name;

property Visible

bool LemonUI.Scaleform.BaseScaleform.Visible;

Public Functions Documentation

function BaseScaleform

Creates a new Scaleform class with the specifiedScaleform object name.

inline LemonUI::Scaleform::BaseScaleform::BaseScaleform (
    string sc
)

Parameters:

sc The Scalform object.

function CallFunction

Calls a Scaleform function.

inline void LemonUI::Scaleform::BaseScaleform::CallFunction (
    string function,
    params object[] parameters
)

Parameters:

function The name of the function to call.
parameters The parameters to pass.

function CallFunctionReturn

Calls a Scaleform function with a return value.

inline int LemonUI::Scaleform::BaseScaleform::CallFunctionReturn (
    string function,
    params object[] parameters
)

Parameters:

function The name of the function to call.
parameters The parameters to pass.

function Dispose

inline void LemonUI::Scaleform::BaseScaleform::Dispose ()

function Draw

virtual void LemonUI::Scaleform::BaseScaleform::Draw ()

Implements LemonUI::IDrawable::Draw

function DrawFullScreen

inline virtual void LemonUI::Scaleform::BaseScaleform::DrawFullScreen ()

Implements LemonUI::Scaleform::IScaleform::DrawFullScreen

function GetValue< T >

Gets a specific value.

inline T LemonUI::Scaleform::BaseScaleform::GetValue< T > (
    int id
)

Template parameters:

T The type of value.

Parameters:

id The Identifier of the value.

Returns:

The value returned by the native.

function IsValueReady

Checks if the specified Scaleform Return Value is ready to be fetched.

inline bool LemonUI::Scaleform::BaseScaleform::IsValueReady (
    int id
)

Parameters:

id The Identifier of the Value.

Returns:

true if the value is ready, false otherwise.

function Process

virtual void LemonUI::Scaleform::BaseScaleform::Process ()

Implements LemonUI::IProcessable::Process

function Update

virtual abstract void LemonUI::Scaleform::BaseScaleform::Update () = 0

The documentation for this class was generated from the following file repos/LemonUI/LemonUI/Scaleform/BaseScaleform.cs