stingray.Vector3 object reference

Description

Describes a three-dimensional vector.

NOTE: Vector3 objects are temporary. You can only use them in the frame in which they were generated. If you need to save a Vector3 across multiple frames, use a Vector3Box instead. For more information, see Object Lifetimes and Userdata Binding.

Operators

You can use several operators like + and - to modify and transform Vector3 objects, described below.

Addition: +

You can add two vectors together using the + operator. For example:

newVector = vector1 + vector2

This is equivalent to the add() function.

Subtraction: -

You can subtract one vector from another using the - operator. For example:

newVector = vector1 - vector2

This is equivalent to the subtract() function.

Negation: -

You can negate a vector using the - operator as a prefix to any vector variable. For example:

negativeVector = -vector1

Multiplication: *

You can multiply a vector by a scalar value using the * operator. For example:

newVector = vector * scalarFactor

This is equivalent to the multiply() function. See also multiply_elements(), which lets you multiply two vectors together per-element.

Division: /

You can divide a vector by a scalar value using the / operator. For example:

newVector = vector / scalarFactor

This is equivalent to the divide() function. See also divide_elements(), which lets you divide one vector by another per-element.

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 = vector[2]
zComponentValue = vector["z"]

Constructors and accessors

stingray.Actor.angular_velocity() stingray.Actor.center_of_mass() stingray.Actor.point_velocity() stingray.Actor.position() stingray.Actor.velocity() stingray.BaseInputController.axis() stingray.Camera.local_position() stingray.Camera.screen_to_world() stingray.Camera.world_position() stingray.Camera.world_to_screen() stingray.GoogleVR.controller_acceleration() stingray.GoogleVR.controller_gyroscope() stingray.GwNavAStar.node_at_index() stingray.GwNavBot.compute_move_on_navmesh() stingray.GwNavBot.compute_move_on_spline() stingray.GwNavBot.output_velocity() stingray.GwNavBot.velocity() stingray.GwNavQueries.diskcast() stingray.GwNavQueries.inside_position_from_outside_position() stingray.GwNavQueries.move_on_navmesh() stingray.GwNavQueries.raycast() stingray.GwNavQueries.raycast_full_3d() stingray.GwNavQueries.triangle_from_position() stingray.GwNavSmartObjectInterval.entrance_position() stingray.GwNavSmartObjectInterval.exit_position() stingray.GwNavTraversal.get_triangle_vertices() stingray.GwNavWorld.database_triangle() stingray.HumanIK.character_get_effector_transform() stingray.HumanIK.character_get_line_position() stingray.HumanIK.character_get_marker_position() stingray.HumanIK.character_get_node_position() stingray.HumanIK.character_get_node_transform() stingray.HumanIK.character_node_get_limits() stingray.HumanIK.character_node_get_limits_draw_line() stingray.HumanIK.character_offset_position_get_vector() stingray.HumanIK.character_offset_rotation_get_axis() stingray.HumanIK.creature_get_chain_effector_position() stingray.HumanIK.creature_get_chain_effector_transform() stingray.HumanIK.creature_get_chain_node_position() stingray.HumanIK.creature_get_line_position() stingray.HumanIK.creature_get_marker_position() stingray.HumanIK.creature_get_section_effector_position() stingray.HumanIK.creature_get_section_effector_transform() stingray.HumanIK.creature_stats_get_chain_last_chain_err_q() stingray.HumanIK.creature_stats_get_chain_last_chain_pull_dir() stingray.HumanIK.creature_stats_get_section_last_section_err_q_pull() stingray.HumanIK.creature_stats_get_section_last_section_err_q_reach() stingray.HumanIK.creature_stats_get_section_last_sum_err() stingray.InputController.axis() stingray.Joint.d6_drive_position() stingray.Joint.d6_drive_velocity() stingray.Keyboard.axis() stingray.Level.next_random_point_inside_volume() stingray.Level.random_point_inside_volume() stingray.Level.spline() stingray.Level.spline_by_index() stingray.LevelResource.unit_position() stingray.Light.color() stingray.Light.local_position() stingray.Light.world_position() stingray.LODObject.local_position() stingray.LODObject.world_position() stingray.Math.merge_boxes() stingray.Matrix4x4.axis() stingray.Matrix4x4.forward() stingray.Matrix4x4.right() stingray.Matrix4x4.scale() stingray.Matrix4x4.transform() stingray.Matrix4x4.transform_without_translation() stingray.Matrix4x4.translation() stingray.Matrix4x4.up() stingray.Matrix4x4.x() stingray.Matrix4x4.y() stingray.Matrix4x4.z() stingray.Mesh.bounding_volume_components() stingray.Mesh.box() stingray.Mesh.local_position() stingray.Mesh.world_position() stingray.MeshComponent.oobb() stingray.MeshComponent.raycast() stingray.Mouse.axis() stingray.Mover.fits_at() stingray.Mover.position() stingray.Mover.separate() stingray.NavigationMesh.constrain_to_polygon() stingray.NavigationMesh.project_to_polygon() stingray.NavigationMesh.update_polygon() stingray.NavigationMesh.vertex() stingray.Oculus.tracking_space_scale() stingray.Pad1.axis() stingray.Pad2.axis() stingray.Pad3.axis() stingray.Pad4.axis() stingray.PhysicsWorld.raycast() stingray.PS4Pad1.axis() stingray.PS4Pad2.axis() stingray.PS4Pad3.axis() stingray.PS4Pad4.axis() stingray.Quaternion.decompose() stingray.Quaternion.forward() stingray.Quaternion.right() stingray.Quaternion.rotate() stingray.Quaternion.up() stingray.Raycast.cast() stingray.SceneGraphComponent.local_position() stingray.SceneGraphComponent.local_scale() stingray.SceneGraphComponent.world_position() stingray.SceneGraphNode.local_position() stingray.SceneGraphNode.world_position() stingray.Script.deserialize() stingray.Sensor.accelerometer_acceleration() stingray.Sensor.accelerometer_resolution() stingray.Sensor.gravity_sensor_gravity() stingray.Sensor.gravity_sensor_resolution() stingray.Sensor.gyroscope_rotation_rate() stingray.Sensor.magnetometer_calibrated_magnetic_field() stingray.Sensor.magnetometer_magnetic_field() stingray.Sensor.magnetometer_resolution() stingray.ShadingEnvironment.array_vector2() stingray.ShadingEnvironment.array_vector3() stingray.ShadingEnvironment.vector2() stingray.ShadingEnvironment.vector3() stingray.SimulatedTouchPanel.accelerator_resolution() stingray.SimulatedTouchPanel.axis() stingray.SimulatedTouchPanel.location() stingray.SimulatedTouchPanel.location_delta() stingray.SimulatedTouchPanel.resolution() stingray.SimulatedTouchPanel1.accelerator_resolution() stingray.SimulatedTouchPanel1.axis() stingray.SimulatedTouchPanel1.location() stingray.SimulatedTouchPanel1.location_delta() stingray.SimulatedTouchPanel1.resolution() stingray.SteamVR.tracking_space_local_rectangle() stingray.SteamVR.tracking_space_scale() stingray.SteamVR.tracking_space_world_rectangle() stingray.SynergyKeyboard.axis() stingray.SynergyMouse.axis() stingray.Tablet.axis() stingray.TouchInputController.accelerator_resolution() stingray.TouchInputController.axis() stingray.TouchInputController.location() stingray.TouchInputController.location_delta() stingray.TouchInputController.resolution() stingray.TouchPanel.accelerator_resolution() stingray.TouchPanel.axis() stingray.TouchPanel.location() stingray.TouchPanel.location_delta() stingray.TouchPanel.resolution() stingray.TouchPanel1.accelerator_resolution() stingray.TouchPanel1.axis() stingray.TouchPanel1.location() stingray.TouchPanel1.location_delta() stingray.TouchPanel1.resolution() stingray.TouchPanel2.accelerator_resolution() stingray.TouchPanel2.axis() stingray.TouchPanel2.location() stingray.TouchPanel2.location_delta() stingray.TouchPanel2.resolution() stingray.TransformComponent.local_position() stingray.TransformComponent.local_scale() stingray.TransformComponent.world_position() stingray.Unit.box() stingray.Unit.delta_position() stingray.Unit.local_position() stingray.Unit.local_scale() stingray.Unit.mesh_pick_raycast() stingray.Unit.mover_fits_at() stingray.Unit.world_position() stingray.Vector3() stingray.Vector3.add() stingray.Vector3.backward() stingray.Vector3.base() stingray.Vector3.cross() stingray.Vector3.divide() stingray.Vector3.divide_elements() stingray.Vector3.down() stingray.Vector3.forward() stingray.Vector3.left() stingray.Vector3.lerp() stingray.Vector3.make_axes() stingray.Vector3.max() stingray.Vector3.min() stingray.Vector3.multiply() stingray.Vector3.multiply_elements() stingray.Vector3.normalize() stingray.Vector3.right() stingray.Vector3.subtract() stingray.Vector3.up() stingray.Vector3.zero() stingray.Vector3Box.unbox() stingray.VectorField.evaluate() stingray.VectorField.evaluate() stingray.Vehicle.forward() stingray.Vehicle.position() stingray.Vehicle.suspension_line_dir() stingray.Vehicle.suspension_line_start() stingray.Vehicle.tire_drivable_surface_contact_normal() stingray.Vehicle.tire_drivable_surface_contact_point() stingray.Vehicle.tire_lateral_dir() stingray.Vehicle.tire_longitudinal_dir()

