Class LemonUI::Scaleform::LoadingScreen

ClassList > LemonUI > Scaleform > LoadingScreen

Loading screen like the transition between story mode and online.

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

Public Properties

Type	Name
property string??	Description The description of the loading screen.
property string	Dictionary The Texture Dictionary (TXD) where the texture is loaded.
property string??	Subtitle The subtitle of the loading screen.
property string	Texture The texture in the dictionary.
property string??	Title The title of the loading screen.

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	ChangeTexture (string dictionary, string texture) Changes the texture shown on the loading screen.
	LoadingScreen (string title, string subtitle, string description) Creates a new GTA Online like loading screen with no image.
	LoadingScreen (string title, string subtitle, string description, string dictionary, string texture) Creates a new GTA Online like loading screen with a custom texture.
virtual override void	Update () Updates the Title, Description and Image of the loading screen.

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

property Description

string?? LemonUI.Scaleform.LoadingScreen.Description;

property Dictionary

string LemonUI.Scaleform.LoadingScreen.Dictionary;

property Subtitle

string?? LemonUI.Scaleform.LoadingScreen.Subtitle;

property Texture

string LemonUI.Scaleform.LoadingScreen.Texture;

property Title

string?? LemonUI.Scaleform.LoadingScreen.Title;

Public Functions Documentation

function ChangeTexture

Changes the texture shown on the loading screen.

inline void LemonUI::Scaleform::LoadingScreen::ChangeTexture (
    string dictionary,
    string texture
) 

Parameters:

• dictionary The Texture Dictionary or TXD.
• texture The Texture name.

function LoadingScreen [1/2]

Creates a new GTA Online like loading screen with no image.

inline LemonUI::Scaleform::LoadingScreen::LoadingScreen (
    string title,
    string subtitle,
    string description
) 

Parameters:

• title The title of the screen.
• subtitle The subtitle of the screen.
• description The description of the screen.

function LoadingScreen [2/2]

Creates a new GTA Online like loading screen with a custom texture.

inline LemonUI::Scaleform::LoadingScreen::LoadingScreen (
    string title,
    string subtitle,
    string description,
    string dictionary,
    string texture
) 

Parameters:

• title The title of the screen.
• subtitle The subtitle of the screen.
• description The description of the screen.
• dictionary The dictionary where the texture is located.
• texture The texture to use on the right.

function Update

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

Implements LemonUI::Scaleform::BaseScaleform::Update

---

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