vectors

docs.globals.vectors

field signature:
vectors 
 Method Property Fluent Description Representation
Field Type a VectorsAPI VectorsAPI 
   
VectorsAPI.vec 
docs.vectorsapi.vec
overload 1:
                        
vectors.vec(x, y)  
 Method Property Fluent Description Representation
x accepts a Number Number 
   
y accepts a Number Number 
   
Return Value a Vector2 Vector2 
   
overload 2:
                        
vectors.vec(x, y, z)  
 Method Property Fluent Description Representation
x accepts a Number Number 
   
y accepts a Number Number 
   
z accepts a Number Number 
   
Return Value a Vector3 Vector3 
   
overload 3:
                        
vectors.vec(x, y, z, w)  
 Method Property Fluent Description Representation
x accepts a Number Number 
   
y accepts a Number Number 
   
z accepts a Number Number 
   
w accepts a Number Number 
   
Return Value a Vector4 Vector4 
   
overload 4:
                        
vectors.vec(x, y, z, w, t)  
 typings.2002444082Method Property Fluent Description Representation
x accepts a Number Number 
   
y accepts a Number Number 
   
z accepts a Number Number 
   
w accepts a Number Number 
   
t accepts a Number Number 
   
Return Value   
 
overload 5:
                        
vectors.vec(x, y, z, w, t, h)  
 typings.2002444083Method Property Fluent Description Representation
x accepts a Number Number 
   
y accepts a Number Number 
   
z accepts a Number Number 
   
w accepts a Number Number 
   
t accepts a Number Number 
   
h accepts a Number Number 
   
Return Value   
 
VectorsAPI.vec6 
docs.vectorsapi.vec6
overload 1:
                        
vectors.vec6(x, y, z, w, t, h)  
 typings.2002444083Method Property Fluent Description Representation
x accepts a Number Number 
   
y accepts a Number Number 
   
z accepts a Number Number 
   
w accepts a Number Number 
   
t accepts a Number Number 
   
h accepts a Number Number 
   
Return Value   
 
VectorsAPI.vec5 
docs.vectorsapi.vec5
overload 1:
                        
vectors.vec5(x, y, z, w, t)  
 typings.2002444082Method Property Fluent Description Representation
x accepts a Number Number 
   
y accepts a Number Number 
   
z accepts a Number Number 
   
w accepts a Number Number 
   
t accepts a Number Number 
   
Return Value   
 
VectorsAPI.rotateAroundAxis 
docs.vectorsapi.rotatearoundaxis
overload 1:
                        
vectors.rotateAroundAxis(angle, vec, axis)  
 Method Property Fluent Description Representation
angle accepts a Number Number 
   
vec accepts a Vector3 Vector3 
   
axis accepts a Vector3 Vector3 
   
Return Value a Vector3 Vector3 
   
overload 2:
                        
vectors.rotateAroundAxis(angle, x, y, z, axis)  
 Method Property Fluent Description Representation
angle accepts a Number Number 
   
x accepts a Number Number 
   
y accepts a Number Number 
   
z accepts a Number Number 
   
axis accepts a Vector3 Vector3 
   
Return Value a Vector3 Vector3 
   
overload 3:
                        
vectors.rotateAroundAxis(angle, vec, axisX, axisY, axisZ)  
 Method Property Fluent Description Representation
angle accepts a Number Number 
   
vec accepts a Vector3 Vector3 
   
axisX accepts a Number Number 
   
axisY accepts a Number Number 
   
axisZ accepts a Number Number 
   
Return Value a Vector3 Vector3 
   
overload 4:
                        
vectors.rotateAroundAxis(angle, x, y, z, axisX, axisY, axisZ)  
 Method Property Fluent Description Representation
angle accepts a Number Number 
   
x accepts a Number Number 
   
y accepts a Number Number 
   
z accepts a Number Number 
   
axisX accepts a Number Number 
   
axisY accepts a Number Number 
   
axisZ accepts a Number Number 
   
Return Value a Vector3 Vector3 
   
VectorsAPI.hexToRGB 
docs.vectorsapi.hextorgb
overload 1:
                        
vectors.hexToRGB(hex)  
 Method Property Fluent Description Representation
hex accepts a String String 
   
Return Value a Vector3 Vector3 
   
VectorsAPI.worldToScreenSpace 
docs.vectorsapi.worldtoscreenspace
overload 1:
                        
vectors.worldToScreenSpace(vec)  
 Method Property Fluent Description Representation
vec accepts a Vector3 Vector3 
   
Return Value a Vector4 Vector4 
   
overload 2:
                        
vectors.worldToScreenSpace(x, y, z)  
 Method Property Fluent Description Representation
x accepts a Number Number 
   
y accepts a Number Number 
   
z accepts a Number Number 
   
Return Value a Vector4 Vector4 
   
VectorsAPI.toCameraSpace 
docs.vectorsapi.tocameraspace
overload 1:
                        
vectors.toCameraSpace(vec)  
 Method Property Fluent Description Representation
vec accepts a Vector3 Vector3 
   
Return Value a Vector3 Vector3 
   
overload 2:
                        
vectors.toCameraSpace(x, y, z)  
 Method Property Fluent Description Representation
x accepts a Number Number 
   
y accepts a Number Number 
   
z accepts a Number Number 
   
Return Value a Vector3 Vector3 
   