Related sample code

Appkit: /camera_wrapper.lua Appkit: /debug_menu.lua Appkit: /debug_scrollbox.lua Appkit: /input_mapper.lua Appkit: /loading_screen.lua Appkit: /player_util.lua Appkit: /simple_project.lua Appkit: /unit_controller.lua Appkit: /util.lua Basic template: /player_hud.lua Basic template: /player.lua Basic template: /project.lua Character template: /flow_callbacks.lua Character template: /input_mapper.lua Character template: /player_hud.lua Character template: /player.lua Character template: /project.lua Character template: /util.lua Vehicle template: /player_hud.lua Vehicle template: /player.lua Vehicle template: /project.lua Vehicle template: /vehicle_follow_cam.lua Vehicle template: /vehicle_unit_controller.lua Oculus VR template: /flow_callbacks.lua Oculus VR template: /player.lua Oculus VR template: /project.lua Steam VR template: /flow_callbacks.lua Steam VR template: /player.lua Steam VR template: /project.lua Creating meshes procedurally Picking a unit with the mouse

Other related reference items

	stingray.Cloud stingray.Keyboard stingray.Mouse stingray.Pad1 stingray.Pad2 stingray.Pad3 stingray.Pad4 stingray.PS4Pad1 stingray.PS4Pad2 stingray.PS4Pad3 stingray.PS4Pad4 stingray.SaveSystem stingray.SimulatedTouchPanel stingray.SimulatedTouchPanel1 stingray.SynergyKeyboard stingray.SynergyMouse stingray.Tablet stingray.TouchPanel1 stingray.TouchPanel2
	stingray.BaseInputController stingray.Raycast stingray.ShadingEnvironment stingray.Vector3Box
	collision_hit
	stingray.Actor.add_angular_velocity() stingray.Actor.add_impulse() stingray.Actor.add_impulse_at() stingray.Actor.add_torque_impulse() stingray.Actor.add_velocity() stingray.Actor.add_velocity_at() stingray.Actor.point_velocity() stingray.Actor.push() stingray.Actor.push_at() stingray.Actor.set_angular_velocity() stingray.Actor.set_velocity() stingray.Actor.teleport_position() stingray.ActorComponent.create_plane() stingray.ActorComponent.create_sphere() stingray.AnimationStateMachineComponent.set_constraint_target() stingray.Application.enum_display_modes() stingray.Broadphase.add() stingray.Broadphase.move() stingray.Broadphase.query() stingray.Camera.inside_frustum() stingray.Camera.screen_to_world() stingray.Camera.set_local_position() stingray.Camera.world_to_screen() stingray.Cloth.create_collision_plane() stingray.Cloth.move_collision_plane() stingray.EntityManager.spawn() stingray.GameSession.create_game_object() stingray.Gui.bitmap() stingray.Gui.bitmap_3d() stingray.Gui.bitmap_3d_uv() stingray.Gui.bitmap_uv() stingray.Gui.rect() stingray.Gui.rect_3d() stingray.Gui.text() stingray.Gui.text_3d() stingray.Gui.triangle() stingray.Gui.update_bitmap() stingray.Gui.update_bitmap_3d() stingray.Gui.update_bitmap_3d_uv() stingray.Gui.update_bitmap_uv() stingray.Gui.update_rect() stingray.Gui.update_rect_3d() stingray.Gui.update_text() stingray.Gui.update_text_3d() stingray.Gui.update_triangle() stingray.Gui.update_video() stingray.Gui.update_video_3d() stingray.Gui.video() stingray.Gui.video_3d() stingray.GwNavAStar.initialize() stingray.GwNavBot.compute_astar_query_async() stingray.GwNavBot.compute_move_on_navmesh() stingray.GwNavBot.create() stingray.GwNavBot.init_astar_query() stingray.GwNavBot.update_position() stingray.GwNavBoxObstacle.create() stingray.GwNavBoxObstacle.create_exclusive() stingray.GwNavBoxObstacle.set_angular_velocity() stingray.GwNavBoxObstacle.set_linear_velocity() stingray.GwNavCylinderObstacle.create() stingray.GwNavCylinderObstacle.create_exclusive() stingray.GwNavCylinderObstacle.set_position() stingray.GwNavCylinderObstacle.set_velocity() stingray.GwNavGeneration.create() stingray.GwNavGeneration.push_seed_point() stingray.GwNavGeneration.push_tagvolume_fromvolume() stingray.GwNavGeneration.push_triangle() stingray.GwNavQueries.diskcango() stingray.GwNavQueries.diskcast() stingray.GwNavQueries.inside_position_from_outside_position() stingray.GwNavQueries.move_on_navmesh() stingray.GwNavQueries.raycango() stingray.GwNavQueries.raycast() stingray.GwNavQueries.raycast_full_3d() stingray.GwNavQueries.tag_volumes_from_position() stingray.GwNavQueries.triangle_from_position() stingray.GwNavTraversal.get_seed_triangle() stingray.GwNavWorld.set_visual_debug_camera_transform() stingray.GwNavWorld.visual_debug_draw_line() stingray.GwNavWorld.visual_debug_draw_text() stingray.Hololens.attach_entity() stingray.Hololens.create_anchor() stingray.Hololens.set_focus_point() stingray.HumanIK.character_aim_set_target_position() stingray.HumanIK.character_look_at_set_target_position() stingray.HumanIK.character_offset_position_set_vector() stingray.HumanIK.character_offset_rotation_set_axis() stingray.HumanIK.character_push_aim() stingray.HumanIK.character_push_look_at() stingray.HumanIK.character_push_offset_position() stingray.HumanIK.character_push_offset_rotation() stingray.HumanIK.character_push_reach_orientation() stingray.HumanIK.character_push_reach_position() stingray.HumanIK.character_reach_orientation_set_orientation() stingray.HumanIK.character_reach_position_set_position() stingray.HumanIK.creature_push_chain_reach_position() stingray.Joint.set_d6_drive_position() stingray.Joint.set_d6_drive_velocity() stingray.Level.is_point_inside_volume() stingray.Light.set_color() stingray.Light.set_local_position() stingray.LineObject.add_axes() stingray.LineObject.add_box() stingray.LineObject.add_capsule() stingray.LineObject.add_circle() stingray.LineObject.add_cone() stingray.LineObject.add_half_sphere() stingray.LineObject.add_line() stingray.LineObject.add_sphere() stingray.LODObject.set_local_position() stingray.Material.set_vector2() stingray.Material.set_vector3() stingray.Math.box_intersects_frustum() stingray.Math.box_in_frustum() stingray.Math.merge_boxes() stingray.Math.point_in_box() stingray.Math.ray_box_intersection() stingray.Matrix4x4.from_axes() stingray.Matrix4x4.from_quaternion_position() stingray.Matrix4x4.from_translation() stingray.Matrix4x4.set_axis() stingray.Matrix4x4.set_forward() stingray.Matrix4x4.set_right() stingray.Matrix4x4.set_scale() stingray.Matrix4x4.set_translation() stingray.Matrix4x4.set_up() stingray.Matrix4x4.set_x() stingray.Matrix4x4.set_y() stingray.Matrix4x4.set_z() stingray.Matrix4x4.transform() stingray.Matrix4x4.transform_without_translation() stingray.Mesh.set_local_position() stingray.MeshComponent.raycast() stingray.Mover.fits_at() stingray.Mover.move() stingray.Mover.set_position() stingray.NavigationMesh.constrain_to_polygon() stingray.NavigationMesh.find_nearest_polygon() stingray.NavigationMesh.find_polygon() stingray.NavigationMesh.partial_search() stingray.NavigationMesh.project_to_polygon() stingray.NavigationMesh.search() stingray.NavigationMesh.search() stingray.NavigationMesh.update_polygon() stingray.Oculus.set_tracking_space() stingray.PhysicsWorld.linear_capsule_sweep() stingray.PhysicsWorld.linear_obb_sweep() stingray.PhysicsWorld.linear_sphere_sweep() stingray.PhysicsWorld.make_raycast() stingray.PhysicsWorld.overlap() stingray.PhysicsWorld.raycast() stingray.PhysicsWorld.set_gravity() stingray.PhysicsWorld.spawn_box() stingray.PhysicsWorld.spawn_plane() stingray.PhysicsWorld.spawn_sphere() stingray.PhysicsWorld.wake_actors() stingray.ProceduralMesh.set_bounding_box() stingray.Profiler.record_statistics() stingray.Quaternion() stingray.Quaternion.axis_angle() stingray.Quaternion.look() stingray.Quaternion.rotate() stingray.Raycast.cast() stingray.Replay.record_debug_line() stingray.Replay.record_world_debug_text() stingray.ScatterSystem.make_observer() stingray.ScatterSystem.move_observer() stingray.ScatterSystem.spawn() stingray.SceneGraphComponent.set_local_position() stingray.SceneGraphComponent.set_local_scale() stingray.SceneGraphNode.set_local_position() stingray.Script.serialize() stingray.ShadingEnvironment.set_array_vector2() stingray.ShadingEnvironment.set_array_vector3() stingray.ShadingEnvironment.set_vector2() stingray.ShadingEnvironment.set_vector3() stingray.SteamVR.set_tracking_space() stingray.TerrainDecoration.create_observer() stingray.TerrainDecoration.move_observer() stingray.TransformComponent.link() stingray.TransformComponent.link_to_scene_graph() stingray.TransformComponent.set_local_position() stingray.TransformComponent.set_local_scale() stingray.Unit.animation_set_constraint_target() stingray.Unit.create_custom_joint() stingray.Unit.mesh_pick_raycast() stingray.Unit.mover_fits_at() stingray.Unit.query_material() stingray.Unit.set_local_position() stingray.Unit.set_local_scale() stingray.Unit.teleport_local_position() stingray.Unit.teleport_local_scale() stingray.UnitSynchronizer.spawn_unit() stingray.Vector3Box() stingray.Vector3Box.store() stingray.VectorField.add() stingray.VectorField.change() stingray.VectorField.evaluate() stingray.VectorField.evaluate() stingray.Vehicle.add_force() stingray.World.create_particles() stingray.World.load_level() stingray.World.load_level_with_object_sets() stingray.World.move_particles() stingray.World.set_particles_variable() stingray.World.spawn_unit() stingray.WwiseWorld.add_soundscape_unit_source() stingray.WwiseWorld.make_auto_source() stingray.WwiseWorld.make_manual_source() stingray.WwiseWorld.set_source_position() stingray.WwiseWorld.trigger_event()
	Math

