Reloads the UI flash asset.
UIAction.ReloadElement( elementName, instanceID )
Parameter | Description |
---|---|
elementName | UI Element name as defined in the xml. |
instanceID | ID of the instance (if instance with id does not exist, it will be created). '-1' for all instances. |
Unloads the UI flash asset.
UIAction.UnloadElement( elementName, instanceID )
Parameter | Description |
---|---|
elementName | UI Element name as defined in the xml. |
instanceID | ID of the instance (if instance with id does not exist, it will be created). '-1' for all instances. |
Displays the UI flash asset.
UIAction.ShowElement( elementName, instanceID )
Parameter | Description |
---|---|
elementName | UI Element name as defined in the xml. |
instanceID | ID of the instance (if instance with id does not exist, it will be created). '-1' for all instances. |
Hide the UI flash asset.
UIAction.HideElement( elementName, instanceID )
Parameter | Description |
---|---|
elementName | UI Element name as defined in the xml. |
instanceID | ID of the instance (if instance with id does not exist, it will be created). '-1' for all instances. |
Send the fade out signal to the UI flash asset.
UIAction.RequestHide( elementName, instanceID )
Parameter | Description |
---|---|
elementName | UI Element name as defined in the xml. |
instanceID | ID of the instance (if instance with id does not exist, it will be created). '-1' for all instances. |
Calls a function of the UI flash asset or the UIEventSystem.
UIAction.CallFunction( elementName, instanceID, functionName, [arg1], [arg2], [...] )
Parameter | Description |
---|---|
elementName | UI Element name as defined in the xml or UIEventSystem name as defined via cpp. |
instanceID | ID of the instance (if instance with id does not exist, it will be created). '-1' for all instances. If used on UIEventSystem no instance id is ignored. |
functionName | Function or event name. |
args | List of arguments (optional). |
Sets a variable of the UI flash asset.
UIAction.SetVariable( elementName, instanceID, varName, value )
Parameter | Description |
---|---|
elementName | UI Element name as defined in the xml. |
instanceID | ID of the instance (if instance with id does not exist, it will be created). '-1' for all instances. |
varName | Variable name as defined in the xml. |
value | Value to set. |
Gets a variable of the UI flash asset.
UIAction.GetVariable( elementName, instanceID, varName )
Parameter | Description |
---|---|
elementName | UI Element name as defined in the xml. |
instanceID | ID of the instance (if instance with id does not exist, it will be created). '-1' for all instances. |
varName | Variable name as defined in the xml. |
Sets an array of the UI flash asset.
UIAction.SetArray( elementName, instanceID, arrayName, values )
Parameter | Description |
---|---|
elementName | UI Element name as defined in the xml. |
instanceID | ID of the instance (if instance with id does not exist, it will be created). '-1' for all instances. |
arrayName | Array name as defined in the xml. |
values | Table of values for the array. |
Returns a table with values of the array.
UIAction.GetArray( elementName, instanceID, arrayName )
Parameter | Description |
---|---|
elementName | UI Element name as defined in the xml. |
instanceID | ID of the instance (if instance with id does not exist, it will be created). '-1' for all instances. |
arrayName | Array name as defined in the xml. |
Call GotoAndPlay on a MovieClip.
UIAction.GotoAndPlay( elementName, instanceID, mcName, frameNum )
Parameter | Description |
---|---|
elementName | UI Element name as defined in the xml. |
instanceID | ID of the instance (if instance with id does not exist, it will be created). '-1' for all instances. |
mcName | MovieClip name as defined in the xml. |
frameNum | frame number. |
Call GotoAndStop on a MovieClip.
UIAction.GotoAndStop( elementName, instanceID, mcName, frameNum )
Parameter | Description |
---|---|
elementName | UI Element name as defined in the xml. |
instanceID | ID of the instance (if instance with id does not exist, it will be created). '-1' for all instances. |
mcName | MovieClip name as defined in the xml. |
frameNum | frame number. |
Call GotoAndPlay on a MovieClip by frame name.
UIAction.GotoAndPlayFrameName( elementName, instanceID, mcName, frameName )
Parameter | Description |
---|---|
elementName | UI Element name as defined in the xml. |
instanceID | ID of the instance (if instance with id does not exist, it will be created). '-1' for all instances. |
mcName | MovieClip name as defined in the xml. |
frameName | frame name. |
Call GotoAndStop on a MovieClip by frame name.
UIAction.GotoAndStopFrameName( elementName, instanceID, mcName, frameName )
Parameter | Description |
---|---|
elementName | UI Element name as defined in the xml. |
instanceID | ID of the instance (if instance with id does not exist, it will be created). '-1' for all instances. |
mcName | MovieClip name as defined in the xml. |
frameName | frame name. |
Set MovieClip alpha value.
UIAction.SetAlpha( elementName, instanceID, mcName, fAlpha )
Parameter | Description |
---|---|
elementName | UI Element name as defined in the xml. |
instanceID | ID of the instance (if instance with id does not exist, it will be created). '-1' for all instances. |
mcName | MovieClip name as defined in the xml. |
fAlpha | alpha value (0-1). |
Get MovieClip alpha value.
UIAction.GetAlpha( elementName, instanceID, mcName )
Parameter | Description |
---|---|
elementName | UI Element name as defined in the xml. |
instanceID | ID of the instance (if instance with id does not exist, it will be created). '-1' for all instances. |
mcName | MovieClip name as defined in the xml. |
Set MovieClip visible state.
UIAction.SetVisible( elementName, instanceID, mcName, bVisible )
Parameter | Description |
---|---|
elementName | UI Element name as defined in the xml. |
instanceID | ID of the instance (if instance with id does not exist, it will be created). '-1' for all instances. |
mcName | MovieClip name as defined in the xml. |
bVisible | visible. |
Get MovieClip visible state.
UIAction.IsVisible( elementName, instanceID, mcName )
Parameter | Description |
---|---|
elementName | UI Element name as defined in the xml. |
instanceID | ID of the instance (if instance with id does not exist, it will be created). '-1' for all instances. |
mcName | MovieClip name as defined in the xml. |
Set MovieClip position.
UIAction.SetPos( elementName, instanceID, mcName, vPos )
Parameter | Description |
---|---|
elementName | UI Element name as defined in the xml. |
instanceID | ID of the instance (if instance with id does not exist, it will be created). '-1' for all instances. |
mcName | MovieClip name as defined in the xml. |
vPos | position. |
Get MovieClip position.
UIAction.GetPos( elementName, instanceID, mcName )
Parameter | Description |
---|---|
elementName | UI Element name as defined in the xml. |
instanceID | ID of the instance (if instance with id does not exist, it will be created). '-1' for all instances. |
mcName | MovieClip name as defined in the xml. |
Set MovieClip rotation.
UIAction.SetRotation( elementName, instanceID, mcName, vRotation )
Parameter | Description |
---|---|
elementName | UI Element name as defined in the xml. |
instanceID | ID of the instance (if instance with id does not exist, it will be created). '-1' for all instances. |
mcName | MovieClip name as defined in the xml. |
vRotation | rotation. |
Get MovieClip rotation.
UIAction.GetRotation( elementName, instanceID, mcName )
Parameter | Description |
---|---|
elementName | UI Element name as defined in the xml. |
instanceID | ID of the instance (if instance with id does not exist, it will be created). '-1' for all instances |
mcName | MovieClip name as defined in the xml. |
Set MovieClip scale.
UIAction.SetScale( elementName, instanceID, mcName, vScale )
Parameter | Description |
---|---|
elementName | UI Element name as defined in the xml. |
instanceID | ID of the instance (if instance with id does not exist, it will be created). '-1' for all instances. |
mcName | MovieClip name as defined in the xml. |
vScale | scale. |
Get MovieClip scale.
UIAction.GetScale( elementName, instanceID, mcName )
Parameter | Description |
---|---|
elementName | UI Element name as defined in the xml. |
instanceID | ID of the instance (if instance with id does not exist, it will be created). '-1' for all instances. |
mcName | MovieClip name as defined in the xml. |
Starts a UI Action.
UIAction.StartAction( actionName, arguments )
Parameter | Description |
---|---|
actionName | UI Action name. |
arguments | arguments to pass to this action. |
Ends a UI Action. This can be only used withing a UIAction Lua script!
UIAction.EndAction( table, disable, arguments )
Parameter | Description |
---|---|
table | must be "self". |
disable | if true this action gets disabled on end. |
arguments | arguments to return from this action. |
Enables the UI Action.
UIAction.EnableAction( actionName )
Parameter | Description |
---|---|
actionName | UI Action name. |
Disables the UI Action.
UIAction.DisableAction( actionName )
Parameter | Description |
---|---|
actionName | UI Action name. |
Register a callback function for a UIElement event. Callback Function must have form: CallbackName(elementName, instanceId, eventName, argTable)
UIAction.RegisterElementListener( table, elementName, instanceID, eventName, callbackFunctionName )
Parameter | Description |
---|---|
table | the script that receives the callback (can be "self" to refer the current script). |
elementName | UI Element name as defined in the xml. |
instanceID | ID of the instance (if instance with id does not exist, it will be created). '-1' for all instances. |
eventName | Name of the event that is fired from the UI Element - if empty string it will receive all events! |
callbackFunctionName | name of the script function that will receive the callback. |
Register a callback function for a UIAction event. Callback Function must have form: CallbackName(actionName, eventName, argTable)
UIAction.RegisterActionListener( table, actionName, eventName, callbackFunctionName )
Parameter | Description |
---|---|
table | the script that receives the callback (can be "self" to refer the current script). |
actionName | UI Action name. |
eventName | Name of the event that is fired from the UI Action (can be "OnStart" or "OnEnd") - if empty string it will receive all events! |
callbackFunctionName | name of the script function that will receive the callback. |
Register a callback function for a UIEventSystem event. Callback Function must have form: CallbackName(actionName, eventName, argTable)
UIAction.RegisterEventSystemListener( table, eventSystem, eventName, callbackFunctionName )
Parameter | Description |
---|---|
table | the script that receives the callback (can be "self" to refer the current script). |
eventSystem | UI Event System name |
eventName | Name of the event that is fired from the UI EventSystem - if empty string it will receive all events! |
callbackFunctionName | name of the script function that will receive the callback. |
Unregister callback functions for a UIElement event.
UIAction.UnregisterElementListener( table, callbackFunctionName )
Parameter | Description |
---|---|
table | the script that receives the callback (can be "self" to refer the current script). |
callbackFunctionName | name of the script function that receives the callback. if "" all callbacks for this script will be removed. |
Unregister callback functions for a UIAction event.
UIAction.UnregisterActionListener( table, callbackFunctionName )
Parameter | Description |
---|---|
table | the script that receives the callback (can be "self" to refer the current script). |
callbackFunctionName | name of the script function that receives the callback. if "" all callbacks for this script will be removed. |
Unregister callback functions for a UIEventSystem event.
UIAction.UnregisterEventSystemListener( table, callbackFunctionName )
Parameter | Description |
---|---|
table | the script that receives the callback (can be "self" to refer the current script). |
callbackFunctionName | name of the script function that receives the callback. if "" all callbacks for this script will be removed. |