Class Celebration

The foreground of the celebration scaleform.

Inheritance

object

BaseScaleform

CelebrationCore

Celebration

Implements

Inherited Members

CelebrationCore.Update()

BaseScaleform.scaleform

BaseScaleform.IsValueReady(int)

BaseScaleform.GetValue<T>(int)

BaseScaleform.CallFunction(string, params object[])

BaseScaleform.CallFunction<T>(string, params object[])

BaseScaleform.CallFunctionReturn(string, params object[])

BaseScaleform.Draw()

BaseScaleform.Dispose()

BaseScaleform.Handle

BaseScaleform.Name

BaseScaleform.Visible

BaseScaleform.IsLoaded

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: LemonUI.Scaleform

Assembly: LemonUI.SHVDN3.dll

Syntax

public class Celebration : CelebrationCore, IScaleform, IDrawable, IProcessable, IDisposable

Constructors

View Source

Celebration()

Initializes a new Celebration scaleform.

Declaration

public Celebration()

Properties

View Source

Background

The background of the scaleform.

Declaration

public CelebrationBackground Background { get; }

Property Value

Type	Description
CelebrationBackground

View Source

Challenge

The challenge shown.

Declaration

public string Challenge { get; set; }

Property Value

Type	Description
string

Remarks

This is used to show messages like "ROUND 10" or "POTENTIAL CUT $1000000".

View Source

Duration

For how long the scalefom is show.

Declaration

public int Duration { get; set; }

Property Value

Type	Description
int

View Source

Foreground

The foreground of the scaleform.

Declaration

public CelebrationForeground Foreground { get; }

Property Value

Type	Description
CelebrationForeground

View Source

Job

The job name shown.

Declaration

public string Job { get; set; }

Property Value

Type	Description
string

Remarks

This is used to show the current job name like "The Prison Break" or "Premium Race - East Coast".

View Source

Mode

The mode name shown.

Declaration

public string Mode { get; set; }

Property Value

Type	Description
string

Remarks

This is used to show the current mode, like "HEIST", "RACE", "LAST TEAM STANDING", etc.

View Source

Style

The style of the celebration.

Declaration

public CelebrationStyle Style { get; set; }

Property Value

Type	Description
CelebrationStyle

Methods

View Source

Cancel()

Cancels the current screen being shown.

Declaration

public void Cancel()

View Source

DrawFullScreen()

Draws the celebration scaleform.

Declaration

public override void DrawFullScreen()

Overrides

BaseScaleform.DrawFullScreen()

View Source

Process()

Draws the scaleform full screen.

Declaration

public override void Process()

Overrides

BaseScaleform.Process()

View Source

Show()

Shows the celebration scaleform.

Declaration

public void Show()

Events

View Source

Finished

Event triggered when the scaleform has finished fading out.

Declaration

public event EventHandler Finished

Event Type

Type	Description
EventHandler

View Source

Shown

Event triggered when the scaleform is shown on the screen.

Declaration

public event EventHandler Shown

Event Type

Type	Description
EventHandler

Implements

IScaleform

IDrawable

IProcessable

IDisposable