stingray.IdString32Box object reference

Description

A "box" that stores a IdString32Box object across multiple frames.

Normally, IdString32s are temporary objects that can only be safely used within a single frame. When you need an IdString32 value to persist across multiple frames, you can call IdString32Box.store() to store the vector in a IdString32, and [IdString32.unbox()] to retrieve the stored values.

For more information, see Object Lifetimes and Userdata Binding.

Constructors and accessors

stingray.Script.deserialize()

Other related reference items

	stingray.SaveSystem
	stingray.Script.serialize()

Related help topics

Release Notes > Stingray 1.8 Release Notes

Functions

store ( self, s ) Stores the specified value in the box.

Parameters

self :	stingray.IdString32Box	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 this Stingray help topic, or this page in the Lua documentation.
s :	string	The value to store in the box.

Returns

This function does not return any values.

unbox ( self ) : stingray.IdString32 Retrieves the IdString32Box last stored in the specified box.

Parameters

self :

stingray.IdString32Box

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 this Stingray help topic, or this page in the Lua documentation.

Returns

stingray.IdString32

The value retrieved from the box.