Scaleform Studio category

Sub-categories

Timeline

Nodes

Scaleform Check Custom Event Listeners Checks to see if a custom event that has been registered has occurred at some prior time.

Outputs
		Event Found		event	This will trigger if the event is found, thus continuing the flow processing chain.
		Event Payload		string	The name of the dispatched event. It is recommended to use colon delimited data strings, for example: MyEvent:40:AString:true.
Inputs
string		Event Name			The name of the event to check for, for example: MyEvent.
event		In			This event triggers the evaluation of this node.

If the event has occurred, the event data payload will be returned and the event cleared from the event list to prevent double eventing.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Script node definition in file: core/scaleform_studio/scaleform_studio.script_flow_nodes

Scaleform Dispatch Custom Event Send a custom event to the currently loaded Scaleform Studio project.

Outputs
		Out		event	This event is triggered when the node finishes its evaluation.
Inputs
string		Event			A string which contains the name of the event and a colon delimited series of arguments, for example: MyEvent:40:AString:true would dispatch an event named MyEvent with arguments 40, AString and true. In the appropriate event handler, the name string would be processed to extract the data.
event		In			This event triggers the evaluation of this node.

Any custom event listener will be notified and can check to see if the custom event is something to which they should respond.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Script node definition in file: core/scaleform_studio/scaleform_studio.script_flow_nodes

Scaleform Load Project This node loads a Scaleform Studio project.

Outputs
		Out		event	This event is triggered when the node finishes its evaluation.
Inputs
string		Bundle Path			The relative path to the Stingray project root, for example: content/ui/MyProjectFolder.
string		Project Name			The name of the project with the .s2dproj extension, for example: MyProject.s2dproj.
event		In			This event triggers the evaluation of this node.

This node must be called before using any other Scaleform Flow nodes.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Script node definition in file: core/scaleform_studio/scaleform_studio.script_flow_nodes

Scaleform Load Project And Scene This node loads a Scaleform Studio project.

Outputs
		Out		event	This event is triggered when the node finishes its evaluation.
		Loaded		boolean	A boolean value indicating if the project was successfully loaded.
Inputs
string		Project			The resource ID of the Scaleform Studio project.
string		Scene			The resource ID of the Scaleform Studio scene associated with the project.
event		In			This event triggers the evaluation of this node.

This node must be called before using any other Scaleform Flow nodes. If a scene is provided it will set that scene as the start up scene.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Script node definition in file: core/scaleform_studio/scaleform_studio.script_flow_nodes

Scaleform Register Custom Event Listener Register a listener for a custom event in Stingray.

Outputs
		Out		event	This event is triggered when the node finishes its evaluation.
Inputs
string		Event			The name of the custom event independent of any data. For example: for a name string of MyEvent:40:true, the name of the event to register is just MyEvent.
event		In			This event triggers the evaluation of this node.

Any custom event which is not registered will be ignored.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Script node definition in file: core/scaleform_studio/scaleform_studio.script_flow_nodes

Scaleform Unload Project Clear the currently loaded project.

Outputs
		Out		event	This event is triggered when the node finishes its evaluation.
Inputs
event		In			This event triggers the evaluation of this node.

It should be used before switching projects or before shutting down.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Script node definition in file: core/scaleform_studio/scaleform_studio.script_flow_nodes

Scaleform Unregister All Custom Event Listeners Unregister all registered events.

Outputs
		Out		event	This event is triggered when the node finishes its evaluation.
Inputs
event		In			This event triggers the evaluation of this node.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Script node definition in file: core/scaleform_studio/scaleform_studio.script_flow_nodes

Scaleform Unregister Custom Event Listener Causes a registered listener to stop listening for a custom event.

Outputs
		Out		event	This event is triggered when the node finishes its evaluation.
Inputs
string		Event			The name of the custom event independent of any data, for example: MyEvent.
event		In			This event triggers the evaluation of this node.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Script node definition in file: core/scaleform_studio/scaleform_studio.script_flow_nodes