Related help topics

	Release Notes > Stingray 1.1 Release Notes
	Building Levels > Organize level objects in categories
	Lighting and Rendering > Lighting > Light sources > Change light source properties
	Creating Gameplay > Scripting with Lua > Starting Lua from scratch: using a custom boot script > Example Boot Script
	Creating Gameplay > Scripting with Lua > Starting Lua from scratch: using a custom boot script > Loading the current level for testing
	Creating Gameplay > Scripting with Lua > Using the Lua API > Object lifetimes and userdata binding
	Creating Gameplay > Scripting with Lua > Using the Lua API > Storing data in Lua objects
	Creating Gameplay > AI and pathfinding > Integrate Gameware Navigation into your game runtime
	Playtesting Your Game > Optimize memory usage

Data Members

x : number The extent of the vector along the X axis.

y : number The extent of the vector along the Y axis.

z : number The extent of the vector along the Z axis.

Functions

add ( vector_a, vector_b ) : stingray.Vector3 Adds the two specified vectors together, and returns the resulting vector.

Parameters

vector_a :	stingray.Vector3	The first vector to add.
vector_b :	stingray.Vector3	The second vector to add.

Returns

stingray.Vector3

The sum of the two input vectors.

backward ( ) : stingray.Vector3 Returns the backward (negative Y) axis.