VectorsAPI.vec4 
docs.vectorsapi.vec4
overload 1:
                        
vectors.vec4(x, y, z, w)  
 Method Property Fluent Description Representation
x accepts a Number Number 
   
y accepts a Number Number 
   
z accepts a Number Number 
   
w accepts a Number Number 
   
Return Value a Vector4 Vector4 
   
VectorsAPI.rgbToINT 
docs.vectorsapi.rgbtoint
overload 1:
                        
vectors.rgbToINT(rgb)  
 Method Property Fluent Description Representation
rgb accepts a Vector3 Vector3 
   
Return Value an Integer Integer 
   
overload 2:
                        
vectors.rgbToINT(r, g, b)  
 Method Property Fluent Description Representation
r accepts a Number Number 
   
g accepts a Number Number 
   
b accepts a Number Number 
   
Return Value an Integer Integer 
   
VectorsAPI.intToRGB 
docs.vectorsapi.inttorgb
overload 1:
                        
vectors.intToRGB(color)  
 Method Property Fluent Description Representation
color accepts an Integer Integer 
   
Return Value a Vector3 Vector3 
   
VectorsAPI.hsvToRGB 
docs.vectorsapi.hsvtorgb
overload 1:
                        
vectors.hsvToRGB(hsv)  
 Method Property Fluent Description Representation
hsv accepts a Vector3 Vector3 
   
Return Value a Vector3 Vector3 
   
overload 2:
                        
vectors.hsvToRGB(h, s, v)  
 Method Property Fluent Description Representation
h accepts a Number Number 
   
s accepts a Number Number 
   
v accepts a Number Number 
   
Return Value a Vector3 Vector3 
   
VectorsAPI.rgbToHSV 
docs.vectorsapi.rgbtohsv
overload 1:
                        
vectors.rgbToHSV(rgb)  
 Method Property Fluent Description Representation
rgb accepts a Vector3 Vector3 
   
Return Value a Vector3 Vector3 
   
overload 2:
                        
vectors.rgbToHSV(r, g, b)  
 Method Property Fluent Description Representation
r accepts a Number Number 
   
g accepts a Number Number 
   
b accepts a Number Number 
   
Return Value a Vector3 Vector3 
   
VectorsAPI.rainbow 
docs.vectorsapi.rainbow
overload 1:
                        
vectors.rainbow(speed)  
 Method Property Fluent Description Representation
speed accepts a Number Number 
   
Return Value a Vector3 Vector3 
   
overload 2:
                        
vectors.rainbow(speed, offset)  
 Method Property Fluent Description Representation
speed accepts a Number Number 
   
offset accepts a Number Number 
   
Return Value a Vector3 Vector3 
   
overload 3:
                        
vectors.rainbow(speed, offset, saturation, light)  
 Method Property Fluent Description Representation
speed accepts a Number Number 
   
offset accepts a Number Number 
   
saturation accepts a Number Number 
   
light accepts a Number Number 
   
Return Value a Vector3 Vector3 
   
VectorsAPI.vec2 
docs.vectorsapi.vec2
overload 1:
                        
vectors.vec2(x, y)  
 Method Property Fluent Description Representation
x accepts a Number Number 
   
y accepts a Number Number 
   
Return Value a Vector2 Vector2 
   
VectorsAPI.vec3 
docs.vectorsapi.vec3
overload 1:
                        
vectors.vec3(x, y, z)  
 Method Property Fluent Description Representation
x accepts a Number Number 
   
y accepts a Number Number 
   
z accepts a Number Number 
   
Return Value a Vector3 Vector3

Global Objects

Miscellaneous Types

action_wheel

world

keybind

model

math

event

nameplate

entity

misc

Miscellaneous Enums

vectors

VectorsAPI.vec

VectorsAPI.vec6

VectorsAPI.vec5

VectorsAPI.rotateAroundAxis

VectorsAPI.hexToRGB

VectorsAPI.worldToScreenSpace

VectorsAPI.toCameraSpace

VectorsAPI.vec4

VectorsAPI.rgbToINT

VectorsAPI.intToRGB

VectorsAPI.hsvToRGB

VectorsAPI.rgbToHSV

VectorsAPI.rainbow

VectorsAPI.vec2

VectorsAPI.vec3

Method Property	Fluent Description	Representation
x accepts	a Number	`Number`
y accepts	a Number	`Number`
Return Value	a Vector2	`Vector2`

Method Property	Fluent Description	Representation
angle accepts	a Number	`Number`
vec accepts	a Vector3	`Vector3`
axis accepts	a Vector3	`Vector3`
Return Value	a Vector3	`Vector3`

Method Property	Fluent Description	Representation
rgb accepts	a Vector3	`Vector3`
Return Value	an Integer	`Integer`

Method Property	Fluent Description	Representation
r accepts	a Number	`Number`
g accepts	a Number	`Number`
b accepts	a Number	`Number`
Return Value	an Integer	`Integer`

Method Property	Fluent Description	Representation
color accepts	an Integer	`Integer`
Return Value	a Vector3	`Vector3`

Method Property	Fluent Description	Representation
h accepts	a Number	`Number`
s accepts	a Number	`Number`
v accepts	a Number	`Number`
Return Value	a Vector3	`Vector3`

Method Property	Fluent Description	Representation
speed accepts	a Number	`Number`
offset accepts	a Number	`Number`
Return Value	a Vector3	`Vector3`