scaleform.Stingray namespace reference

Description

Scaleform Studio plugin to Stingray namespace

Related sample code

Appkit: /scaleform_studio_input.lua

Related help topics

	Getting Started > Open an existing project
	Creating User Interfaces > Integrating a Scaleform Studio project into {{ProductName}}
	Creating User Interfaces > Communication between {{ProductName}} and Scaleform Studio
	The Interactive Plug-in SDK > Define a {{ProductName}} Plug-in

Functions

load_project ( project_name, bundle_name ) : boolean Loads a Scaleform Studio project.

Parameters

project_name :	string	The name of the project you want to load.
bundle_name :	string	The name of the bundle you want to load.

Returns

boolean

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

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

Parameters

project_id :	string	The resource id of the project you want to load.
scene_id :	string?	The resource id of the scene you want to play at startup. If nothing is specified the default scene is used. 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.

Related sample code

Basic template: /main_menu.lua Basic template: /player_hud.lua Character template: /main_menu.lua Character template: /player_hud.lua Vehicle template: /main_menu.lua Vehicle template: /player_hud.lua Oculus VR template: /main_menu.lua

memory_report ( ) Logs the current Scaleform Studio memory usage.

Parameters

This function does not accept any parameters.

Returns

This function does not return any values.

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

Parameters

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.

Related sample code

Appkit: /scaleform_studio_input.lua

unload_project ( ) Unloads a Scaleform Studio project.

Parameters

This function does not accept any parameters.

Returns

This function does not return any values.

Related sample code

Basic template: /main_menu.lua Basic template: /player_hud.lua Character template: /main_menu.lua Character template: /player_hud.lua Vehicle template: /main_menu.lua Vehicle template: /player_hud.lua Oculus VR template: /main_menu.lua

update ( ) Update all loaded Scaleform Studio projects by a time step.

Parameters

This function does not accept any parameters.

Returns

This function does not return any values.

Related sample code

Appkit: /app.lua