Parameters

This function does not accept any parameters.

Returns

stingray.Vector3

The backward vector.

base ( index ) : stingray.Vector3 Returns the base vector with the specified index.

Parameters

index :

integer

The index of the base vector to return. Use 0 for the X axis, use 1 for the Y axis, and use 2 for the Z axis.

Returns

stingray.Vector3

The base vector with the specified index.

cross ( vector_a, vector_b ) : stingray.Vector3 Returns the cross product of the two specified vectors.

Parameters

vector_a :	stingray.Vector3	The first vector.
vector_b :	stingray.Vector3	The second vector.

Returns

stingray.Vector3

The cross product.

Related sample code

Vehicle template: /vehicle_follow_cam.lua Creating meshes procedurally

distance ( vector_a, vector_b ) : number Returns the distance between two specified points.

Parameters

vector_a :	stingray.Vector3	The first point.
vector_b :	stingray.Vector3	The second point.

Returns

number

The scalar distance between vector_a and vector_b.

distance_squared ( vector_a, vector_b ) : number Returns the square of the distance between two specified points.

Parameters

vector_a :	stingray.Vector3	The first point.
vector_b :	stingray.Vector3	The second point.

Returns

number

The square of the distance between vector_a and vector_b.

divide ( vector, factor ) : stingray.Vector3 Divides the specified vector by a scalar value, and returns the resulting vector.

