Warhorse ScripBind documentation
ContentsIndexHome
PreviousUpNext
CScriptBindUIAction Methods

The methods of the CScriptBindUIAction class are listed here.

 
Name 
Description 
 
Syntax: UIAction.CallFunction( elementName, instanceID, functionName, [arg1], [arg2], [...] )
Calls a function of the UI flash asset or the UIEventSystem.
 
 
Syntax: UIAction.DisableAction( actionName )
Disables the UI Action.
 
 
Syntax: UIAction.EnableAction( actionName )
Enables the UI Action.
 
 
Syntax: UIAction.EndAction( table, disable, arguments )
Ends a UI Action. This can be only used withing a UIAction Lua script!
 
 
Syntax: UIAction.GetAlpha( elementName, instanceID, mcName )
Get MovieClip alpha value.
 
 
Syntax: UIAction.GetArray( elementName, instanceID, arrayName )
Returns a table with values of the array. 
 
This is GetMemoryUsage, a member of class CScriptBindUIAction. 
 
Syntax: UIAction.GetPos( elementName, instanceID, mcName )
Get MovieClip position.
 
 
Syntax: UIAction.GetRotation( elementName, instanceID, mcName )
Get MovieClip rotation.
 
 
Syntax: UIAction.GetScale( elementName, instanceID, mcName )
Get MovieClip scale.
 
 
Syntax: UIAction.GetVariable( elementName, instanceID, varName )
Gets a variable of the UI flash asset. 
 
Syntax: UIAction.GotoAndPlay( elementName, instanceID, mcName, frameNum )
Call GotoAndPlay on a MovieClip.
 
 
Syntax: UIAction.GotoAndPlayFrameName( elementName, instanceID, mcName, frameName )
Call GotoAndPlay on a MovieClip by frame name.
 
 
Syntax: UIAction.GotoAndStop( elementName, instanceID, mcName, frameNum )
Call GotoAndStop on a MovieClip.
 
 
Syntax: UIAction.GotoAndStopFrameName( elementName, instanceID, mcName, frameName )
Call GotoAndStop on a MovieClip by frame name.
 
 
Syntax: UIAction.HideElement( elementName, instanceID )
Hide the UI flash asset.
 
 
Syntax: UIAction.IsVisible( elementName, instanceID, mcName )
Get MovieClip visible state.
 
 
Syntax: UIAction.RegisterActionListener( table, actionName, eventName, callbackFunctionName )
Register a callback function for a UIAction event. Callback Function must have form: CallbackName(actionName, eventName, argTable)
 
 
Syntax: UIAction.RegisterElementListener( table, elementName, instanceID, eventName, callbackFunctionName )
Register a callback function for a UIElement event. Callback Function must have form: CallbackName(elementName, instanceId, eventName, argTable)
 
 
Syntax: UIAction.RegisterEventSystemListener( table, eventSystem, eventName, callbackFunctionName )
Register a callback function for a UIEventSystem event. Callback Function must have form: CallbackName(actionName, eventName, argTable)
 
 
This is Release, a member of class CScriptBindUIAction. 
 
IUIModule
 
 
Syntax: UIAction.ReloadElement( elementName, instanceID )
Reloads the UI flash asset.
 
 
Syntax: UIAction.RequestHide( elementName, instanceID )
Send the fade out signal to the UI flash asset.
 
 
 
 
Syntax: UIAction.SetAlpha( elementName, instanceID, mcName, fAlpha )
Set MovieClip alpha value.
 
 
Syntax: UIAction.SetArray( elementName, instanceID, arrayName, values )
Sets an array of the UI flash asset. 
 
Syntax: UIAction.SetPos( elementName, instanceID, mcName, vPos )
Set MovieClip position.
 
 
Syntax: UIAction.SetRotation( elementName, instanceID, mcName, vRotation )
Set MovieClip rotation.
 
 
Syntax: UIAction.SetScale( elementName, instanceID, mcName, vScale )
Set MovieClip scale.
 
 
Syntax: UIAction.SetVariable( elementName, instanceID, varName, value )
Sets a variable of the UI flash asset. 
 
Syntax: UIAction.SetVisible( elementName, instanceID, mcName, bVisible )
Set MovieClip visible state.
 
 
Syntax: UIAction.ShowElement( elementName, instanceID )
Displays the UI flash asset.
 
 
Syntax: UIAction.StartAction( actionName, arguments )
Starts a UI Action.
 
 
Syntax: UIAction.UnloadElement( elementName, instanceID )
Unloads the UI flash asset.
 
 
Syntax: UIAction.UnregisterActionListener( table, callbackFunctionName )
Unregister callback functions for a UIAction event.
 
 
Syntax: UIAction.UnregisterElementListener( table, callbackFunctionName )
Unregister callback functions for a UIElement event.
 
 
Syntax: UIAction.UnregisterEventSystemListener( table, callbackFunctionName )
Unregister callback functions for a UIEventSystem event.
 
Copyright (c) 2012. All rights reserved.