stingray.QuaternionBox object reference

Description

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

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

For more information, see Object Lifetimes and Userdata Binding.

Constructors and accessors

stingray.QuaternionBox() stingray.QuaternionBox() stingray.QuaternionBox()

Related sample code

Appkit: /app.lua Character template: /player.lua Vehicle template: /vehicle_follow_cam.lua

Other related reference items

Math

Related help topics

	Creating Gameplay > Scripting with Lua > Using the Lua API > Object lifetimes and userdata binding
	Playtesting Your Game > Optimize memory usage

Functions

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

Parameters

self :	stingray.QuaternionBox	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.
quat :	stingray.Quaternion	The quaternion to store in the box.

Returns

This function does not return any values.

store ( self, x, y, z, w ) Stores the specified quaternion values in the box.

Parameters

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

Returns

This function does not return any values.

unbox ( self ) : stingray.Quaternion Retrieves the quaternion last stored in the specified box.

Parameters

self :

stingray.QuaternionBox

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.

Returns

stingray.Quaternion

The quaternion retrieved from the box.