Parameters

vector :	stingray.Vector3	The vector to divide.
factor :	number	A scalar value to divide into the vector.

Returns

stingray.Vector3

The quotient of the input vector and the scalar value.

divide_elements ( vector_a, vector_b ) : stingray.Vector3 Divides each element of vector_a by the corresponding element of vector_b, and returns the resulting vector.

Parameters

vector_a :	stingray.Vector3	The vector to be divided.
vector_b :	stingray.Vector3	The vector to divide into vector_a.

Returns

stingray.Vector3

The quotient of the two input vectors.

dot ( vector_a, vector_b ) : number Returns the dot product of the two specified vectors.

Parameters

vector_a :	stingray.Vector3	The first vector.
vector_b :	stingray.Vector3	The second vector.

Returns

number

The dot product.

down ( ) : stingray.Vector3 Returns the down (negative Z) axis.

Parameters

This function does not accept any parameters.

Returns

stingray.Vector3

The down vector.

element ( vector, index ) : number Returns the value stored at the specified index within the vector.

Parameters

vector :	stingray.Vector3	The vector whose component will be returned.
index :	integer	The index of the component to return. Use 1 for the X component, 2 for the Y component, or 3 for the Z component.

Returns

number

The value of the element at the specified index.

equal ( vector_a, vector_b ) : boolean Indicates whether or not the two vectors are identical.

