Class LemonUI::Scaleform::Celebration
ClassList > LemonUI > Scaleform > Celebration
The foreground of the celebration scaleform.
Inherits the following classes: LemonUI::Scaleform::CelebrationCore
Public Properties
| Type | Name |
|---|---|
| property CelebrationBackground | Background The background of the scaleform. |
| property string?? | Challenge The challenge shown. |
| property int | Duration For how long the scalefom is show. |
| property CelebrationForeground | Foreground The foreground of the scaleform. |
| property string?? | Job The job name shown. |
| property string?? | Mode The mode name shown. |
| property CelebrationStyle | Style The style of the celebration. |
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
| Type | Name |
|---|---|
| property bool | Visible If this processable item is visible on the screen. |
Public Functions
| Type | Name |
|---|---|
| void | Cancel () Cancels the current screen being shown. |
| Celebration () Initializes a new Celebration scaleform. |
|
| virtual override void | DrawFullScreen () Draws the celebration scaleform. |
| virtual override void | Process () Draws the scaleform full screen. |
__ |
| void | Show ()
Shows the celebration scaleform. |
Public Functions inherited from LemonUI::Scaleform::CelebrationCore
See LemonUI::Scaleform::CelebrationCore
| Type | Name |
|---|---|
| CelebrationCore (string sc) Initializes a new class with the core behavior of the Celebration scaleform. |
|
| virtual override void | Update () Updates the celebration 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
| Type | Name |
|---|---|
| void | Draw () Draws the item on the screen. |
Public Functions inherited from LemonUI::IProcessable
| Type | Name |
|---|---|
| void | Process () Processes the object. |
Public Properties Documentation
property Background
CelebrationBackground LemonUI.Scaleform.Celebration.Background;
property Challenge
The challenge shown.
string?? LemonUI.Scaleform.Celebration.Challenge;
This is used to show messages like "ROUND 10" or "POTENTIAL CUT $1000000".
property Duration
int LemonUI.Scaleform.Celebration.Duration;
property Foreground
CelebrationForeground LemonUI.Scaleform.Celebration.Foreground;
property Job
The job name shown.
string?? LemonUI.Scaleform.Celebration.Job;
This is used to show the current job name like "The Prison Break" or "Premium Race - East Coast".
property Mode
The mode name shown.
string?? LemonUI.Scaleform.Celebration.Mode;
This is used to show the current mode, like "HEIST", "RACE", "LAST TEAM STANDING", etc.
property Style
CelebrationStyle LemonUI.Scaleform.Celebration.Style;
Public Functions Documentation
function Cancel
inline void LemonUI::Scaleform::Celebration::Cancel ()
function Celebration
inline LemonUI::Scaleform::Celebration::Celebration ()
function DrawFullScreen
inline virtual override void LemonUI::Scaleform::Celebration::DrawFullScreen ()
Implements LemonUI::Scaleform::BaseScaleform::DrawFullScreen
function Process
inline virtual override void LemonUI::Scaleform::Celebration::Process ()
Implements LemonUI::Scaleform::BaseScaleform::Process
function Show
inline void LemonUI::Scaleform::Celebration::Show ()
The documentation for this class was generated from the following file repos/LemonUI/LemonUI/Scaleform/Celebration.cs