Vector3

Overview

Description

Vector3 represents a vector used in 3D space that includes x, y, and z coordinates. It is commonly used in 3D rendering, physics calculations, and position computations.

Properties

X

number Represents the X-axis coordinate value.

Code Samples

local position = Vector3.new(10, 5, 8)
print(position.X) -- prints 10

Y

number Represents the Y-axis coordinate value.

Code Samples

local position = Vector3.new(10, 5, 8)
print(position.Y) -- prints 5

Z

number Represents the Z-axis coordinate value.

Code Samples

local position = Vector3.new(10, 5, 8)
print(position.Z) -- prints 8

zero

Vector3 A vector where all axis values are 0. (0, 0, 0)

Code Samples

local zeroVector = Vector3.zero
print(zeroVector) -- prints (0, 0, 0)

one

Vector3 A vector where all axis values equal 1. (1, 1, 1)

Code Samples

local oneVector = Vector3.one
print(oneVector) -- prints (1, 1, 1)

xAxis

Vector3 The unit vector defined in the direction of the X-axis.

Code Samples

local xUnit = Vector3.xAxis
print(xUnit) -- prints (1, 0, 0)

yAxis

Vector3 The unit vector defined in the direction of the Y-axis.

Code Samples

local yUnit = Vector3.yAxis
print(yUnit) -- prints (0, 1, 0)

zAxis

Vector3 The unit vector defined in the direction of the Z-axis.

Code Samples

local zUnit = Vector3.zAxis
print(zUnit) -- prints (0, 0, 1)

Constructors

new

Creates a Vector3 instance with specified x, y, and z coordinates.

Parameters

Parameter	Description
number x	The x-coordinate value
number y	The y-coordinate value
number z	The z-coordinate value

Return

Return	Description
Vector3	A new instance of Vector3

Code Samples

local vector = Vector3.new(1, 2, 3)
print(vector) -- prints (1, 2, 3)

Methods

Unit

Normalizes the vector to produce a unit vector.

Parameters

Return

Return	Description
Vector3	The vector normalized to unit length

Code Samples

local vector = Vector3.new(3, 4, 0)
local unitVector = vector:Unit()
print(unitVector) -- prints (0.6, 0.8, 0.0)

Magnitude

Calculates the magnitude (length) of the vector.

Parameters

None.

Return

Return	Description
number	The magnitude (length) of the vector

Code Samples

local vector = Vector3.new(3, 4, 0)
local magnitude = vector:Magnitude()
print(magnitude) -- prints 5