Parameters

vector_a :	stingray.Vector3	The first vector to compare.
vector_b :	stingray.Vector3	The second vector to compare.

Returns

boolean

Returns true if the two vectors are identical, or false otherwise.

Related sample code

Appkit: /unit_controller.lua

forward ( ) : stingray.Vector3 Returns the forward (Y) axis.

Parameters

This function does not accept any parameters.

Returns

stingray.Vector3

The forward vector.

is_valid ( vector ) : boolean Indicates whether or not the vector is composed entirely of valid values.

Parameters

vector :

stingray.Vector3

The vector to be validated.

Returns

boolean

Returns true if all components of the vector are valid numbers, or false if any component is #NaN or #INF.

left ( ) : stingray.Vector3 Returns the left (negative X) axis.

Parameters

This function does not accept any parameters.

Returns

stingray.Vector3

The left vector.

length ( vector ) : number Returns the scalar length of the specified vector.

Parameters

vector :

stingray.Vector3

The vector whose length will be returned.

Returns

number

The length of the vector.

Related sample code

Creating meshes procedurally

lerp ( vector_a, vector_b, ratio ) : stingray.Vector3 Produces a new vector by interpolating linearly between the two specified vectors with the specified ratio.

Parameters

vector_a :	stingray.Vector3	The first vector.
vector_b :	stingray.Vector3	The second vector.
ratio :	number	The interpolation ratio, or weight. May be any value between 0 and 1 inclusive. Values closer to 0 produce vectors closer to vector_a; values closer to 1 produce vectors closer to vector_b.

