ssCore.Flash.setVariable

Set the value of a Flash variable. This function exists primarily for use with tools like SWiSH to allow Flash variables to be created. Flash.setVariable makes it possible for these applications to send data to helper movies created in Flash to perform tasks that would be impossible in SWiSH alone.


Availability:

First available in version 3.0 build 2039.

Not available in ActionScript 3.


Input Parameters:

name - A fully qualified Flash variable name.

value - The value to assign to the named variable.


Output Parameters:

No output parameters.


Asynchronous Mode:

When this method is called asynchronously, a return object containing the output parameters is passed to the specified callback function.

ssCore.Flash.setVariable( paramsObject [, callbackParamsObject] [, errorParamsObject] );


Synchronous Mode:

When this method is called synchronously, a return object containing the output parameters is returned to the caller immediately.

var returnObject = ssCore.Flash.setVariable( paramsObject );


Notes:

This function exists primarily for use with tools like SWiSH to allow Flash variables to be created. This makes it possible for these applications to send data to helper movies created in Flash to perform tasks that would be impossible in SWiSH alone.


Examples:

The following example sets a variable in _level0 to a value.

ssCore.Flash.setVariable({name:"myVar", value:"Hello Flash"});