Class LemonUI::Scaleform::BigMessage

ClassList > LemonUI > Scaleform > BigMessage

A customizable big message.

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

Public Properties

Type	Name
property int	BackgroundColor The color of the background in the Customizable message type.
property string??	Message The subtitle or description of the message.
property string??	Rank The Rank when the mode is set to Cops and Crooks.
property int	TextColor The color of the text. Only used on the Customizable message type.
property string??	Title The title of the message.
property MessageType	Type The type of message to show.
property WeaponHash	Weapon The hash of the Weapon as an enum.
property uint	WeaponHash The hash of the Weapon as it's native value.

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
	BigMessage (string title) Creates a standard customizable message with just a title.
	BigMessage (string title, MessageType type) Creates a custom message with the specified title.
	BigMessage (string title, string message) Creates a standard customizable message with a title and message.
	BigMessage (string title, string message, string rank) Creates a Cops and Crooks message type.
	BigMessage (string title, string message, MessageType type) Creates a message with the specified type, title and message.
	BigMessage (string title, int colorText) Creates a standard customizable message with a title and a custom text color.
	BigMessage (string title, int colorText, int colorBackground) Creates a standard customizable message with a specific title and custom colors.
	BigMessage (string title, string weapon, WeaponHash hash) Creates a Weapon Purchase message with a custom text and weapons.
	BigMessage (string title, string message, string weapon, WeaponHash hash) Creates a Weapon Purchase message with a custom text and weapons.
	BigMessage (string title, string message, string rank, WeaponHash weapon, int colorText, int colorBackground, MessageType type) Creates a message with all of the selected information.
	BigMessage (string title, string message, string rank, uint weapon, int colorText, int colorBackground, MessageType type) Creates a message with all of the selected information.
virtual override void	DrawFullScreen () Draws the scaleform full screen.

__ | | void | FadeOut (int time)
Fades the big message out. | | virtual override void | Update ()
Updates the Message information in the Scaleform . |

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 BackgroundColor

int LemonUI.Scaleform.BigMessage.BackgroundColor;

property Message

string?? LemonUI.Scaleform.BigMessage.Message;

property Rank

string?? LemonUI.Scaleform.BigMessage.Rank;

property TextColor

int LemonUI.Scaleform.BigMessage.TextColor;

property Title

string?? LemonUI.Scaleform.BigMessage.Title;

property Type

MessageType LemonUI.Scaleform.BigMessage.Type;

property Weapon

WeaponHash LemonUI.Scaleform.BigMessage.Weapon;

property WeaponHash

uint LemonUI.Scaleform.BigMessage.WeaponHash;

Public Functions Documentation

function BigMessage [1/11]

Creates a standard customizable message with just a title.

inline LemonUI::Scaleform::BigMessage::BigMessage (
    string title
) 

Parameters:

• title The title to use.

function BigMessage [2/11]

Creates a custom message with the specified title.

inline LemonUI::Scaleform::BigMessage::BigMessage (
    string title,
    MessageType type
) 

Parameters:

• title The title to use.
• type The type of message.

function BigMessage [3/11]

Creates a standard customizable message with a title and message.

inline LemonUI::Scaleform::BigMessage::BigMessage (
    string title,
    string message
) 

Parameters:

• title The title to use.
• message The message to show.

function BigMessage [4/11]

Creates a Cops and Crooks message type.

inline LemonUI::Scaleform::BigMessage::BigMessage (
    string title,
    string message,
    string rank
) 

Parameters:

• title The title to use.
• message The message to show.
• rank Text to show in the Rank space.

function BigMessage [5/11]

Creates a message with the specified type, title and message.

inline LemonUI::Scaleform::BigMessage::BigMessage (
    string title,
    string message,
    MessageType type
) 

Parameters:

• title The title to use.
• message The message to show.
• type The type of message.

function BigMessage [6/11]

Creates a standard customizable message with a title and a custom text color.

inline LemonUI::Scaleform::BigMessage::BigMessage (
    string title,
    int colorText
) 

Parameters:

• title The title to use.
• colorText The color of the text.

function BigMessage [7/11]

Creates a standard customizable message with a specific title and custom colors.

inline LemonUI::Scaleform::BigMessage::BigMessage (
    string title,
    int colorText,
    int colorBackground
) 

Parameters:

• title The title to use.
• colorText The color of the text.
• colorBackground The color of the background.

function BigMessage [8/11]

Creates a Weapon Purchase message with a custom text and weapons.

inline LemonUI::Scaleform::BigMessage::BigMessage (
    string title,
    string weapon,
    WeaponHash hash
) 

Parameters:

• title The title to use.
• weapon The name of the Weapon.
• hash The hash of the Weapon image.

function BigMessage [9/11]

Creates a Weapon Purchase message with a custom text and weapons.

inline LemonUI::Scaleform::BigMessage::BigMessage (
    string title,
    string message,
    string weapon,
    WeaponHash hash
) 

Parameters:

• title The title to use.
• message The message to show.
• weapon The name of the Weapon.
• hash The hash of the Weapon image.

function BigMessage [10/11]

Creates a message with all of the selected information.

inline LemonUI::Scaleform::BigMessage::BigMessage (
    string title,
    string message,
    string rank,
    WeaponHash weapon,
    int colorText,
    int colorBackground,
    MessageType type
) 

Parameters:

• title The title to use.
• message The message to show.
• rank The Rank on Cops and Crooks.
• weapon The hash of the Weapon image.
• colorText The color of the text.
• colorBackground The color of the background.
• type The type of message.

function BigMessage [11/11]

Creates a message with all of the selected information.

inline LemonUI::Scaleform::BigMessage::BigMessage (
    string title,
    string message,
    string rank,
    uint weapon,
    int colorText,
    int colorBackground,
    MessageType type
) 

Parameters:

• title The title to use.
• message The message to show.
• rank The Rank on Cops and Crooks.
• weapon The hash of the Weapon image.
• colorText The color of the text.
• colorBackground The color of the background.
• type The type of message.

function DrawFullScreen

inline virtual override void LemonUI::Scaleform::BigMessage::DrawFullScreen () 

Implements LemonUI::Scaleform::BaseScaleform::DrawFullScreen

function FadeOut

Fades the big message out.

inline void LemonUI::Scaleform::BigMessage::FadeOut (
    int time
) 

Parameters:

• time The time it will take to do the fade.

function Update

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

Implements LemonUI::Scaleform::BaseScaleform::Update

---

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