Returns

stingray.Vector3

The resulting vector.

make_axes ( vector ) : stingray.Vector3, stingray.Vector3 Given the specified vector, returns two orthogonal vectors Y and Z such that the three vectors together form an orthonormal basis, which can be used as an orthogonal coordinate system.

Parameters

vector :

stingray.Vector3

The starting X vector.

Returns

stingray.Vector3	The Y vector orthogonal to vector and to the Z vector.
stingray.Vector3	The Z vector orthogonal to vector and to the Y vector.

max ( vector_a, vector_b ) : stingray.Vector3 Returns a vector that contains the largest value for each component from the two specified vectors.

Parameters

vector_a :	stingray.Vector3	The first vector.
vector_b :	stingray.Vector3	The second vector.

Returns

stingray.Vector3

The resulting vector.

min ( vector_a, vector_b ) : stingray.Vector3 Returns a vector that contains the smallest value for each component from the two specified vectors.

Parameters

vector_a :	stingray.Vector3	The first vector.
vector_b :	stingray.Vector3	The second vector.

Returns

stingray.Vector3

The resulting vector.

multiply ( vector, factor ) : stingray.Vector3 Multiplies the specified vector by a scalar value, and returns the resulting vector.

Parameters

vector :	stingray.Vector3	The vector to multiply.
factor :	number	A scalar value to multiply with the vector.

Returns

stingray.Vector3

The product of the input vector and the scalar value.

multiply_elements ( vector_a, vector_b ) : stingray.Vector3 Multiplies each element of vector_a by the corresponding element of vector_b, and returns the resulting vector.

Parameters

