stingray.Vector3Box object reference

Description

A "box" that stores a Vector3 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 Vector3Box.store() to store the vector in a Vector3Box, and Vector3Box.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, 2 or "y" for the Y component, and 3 or "z" for the Z component. For example:

yComponentValue = vectorBox[2]
zComponentValue = vectorBox["z"]

Constructors and accessors

stingray.Script.deserialize() stingray.Vector3Box() stingray.Vector3Box() stingray.Vector3Box()

Related sample code

Appkit: /app.lua Appkit: /input_mapper.lua Appkit: /player_util.lua Appkit: /unit_controller.lua Basic template: /player_hud.lua Basic template: /player.lua Character template: /input_mapper.lua Character template: /player_hud.lua Character template: /player.lua Vehicle template: /player_hud.lua Vehicle template: /player.lua Vehicle template: /vehicle_follow_cam.lua Vehicle template: /vehicle_unit_controller.lua Desktop VR template: /player.lua Gear VR template: /player.lua Google VR template: /google_vr.lua Google VR template: /player.lua

Other related reference items

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

Related help topics

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

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.

z : number The Z axis component value last stored in the box.

Functions

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

Parameters

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

Returns

This function does not return any values.

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

Parameters

self :	stingray.Vector3Box	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.

Returns

This function does not return any values.

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

Parameters

self :

stingray.Vector3Box

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

The vector retrieved from the box.