listFiles
action_wheel
Action
BlockRaycastTypes A global API which provides functions dedicated to creating and otherwise manipulating vectors
Accessed using the name "vectors" 
Converts a pitch/yaw angle (in degrees) into a direction vector
overload 1:
VectorsAPI.angleToDir(vec: Vector2): Vector3 | Method Property | Fluent Description | Representation |
|---|---|---|
| vec accepts | typings.2002444079||
| Return Value | typings.2002444080
overload 2:
VectorsAPI.angleToDir(pitch: Number, yaw: Number): Vector3 | Method Property | Fluent Description | Representation |
|---|---|---|
| pitch accepts | typings.-1950496919||
| yaw accepts | typings.-1950496919||
| Return Value | typings.2002444080
Parses a Hex string color into an RGB format vector
The hex "#" is optional, and it can have any length, however only the first 6 hex digits are evaluated, short hex (length 3) is also supported
For example, "#42" is the same as "420000", and "F0B" is the same as "FF00BB"
overload 1:
VectorsAPI.hexToRGB(hex: String): Vector3 | Method Property | Fluent Description | Representation |
|---|---|---|
| hex accepts | typings.-1808118735||
| Return Value | typings.2002444080
Converts the given color from HSV format to RGB format
overload 1:
VectorsAPI.hsvToRGB(hsv: Vector3): Vector3 | Method Property | Fluent Description | Representation |
|---|---|---|
| hsv accepts | typings.2002444080||
| Return Value | typings.2002444080
overload 2:
VectorsAPI.hsvToRGB(h: Number, s: Number, v: Number): Vector3 | Method Property | Fluent Description | Representation |
|---|---|---|
| h accepts | typings.-1950496919||
| s accepts | typings.-1950496919||
| v accepts | typings.-1950496919||
| Return Value | typings.2002444080
Converts the given color from Integer format to RGB format
overload 1:
VectorsAPI.intToRGB(color: Integer): Vector3 | Method Property | Fluent Description | Representation |
|---|---|---|
| color accepts | typings.-672261858||
| Return Value | typings.2002444080
Converts the given color from RGB format to HSV format
overload 1:
VectorsAPI.rgbToHSV(rgb: Vector3): Vector3 | Method Property | Fluent Description | Representation |
|---|---|---|
| rgb accepts | typings.2002444080||
| Return Value | typings.2002444080
overload 2:
VectorsAPI.rgbToHSV(r: Number, g: Number, b: Number): Vector3 | Method Property | Fluent Description | Representation |
|---|---|---|
| r accepts | typings.-1950496919||
| g accepts | typings.-1950496919||
| b accepts | typings.-1950496919||
| Return Value | typings.2002444080
Converts the given color from RGB format to Hex format
The "#" is not included on the return value
overload 1:
VectorsAPI.rgbToHex(rgb: Vector3): String | Method Property | Fluent Description | Representation |
|---|---|---|
| rgb accepts | typings.2002444080||
| Return Value | typings.-1808118735
overload 2:
VectorsAPI.rgbToHex(r: Number, g: Number, b: Number): String | Method Property | Fluent Description | Representation |
|---|---|---|
| r accepts | typings.-1950496919||
| g accepts | typings.-1950496919||
| b accepts | typings.-1950496919||
| Return Value | typings.-1808118735
Converts the given color from RGB format to Integer format
overload 1:
VectorsAPI.rgbToInt(rgb: Vector3): Integer | Method Property | Fluent Description | Representation |
|---|---|---|
| rgb accepts | typings.2002444080||
| Return Value | typings.-672261858
overload 2:
VectorsAPI.rgbToInt(r: Number, g: Number, b: Number): Integer | Method Property | Fluent Description | Representation |
|---|---|---|
| r accepts | typings.-1950496919||
| g accepts | typings.-1950496919||
| b accepts | typings.-1950496919||
| Return Value | typings.-672261858
Rotates a vector relative to a rotation vector
overload 1:
VectorsAPI.rotateAroundAxis(angle: Number, vec: Vector3, axis: Vector3): Vector3 | Method Property | Fluent Description | Representation |
|---|---|---|
| angle accepts | typings.-1950496919||
| vec accepts | typings.2002444080||
| axis accepts | typings.2002444080||
| Return Value | typings.2002444080
overload 2:
VectorsAPI.rotateAroundAxis(angle: Number, x: Number, y: Number, z: Number, axis: Vector3): Vector3 | Method Property | Fluent Description | Representation |
|---|---|---|
| angle accepts | typings.-1950496919||
| x accepts | typings.-1950496919||
| y accepts | typings.-1950496919||
| z accepts | typings.-1950496919||
| axis accepts | typings.2002444080||
| Return Value | typings.2002444080
overload 3:
VectorsAPI.rotateAroundAxis(angle: Number, vec: Vector3, axisX: Number, axisY: Number, axisZ: Number): Vector3 | Method Property | Fluent Description | Representation |
|---|---|---|
| angle accepts | typings.-1950496919||
| vec accepts | typings.2002444080||
| axisX accepts | typings.-1950496919||
| axisY accepts | typings.-1950496919||
| axisZ accepts | typings.-1950496919||
| Return Value | typings.2002444080
overload 4:
VectorsAPI.rotateAroundAxis(angle: Number, x: Number, y: Number, z: Number, axisX: Number, axisY: Number, axisZ: Number): Vector3 | Method Property | Fluent Description | Representation |
|---|---|---|
| angle accepts | typings.-1950496919||
| x accepts | typings.-1950496919||
| y accepts | typings.-1950496919||
| z accepts | typings.-1950496919||
| axisX accepts | typings.-1950496919||
| axisY accepts | typings.-1950496919||
| axisZ accepts | typings.-1950496919||
| Return Value | typings.2002444080
Converts a position in the world into a position relative to the viewer's camera
overload 1:
VectorsAPI.toCameraSpace(vec: Vector3): Vector3 | Method Property | Fluent Description | Representation |
|---|---|---|
| vec accepts | typings.2002444080||
| Return Value | typings.2002444080
overload 2:
VectorsAPI.toCameraSpace(x: Number, y: Number, z: Number): Vector3 | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | typings.-1950496919||
| y accepts | typings.-1950496919||
| z accepts | typings.-1950496919||
| Return Value | typings.2002444080
Creates and returns a vector of the appropriate size to hold the arguments passed in
For example; if you call vec(3, 4, 0, 2), then the function will return a Vector4 containing those values
There is a global alias "vec" for this function, meaning the "vectors." can be omitted
overload 1:
VectorsAPI.vec(x: Number, y: Number): Vector2 | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | typings.-1950496919||
| y accepts | typings.-1950496919||
| Return Value | typings.2002444079
overload 2:
VectorsAPI.vec(x: Number, y: Number, z: Number): Vector3 | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | typings.-1950496919||
| y accepts | typings.-1950496919||
| z accepts | typings.-1950496919||
| Return Value | typings.2002444080
overload 3:
VectorsAPI.vec(x: Number, y: Number, z: Number, w: Number): Vector4 | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | typings.-1950496919||
| y accepts | typings.-1950496919||
| z accepts | typings.-1950496919||
| w accepts | typings.-1950496919||
| Return Value | typings.2002444081
Creates and returns a Vector2 with the given values
Nil values become zero
overload 1:
VectorsAPI.vec2(x: Number, y: Number): Vector2 | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | typings.-1950496919||
| y accepts | typings.-1950496919||
| Return Value | typings.2002444079
Creates and returns a Vector3 with the given values
Nil values become zero
overload 1:
VectorsAPI.vec3(x: Number, y: Number, z: Number): Vector3 | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | typings.-1950496919||
| y accepts | typings.-1950496919||
| z accepts | typings.-1950496919||
| Return Value | typings.2002444080
Creates and returns a Vector4 with the given values
Nil values become zero
overload 1:
VectorsAPI.vec4(x: Number, y: Number, z: Number, w: Number): Vector4 | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | typings.-1950496919||
| y accepts | typings.-1950496919||
| z accepts | typings.-1950496919||
| w accepts | typings.-1950496919||
| Return Value | typings.2002444081
Converts a position in the world into a position relative to the viewer's screen
overload 1:
VectorsAPI.worldToScreenSpace(vec: Vector3): Vector4 | Method Property | Fluent Description | Representation |
|---|---|---|
| vec accepts | typings.2002444080||
| Return Value | typings.2002444081
overload 2:
VectorsAPI.worldToScreenSpace(x: Number, y: Number, z: Number): Vector4 | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | typings.-1950496919||
| y accepts | typings.-1950496919||
| z accepts | typings.-1950496919||
| Return Value | typings.2002444081