stingray.Vector2Box object reference

Description

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

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

For more information, see Object Lifetimes and Userdata Binding.

Operators

Accessing components: []

You can set and retrieve component values by using the [] operator. Use the indices 1 or "x" for the X component, and 2 or "y" for the Y component. For example:

yComponentValue = vectorBox[2]
xComponentValue = vectorBox["x"]

Constructors and accessors

stingray.Vector2Box() stingray.Vector2Box() stingray.Vector2Box()

Other related reference items

	stingray.Vector2.to_string()
	Math

Related help topics

Release Notes > Stingray 1.1 Release Notes

Data Members

x : number The X axis component value last stored in the box.

y : number The Y axis component value last stored in the box.

Functions

store ( self, vector ) Stores the specified vector values in the box.

Parameters

self :	stingray.Vector2Box	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.
vector :	stingray.Vector2	The vector to store in the box.

Returns

This function does not return any values.

store ( self, x, y ) Stores the specified vector values in the box.

Parameters

self :	stingray.Vector2Box	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.
x :	number	The X component value to store in the box.
y :	number	The Y component value to store in the box.

Returns

This function does not return any values.

unbox ( self ) : stingray.Vector2 Retrieves the vector last stored in the specified box.

Parameters

self :

stingray.Vector2Box

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.Vector2

The vector retrieved from the box.