vector_a :	stingray.Vector3	The first vector to multiply.
vector_b :	stingray.Vector3	The second vector to multiply.

Returns

stingray.Vector3

The product of the two input vectors.

Related sample code

Creating meshes procedurally

normalize ( vector ) : stingray.Vector3 Normalizes the specified vector -- i.e. converts its scalar length to 1 -- and returns the result.

Parameters

vector :

stingray.Vector3

The vector to be normalized.

Returns

stingray.Vector3

The normalized vector.

Related sample code

Vehicle template: /vehicle_follow_cam.lua Creating meshes procedurally Picking a unit with the mouse

right ( ) : stingray.Vector3 Returns the right (X) axis.

Parameters

This function does not accept any parameters.

Returns

stingray.Vector3

The right vector.

set_element ( vector, index, value ) Sets the specified index within the vector to the specified value.

Parameters

vector :	stingray.Vector3	The vector whose component will be set.
index :	integer	The index of the component to set. Use 1 for the X component, 2 for the Y component, or 3 for the Z component.
value :	number	The value to set at the specified index.

Returns

This function does not return any values.

set_x ( vector, value ) Sets the value of the vector's X component.

Parameters

vector :	stingray.Vector3	The vector whose component will be set.
value :	number	The new value for the X component.

Returns

This function does not return any values.

set_xyz ( vector, x, y, z ) Sets the values of the vector's X, Y and Z components.

Parameters

vector :	stingray.Vector3	The vector whose components will be set.
x :	number	The new value for the X component.
y :	number	The new value for the Y component.
z :	number	The new value for the Z component.

Returns

This function does not return any values.

set_y ( vector, value ) Sets the value of the vector's Y component.

Parameters

vector :	stingray.Vector3	The vector whose component will be set.
value :	number	The new value for the Y component.

Returns

This function does not return any values.

set_z ( vector, value ) Sets the value of the vector's Z component.

Parameters

vector :	stingray.Vector3	The vector whose component will be set.
value :	number	The new value for the Z component.

Returns

This function does not return any values.

subtract ( vector_a, vector_b ) : stingray.Vector3 Subtracts vector_b from vector_a, and returns the resulting vector.

Parameters

vector_a :	stingray.Vector3	The starting vector.
vector_b :	stingray.Vector3	The vector that will be subtracted.

Returns

stingray.Vector3

The result of the subtraction.

to_elements ( vector ) : number, number, number Decomposes the specified vector into its component values.

Parameters

vector :

stingray.Vector3

The vector to be broken down into its components.

Returns

number	The X component of the vector.
number	The Y component of the vector.
number	The Z component of the vector.

to_string ( vector ) : string Returns a string representation of the specified vector.

Parameters

vector :

stingray.Vector3

The vector to return as a string.

Returns

string

The string representation.

Use this function only for debugging purposes; do not attempt to save the string and read it back into a new vector. Use a Vector3Box to save vectors across multiple frames.

up ( ) : stingray.Vector3 Returns the up (Z) axis.

Parameters

This function does not accept any parameters.

Returns

stingray.Vector3

The up vector.

Related sample code

Oculus VR template: /project.lua

x ( vector ) : number Returns the value of the vector's X component.

Parameters

vector :

stingray.Vector3

The vector whose component will be returned.

Returns

number

The value of the X component.

y ( vector ) : number Returns the value of the vector's Y component.

Parameters

vector :

stingray.Vector3

The vector whose component will be returned.

Returns

number

The value of the Y component.

z ( vector ) : number Returns the value of the vector's Z component.

Parameters

vector :

stingray.Vector3

The vector whose component will be returned.

Returns

number

The value of the Z component.

zero ( ) : stingray.Vector3 Returns a new vector with all values initialized to zero.

Parameters

This function does not accept any parameters.

Returns

stingray.Vector3

The zero vector.

Related sample code

Appkit: /unit_controller.lua Vehicle template: /vehicle_follow_cam.lua