Actions State Actions

 

Bind State

Binds an instance of the XLua object to the global lua state associated with the given ID.

If the state does not exist, it will be created (You don't need to call Create State first). You must bind the XLua object to a state before it will do anything.

Parameters

Value State ID

Create State

Creates a new global lua state associated with the given ID. This does not automatically bind the object.  In most cases, you will not need to explicitly call this action, because a state is automatically created when you use the Bind State action or Bind State property.

Parameters

Value Integer ID value to associate the new state with

Destroy State

Destroys the Lua state associated with the given ID value.  If the ID does not match a valid state, the action is ignored.  If there is an XLua object currently bound to the state, it will be detached.

If this action is called from within an active call stack, any XLua objects bound to the state will be detached at the end of the event where this action was called. The call stack will safely unwind, and then the state will be destroyed. Neveretheless, you should always exercise caution when destroying an XLua state from within an active call stack.

Parameters

Value State ID

Unbind State

Unbinds an instance of the XLua object from the global lua state associated with the given ID.

If this action is called from within an active call stack, the XLua object will be detached from its state at the end of the event where this action was called. The call stack will safely unwind, leaving the previously bound state in-tact. Nevertheless, you should exercise caution when unbinding a state from within an active call stack.

Parameters

Value State ID

Copyright 2010 Justin Aquadro