Class BaseScaleform

Represents a generic Scaleform object.

Inheritance

object

BaseScaleform

BigMessage

BruteForce

CelebrationCore

Countdown

InstructionalButtons

LoadingScreen

PopUp

Implements

IScaleform

IDrawable

IProcessable

IDisposable

Inherited Members

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 abstract class BaseScaleform : IScaleform, IDrawable, IProcessable, IDisposable

Constructors

BaseScaleform(string)

Creates a new Scaleform class with the specified Scaleform object name.

Declaration

public BaseScaleform(string sc)

Parameters

Type	Name	Description
string	sc	The Scalform object.

Fields

scaleform

The ID of the scaleform.

Declaration

[Obsolete("Please use the Handle or Name properties and call the methods manually.", true)]
protected Scaleform scaleform

Field Value

Type	Description
Scaleform

Properties

Handle

The ID or Handle of the Scaleform.

Declaration

public int Handle { get; }

Property Value

Type	Description
int

IsLoaded

If the Scaleform is loaded or not.

Declaration

public bool IsLoaded { get; }

Property Value

Type	Description
bool

Name

The Name of the Scaleform.

Declaration

public string Name { get; }

Property Value

Type	Description
string

Visible

If the Scaleform should be visible or not.

Declaration

public virtual bool Visible { get; set; }

Property Value

Type	Description
bool

Methods

CallFunction(string, params object[])

Calls a Scaleform function.

Declaration

public void CallFunction(string function, params object[] parameters)

Parameters

Type	Name	Description
string	function	The name of the function to call.
object[]	parameters	The parameters to pass.

CallFunctionReturn(string, params object[])

Calls a Scaleform function with a return value.

Declaration

public int CallFunctionReturn(string function, params object[] parameters)

Parameters

Type	Name	Description
string	function	The name of the function to call.
object[]	parameters	The parameters to pass.

Returns

Type	Description
int

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

Calls a scaleform function and gets it's return value as soon as is available.

Declaration

public T CallFunction<T>(string function, params object[] parameters)

Parameters

Type	Name	Description
string	function	The function to call.
object[]	parameters	The parameters to call the function with.

Returns

Type	Description
T	The value returned by the function.

Type Parameters

Name	Description
T	The type of return parameter.

Dispose()

Marks the scaleform as no longer needed.

Declaration

public void Dispose()

Draw()

Draws the scaleform full screen.

Declaration

public virtual void Draw()

DrawFullScreen()

Draws the scaleform full screen.

Declaration

public virtual void DrawFullScreen()

GetValue<T>(int)

Gets a specific value.

Declaration

public T GetValue<T>(int id)

Parameters

Type	Name	Description
int	id	The Identifier of the value.

Returns

Type	Description
T	The value returned by the native.

Type Parameters

Name	Description
T	The type of value.

IsValueReady(int)

Checks if the specified Scaleform Return Value is ready to be fetched.

Declaration

public bool IsValueReady(int id)

Parameters

Type	Name	Description
int	id	The Identifier of the Value.

Returns

Type	Description
bool	true if the value is ready, false otherwise.

Process()

Draws the scaleform full screen.

Declaration

public virtual void Process()

Update()

Updates the parameters of the Scaleform.

Declaration

public abstract void Update()

Implements

IScaleform

IDrawable

IProcessable

IDisposable