ActorBox - stingray.ActorBox object reference - Stingray Lua API Reference
Description
A "box" that stores an Actor object across multiple frames, ensuring that the stored Actor has not become invalid by being destroyed in the physics world.
When you need a reference to an actor to persist across multiple frames, you can call ActorBox.store() to store the actor in an ActorBox, and ActorBox.unbox() to retrieve the stored values.
Constructors and accessors 
Other related reference items
Functions
 |
store ( self, actor )
Stores the specified actor in the specified box.
|
self : |
Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see Object lifetimes and userdata binding, or this page in the Lua documentation. | |
actor : |
The physics actor to store to the box. |
| This function does not return any values. |
If actor is nil, the box is cleared.
| |
unbox ( self ) : nil, stingray.Actor
Retrieves the stored actor from the box, if any.
|
self : |
Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see Object lifetimes and userdata binding, or this page in the Lua documentation. |
|
The actor last stored in the box, if it is still valid. If the box is empty, or if the actor last stored in the box has been destroyed in the physics world, returns nil. |