stingray.Matrix4x4Box object reference

Description

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

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

For more information, see Object Lifetimes and Userdata Binding.

Constructors and accessors

stingray.Matrix4x4Box() stingray.Script.deserialize()

Related sample code

Basic template: /player.lua Character template: /player.lua Vehicle template: /player.lua Desktop VR template: /player.lua Gear VR template: /player.lua Google VR template: /player.lua

Other related reference items

	stingray.Cloud stingray.SaveSystem
	stingray.Script.serialize()
	Math

Related help topics

Creating Gameplay > Scripting with Lua > Using the Lua API > Object lifetimes and userdata binding

Functions

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

Parameters

self :	stingray.Matrix4x4Box	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.
m :	stingray.Matrix4x4	The matrix to store in the box.

Returns

This function does not return any values.

unbox ( self ) : stingray.Matrix4x4 Retrieves the matrix last stored in the specified box.

Parameters

self :

stingray.Matrix4x4Box

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

The matrix retrieved from the box.