listFiles
action_wheel
Action
BlockRaycastTypes A vector that holds 3 numbers
Can be created using functions in the "vectors" api 
Adds the given vector or values to this one, and returns self for chaining
overload 1:
Vector3.add(vec: Vector3): Vector3 | Method Property | Fluent Description | Representation |
|---|---|---|
| vec accepts | typings.2002444080||
| Return Value | typings.2002444080
overload 2:
Vector3.add(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
Calls the given function on each element of this vector, and sets the values of the vector to the returns
The current index and its value is given as arguments of the function
Returns self for chaining
overload 1:
Vector3.applyFunc(func: (Number, Integer) -> Number): Vector3 | Method Property | Fluent Description | Representation |
|---|---|---|
| func accepts | typings.1623631144||
| Return Value | typings.2002444080
Returns the augmented form of this vector
The augmented form is a Vector of the same length + 1
The new axis will have the given value, or 1 when it is not specified
overload 1:
Vector3.augmented(): Vector4 | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.2002444081
overload 2:
Vector3.augmented(value: Number): Vector4 | Method Property | Fluent Description | Representation |
|---|---|---|
| value accepts | typings.-1950496919||
| Return Value | typings.2002444081
Returns a copy of this vector with its values rounded up
overload 1:
Vector3.ceil(): Vector3 | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.2002444080
Modifies this vector so that its length is between minLength and maxLength
If the vector has length zero, it is unmodified
Returns self for chaining
overload 1:
Vector3.clampLength(minLength: Number, maxLength: Number): Vector3 | Method Property | Fluent Description | Representation |
|---|---|---|
| minLength accepts | typings.-1950496919||
| maxLength accepts | typings.-1950496919||
| Return Value | typings.2002444080
Returns a modified copy of this vector, with its length clamped from minLength to maxLength
If the vector has length zero, then the copy does too
overload 1:
Vector3.clamped(minLength: Number, maxLength: Number): Vector3 | Method Property | Fluent Description | Representation |
|---|---|---|
| minLength accepts | typings.-1950496919||
| maxLength accepts | typings.-1950496919||
| Return Value | typings.2002444080
Creates and returns a copy of this vector
overload 1:
Vector3.copy(): Vector3 | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.2002444080
Sets this vector to the cross product of itself and the other vector
Returns self for chaining
overload 1:
Vector3.cross(other: Vector3): Vector3 | Method Property | Fluent Description | Representation |
|---|---|---|
| other accepts | typings.2002444080||
| Return Value | typings.2002444080
Returns a new vector which is the cross product of this and the other one
overload 1:
Vector3.crossed(other: Vector3): Vector3 | Method Property | Fluent Description | Representation |
|---|---|---|
| other accepts | typings.2002444080||
| Return Value | typings.2002444080
Divides this vector by the given vector or values, and returns self for chaining
overload 1:
Vector3.div(vec: Vector3): Vector3 | Method Property | Fluent Description | Representation |
|---|---|---|
| vec accepts | typings.2002444080||
| Return Value | typings.2002444080
overload 2:
Vector3.div(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
Returns the dot product of this vector with the other
overload 1:
Vector3.dot(vec: Vector3): Number | Method Property | Fluent Description | Representation |
|---|---|---|
| vec accepts | typings.2002444080||
| Return Value | typings.-1950496919
Returns a copy of this vector with its values rounded down
overload 1:
Vector3.floor(): Vector3 | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.2002444080
Returns the length of this vector
overload 1:
Vector3.length(): Number | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1950496919
Returns the length of this vector squared
Suitable when you only care about relative lengths, because it avoids a square root
overload 1:
Vector3.lengthSquared(): Number | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1950496919
Multiplies the given vector or values into this one, and returns self for chaining
overload 1:
Vector3.mul(vec: Vector3): Vector3 | Method Property | Fluent Description | Representation |
|---|---|---|
| vec accepts | typings.2002444080||
| Return Value | typings.2002444080
overload 2:
Vector3.mul(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
Modifies this vector so that its length is 1 unless its length was originally 0
Returns self for chaining
overload 1:
Vector3.normalize(): Vector3 | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.2002444080
Returns a copy of this vector with length 1 unless its length was originally 0
overload 1:
Vector3.normalized(): Vector3 | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.2002444080
Offsets this vector by the given factor, adding the factor to all components, and returns self for chaining
overload 1:
Vector3.offset(factor: Number): Vector3 | Method Property | Fluent Description | Representation |
|---|---|---|
| factor accepts | typings.-1950496919||
| Return Value | typings.2002444080
Reduces this vector modulo the given vector or values, and returns self for chaining
overload 1:
Vector3.reduce(vec: Vector3): Vector3 | Method Property | Fluent Description | Representation |
|---|---|---|
| vec accepts | typings.2002444080||
| Return Value | typings.2002444080
overload 2:
Vector3.reduce(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
Resets this vector back to being all zeroes, and returns itself for chaining
overload 1:
Vector3.reset(): Vector3 | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.2002444080
Scales this vector by the given factor, and returns self for chaining
overload 1:
Vector3.scale(factor: Number): Vector3 | Method Property | Fluent Description | Representation |
|---|---|---|
| factor accepts | typings.-1950496919||
| Return Value | typings.2002444080
Sets this vector to have the given values
Nil values are treated as zero
Returns self for chaining
overload 1:
Vector3.set(vec: Vector3): Vector3 | Method Property | Fluent Description | Representation |
|---|---|---|
| vec accepts | typings.2002444080||
| Return Value | typings.2002444080
overload 2:
Vector3.set(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
Subtracts the given vector or values from this one, and returns self for chaining
overload 1:
Vector3.sub(vec: Vector3): Vector3 | Method Property | Fluent Description | Representation |
|---|---|---|
| vec accepts | typings.2002444080||
| Return Value | typings.2002444080
overload 2:
Vector3.sub(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
Returns a copy of this vector, in degrees
overload 1:
Vector3.toDeg(): Vector3 | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.2002444080
Returns a copy of this vector, in radians
overload 1:
Vector3.toRad(): Vector3 | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.2002444080
Transforms this vector by the given matrix, and returns self for chaining
overload 1:
Vector3.transform(mat: Matrix3): Vector3 | Method Property | Fluent Description | Representation |
|---|---|---|
| mat accepts | typings.-1789003662||
| Return Value | typings.2002444080
Returns this vector's values as separate numbers
overload 1:
Vector3.unpack(): Varargs | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1901216868
The first coordinate of this vector
Can also be gotten with the indices "r" and [1]
field signature:
Vector3.x: Number | Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | typings.-1950496919
The second coordinate of this vector
Can also be gotten with the indices "g" and [2]
field signature:
Vector3.y: Number | Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | typings.-1950496919
The third coordinate of this vector
Can also be gotten with the indices "b" and [3]
field signature:
Vector3.z: Number | Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | typings.-1950496919