scaleform.Rtt namespace reference

Description

Scaleform Studio plugin to Rtt namespace

Functions

load_project ( rtt_handle, project_name, bundle_name, scene_name, width, height ) : boolean Loads a Scaleform Studio project.

Parameters

rtt_handle :	integer	A handle for a render target
project_name :	string	The name of the project you want to load.
bundle_name :	string	The name of the bundle you want to load.
scene_name :	string	The name of the scene in which you want to start.
width :	integer	The width of the render target
height :	integer	The height of the render target

Returns

boolean

Returns true if the project loaded successfully, or false otherwise.

load_project_and_scene ( rtt_handle, width, height, project_id, scene_id ) : boolean Loads a Scaleform Studio project.

Parameters

rtt_handle :	integer	A handle for a render target
width :	integer	The width of the render target
height :	integer	The height of the render target
project_id :	string	The resource id of the project you want to load.
scene_id :	string?	The resource id of the scene in which you want to start. The ? notation indicates that this type is optional: there may be zero or one instances of it.

Returns

boolean

Returns true if the project loaded successfully, or false otherwise.

send_message ( rtt_handle, msgName, args ) Sends a message to all of the loaded Scaleform Studio projects.

Parameters

rtt_handle :	integer	A handle for a render target
msgName :	string	The name of the message to send.
args :	any*	A series of arguments that are numbers, strings, or Booleans. The * notation indicates that there may be zero or more instances of the specified type.

Returns

This function does not return any values.

unload_project ( rtt_handle ) Unloads a Scaleform Studio project from a given Rtt.

Parameters

rtt_handle :

integer

A handle for a render target

Returns

This function does not return any values.