Class LemonUI::Scaleform::InstructionalButtons

ClassList > LemonUI > Scaleform > InstructionalButtons

Buttons shown on the bottom right of the screen.

Inherits the following classes: LemonUI::Scaleform::BaseScaleform

Public Properties inherited from LemonUI::Scaleform::BaseScaleform

See LemonUI::Scaleform::BaseScaleform

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
void	Add (InstructionalButton button) Adds an Instructional Button.
void	Clear () Removes all of the instructional buttons.
	InstructionalButtons (params InstructionalButton[] buttons) Creates a new set of Instructional Buttons.
void	Remove (InstructionalButton button) Removes an Instructional Button.
virtual override void	Update () Refreshes the items shown in the Instructional buttons.

Public Functions inherited from LemonUI::Scaleform::BaseScaleform

See LemonUI::Scaleform::BaseScaleform

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 Functions Documentation

function Add

Adds an Instructional Button.

inline void LemonUI::Scaleform::InstructionalButtons::Add (
    InstructionalButton button
) 

Parameters:

• button The button to add.

function Clear

inline void LemonUI::Scaleform::InstructionalButtons::Clear () 

function InstructionalButtons

Creates a new set of Instructional Buttons.

inline LemonUI::Scaleform::InstructionalButtons::InstructionalButtons (
    params InstructionalButton [] buttons
) 

Parameters:

• buttons The buttons to add into this menu.

function Remove

Removes an Instructional Button.

inline void LemonUI::Scaleform::InstructionalButtons::Remove (
    InstructionalButton button
) 

Parameters:

• button The button to remove.

function Update

inline virtual override void LemonUI::Scaleform::InstructionalButtons::Update () 

Implements LemonUI::Scaleform::BaseScaleform::Update

---

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