listFiles
action_wheel
Action
BlockRaycastTypes A task for rendering a single Sprite 
Sets a color multiplier for this sprite
Values are RGBA from 0 to 1
Default values are 1, alpha is optional
overload 1:
SpriteTask.color(rgb: Vector3): SpriteTask | Method Property | Fluent Description | Representation |
|---|---|---|
| rgb accepts | typings.2002444080||
| Return Value | typings.-769810934
overload 2:
SpriteTask.color(rgba: Vector4): SpriteTask | Method Property | Fluent Description | Representation |
|---|---|---|
| rgba accepts | typings.2002444081||
| Return Value | typings.-769810934
overload 3:
SpriteTask.color(r: Number, g: Number, b: Number, a: Number): SpriteTask | Method Property | Fluent Description | Representation |
|---|---|---|
| r accepts | typings.-1950496919||
| g accepts | typings.-1950496919||
| b accepts | typings.-1950496919||
| a accepts | typings.-1950496919||
| Return Value | typings.-769810934
Sets the texture dimensions, used in UV calculation
overload 1:
SpriteTask.dimensions(dimensions: Vector2): SpriteTask | Method Property | Fluent Description | Representation |
|---|---|---|
| dimensions accepts | typings.2002444079||
| Return Value | typings.-769810934
overload 2:
SpriteTask.dimensions(width: Integer, height: Integer): SpriteTask | Method Property | Fluent Description | Representation |
|---|---|---|
| width accepts | typings.-672261858||
| height accepts | typings.-672261858||
| Return Value | typings.-769810934
Gets the current color multiplier of this sprite
Values are RGBA from 0 to 1
overload 1:
SpriteTask.getColor(): Vector4 | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.2002444081
Returns the texture dimensions, used in UV calculation
overload 1:
SpriteTask.getDimensions(): Vector2 | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.2002444079
Returns the light override value of this task
overload 1:
SpriteTask.getLight(): Vector2 | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.2002444079
Get this task's name
overload 1:
SpriteTask.getName(): String | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1808118735
Recalculates the normal matrix for this render task, based on its current position, rotation, scale, and pivot, then returns this matrix
overload 1:
SpriteTask.getNormalMatrix(): Matrix3 | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1789003662
Returns the normal matrix for this render task
The Raw version of the function is different in that it doesn't recalculate the matrix before returning it
overload 1:
SpriteTask.getNormalMatrixRaw(): Matrix3 | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1789003662
Returns the overlay override value of this task
overload 1:
SpriteTask.getOverlay(): Vector2 | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.2002444079
Gets this task position
overload 1:
SpriteTask.getPos(): Vector3 | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.2002444080
Recalculates the matrix for this render task, based on its current position, rotation, scale, and pivot, then returns this matrix
overload 1:
SpriteTask.getPositionMatrix(): Matrix4 | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1789003661
Returns the position matrix for this render task
The Raw version of the function is different in that it doesn't recalculate the matrix before getting it
overload 1:
SpriteTask.getPositionMatrixRaw(): Matrix4 | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1789003661
Gets the texture UV region
overload 1:
SpriteTask.getRegion(): Vector2 | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.2002444079
Gets the name of the current render type for this sprite
overload 1:
SpriteTask.getRenderType(): String | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1808118735
Gets this task rotation
overload 1:
SpriteTask.getRot(): Vector3 | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.2002444080
Gets this task scale
overload 1:
SpriteTask.getScale(): Vector3 | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.2002444080
Returns the width and height used to render this sprite
overload 1:
SpriteTask.getSize(): Vector2 | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.2002444079
Returns this task's current texture
overload 1:
SpriteTask.getTexture(): String | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1808118735
Gets this texture UV offset
overload 1:
SpriteTask.getUV(): Vector2 | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.2002444079
Get this texture UV offset, in pixels, based on the texture's dimension
overload 1:
SpriteTask.getUVPixels(): Vector2 | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.2002444079
Returns a table with all 4 vertices of this sprite
Changing the values through other functions will reset those vertices
overload 1:
SpriteTask.getVertices(): Table | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.80563118
Checks if this task is visible
overload 1:
SpriteTask.isVisible(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Sets the light override value of this task
Values are given from 0 to 15, indicating the block light and sky light levels you want to use
Passing nil will reset the lighting override for this task
overload 1:
SpriteTask.light(light: Vector2): RenderTask | Method Property | Fluent Description | Representation |
|---|---|---|
| light accepts | typings.2002444079||
| Return Value | typings.-1107424165
overload 2:
SpriteTask.light(blockLight: Integer, skyLight: Integer): RenderTask | Method Property | Fluent Description | Representation |
|---|---|---|
| blockLight accepts | typings.-672261858||
| skyLight accepts | typings.-672261858||
| Return Value | typings.-1107424165
Sets the given matrix as the position matrix for this render task
The normal matrix is automatically calculated as the inverse transpose of this matrix
Calling this DOES NOT CHANGE the values of position, rot, or scale in the render task
If you call setPos() or a similar function, the effects of setMatrix() will be overwritten
overload 1:
SpriteTask.matrix(matrix: Matrix4): RenderTask | Method Property | Fluent Description | Representation |
|---|---|---|
| matrix accepts | typings.-1789003661||
| Return Value | typings.-1107424165
Sets the overlay override value of this task
Values you give are 0 to 15, indicating the white overlay and the damage overlay levels you want to use
Passing nil will reset the overlay override for this task
overload 1:
SpriteTask.overlay(overlay: Vector2): RenderTask | Method Property | Fluent Description | Representation |
|---|---|---|
| overlay accepts | typings.2002444079||
| Return Value | typings.-1107424165
overload 2:
SpriteTask.overlay(whiteOverlay: Integer, hurtOverlay: Integer): RenderTask | Method Property | Fluent Description | Representation |
|---|---|---|
| whiteOverlay accepts | typings.-672261858||
| hurtOverlay accepts | typings.-672261858||
| Return Value | typings.-1107424165
Sets the position of the task, relative to its attached part
Uses model coordinates
overload 1:
SpriteTask.pos(pos: Vector3): RenderTask | Method Property | Fluent Description | Representation |
|---|---|---|
| pos accepts | typings.2002444080||
| Return Value | typings.-1107424165
overload 2:
SpriteTask.pos(x: Number, y: Number, z: Number): RenderTask | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | typings.-1950496919||
| y accepts | typings.-1950496919||
| z accepts | typings.-1950496919||
| Return Value | typings.-1107424165
Sets the texture UV region
Uses its dimensions to calculate the max UV
overload 1:
SpriteTask.region(region: Vector2): SpriteTask | Method Property | Fluent Description | Representation |
|---|---|---|
| region accepts | typings.2002444079||
| Return Value | typings.-769810934
overload 2:
SpriteTask.region(width: Integer, height: Integer): SpriteTask | Method Property | Fluent Description | Representation |
|---|---|---|
| width accepts | typings.-672261858||
| height accepts | typings.-672261858||
| Return Value | typings.-769810934
Removes this render task from the parent model part
overload 1:
SpriteTask.remove(): RenderTask | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1107424165
Sets the current render type of this sprite
TRANSLUCENT by default
Check the docs enum command for all render types
overload 1:
SpriteTask.renderType(renderType: String): SpriteTask | Method Property | Fluent Description | Representation |
|---|---|---|
| renderType accepts | typings.-1808118735||
| Return Value | typings.-769810934
Sets the rotation of the task, relative to its attached part
overload 1:
SpriteTask.rot(rot: Vector3): RenderTask | Method Property | Fluent Description | Representation |
|---|---|---|
| rot accepts | typings.2002444080||
| Return Value | typings.-1107424165
overload 2:
SpriteTask.rot(x: Number, y: Number, z: Number): RenderTask | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | typings.-1950496919||
| y accepts | typings.-1950496919||
| z accepts | typings.-1950496919||
| Return Value | typings.-1107424165
Sets the scale of the task, relative to its attached part
overload 1:
SpriteTask.scale(scale: Vector3): RenderTask | Method Property | Fluent Description | Representation |
|---|---|---|
| scale accepts | typings.2002444080||
| Return Value | typings.-1107424165
overload 2:
SpriteTask.scale(x: Number, y: Number, z: Number): RenderTask | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | typings.-1950496919||
| y accepts | typings.-1950496919||
| z accepts | typings.-1950496919||
| Return Value | typings.-1107424165
Sets a color multiplier for this sprite
Values are RGBA from 0 to 1
Default values are 1, alpha is optional
overload 1:
SpriteTask.setColor(rgb: Vector3): SpriteTask | Method Property | Fluent Description | Representation |
|---|---|---|
| rgb accepts | typings.2002444080||
| Return Value | typings.-769810934
overload 2:
SpriteTask.setColor(rgba: Vector4): SpriteTask | Method Property | Fluent Description | Representation |
|---|---|---|
| rgba accepts | typings.2002444081||
| Return Value | typings.-769810934
overload 3:
SpriteTask.setColor(r: Number, g: Number, b: Number, a: Number): SpriteTask | Method Property | Fluent Description | Representation |
|---|---|---|
| r accepts | typings.-1950496919||
| g accepts | typings.-1950496919||
| b accepts | typings.-1950496919||
| a accepts | typings.-1950496919||
| Return Value | typings.-769810934
Sets the texture dimensions, used in UV calculation
overload 1:
SpriteTask.setDimensions(dimensions: Vector2): SpriteTask | Method Property | Fluent Description | Representation |
|---|---|---|
| dimensions accepts | typings.2002444079||
| Return Value | typings.-769810934
overload 2:
SpriteTask.setDimensions(width: Integer, height: Integer): SpriteTask | Method Property | Fluent Description | Representation |
|---|---|---|
| width accepts | typings.-672261858||
| height accepts | typings.-672261858||
| Return Value | typings.-769810934
Sets the light override value of this task
Values are given from 0 to 15, indicating the block light and sky light levels you want to use
Passing nil will reset the lighting override for this task
overload 1:
SpriteTask.setLight(light: Vector2): RenderTask | Method Property | Fluent Description | Representation |
|---|---|---|
| light accepts | typings.2002444079||
| Return Value | typings.-1107424165
overload 2:
SpriteTask.setLight(blockLight: Integer, skyLight: Integer): RenderTask | Method Property | Fluent Description | Representation |
|---|---|---|
| blockLight accepts | typings.-672261858||
| skyLight accepts | typings.-672261858||
| Return Value | typings.-1107424165
Sets the given matrix as the position matrix for this render task
The normal matrix is automatically calculated as the inverse transpose of this matrix
Calling this DOES NOT CHANGE the values of position, rot, or scale in the render task
If you call setPos() or a similar function, the effects of setMatrix() will be overwritten
overload 1:
SpriteTask.setMatrix(matrix: Matrix4): RenderTask | Method Property | Fluent Description | Representation |
|---|---|---|
| matrix accepts | typings.-1789003661||
| Return Value | typings.-1107424165
Sets the overlay override value of this task
Values you give are 0 to 15, indicating the white overlay and the damage overlay levels you want to use
Passing nil will reset the overlay override for this task
overload 1:
SpriteTask.setOverlay(overlay: Vector2): RenderTask | Method Property | Fluent Description | Representation |
|---|---|---|
| overlay accepts | typings.2002444079||
| Return Value | typings.-1107424165
overload 2:
SpriteTask.setOverlay(whiteOverlay: Integer, hurtOverlay: Integer): RenderTask | Method Property | Fluent Description | Representation |
|---|---|---|
| whiteOverlay accepts | typings.-672261858||
| hurtOverlay accepts | typings.-672261858||
| Return Value | typings.-1107424165
Sets the position of the task, relative to its attached part
Uses model coordinates
overload 1:
SpriteTask.setPos(pos: Vector3): RenderTask | Method Property | Fluent Description | Representation |
|---|---|---|
| pos accepts | typings.2002444080||
| Return Value | typings.-1107424165
overload 2:
SpriteTask.setPos(x: Number, y: Number, z: Number): RenderTask | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | typings.-1950496919||
| y accepts | typings.-1950496919||
| z accepts | typings.-1950496919||
| Return Value | typings.-1107424165
Sets the texture UV region
Uses its dimensions to calculate the max UV
overload 1:
SpriteTask.setRegion(region: Vector2): SpriteTask | Method Property | Fluent Description | Representation |
|---|---|---|
| region accepts | typings.2002444079||
| Return Value | typings.-769810934
overload 2:
SpriteTask.setRegion(width: Integer, height: Integer): SpriteTask | Method Property | Fluent Description | Representation |
|---|---|---|
| width accepts | typings.-672261858||
| height accepts | typings.-672261858||
| Return Value | typings.-769810934
Sets the current render type of this sprite
TRANSLUCENT by default
Check the docs enum command for all render types
overload 1:
SpriteTask.setRenderType(renderType: String): SpriteTask | Method Property | Fluent Description | Representation |
|---|---|---|
| renderType accepts | typings.-1808118735||
| Return Value | typings.-769810934
Sets the rotation of the task, relative to its attached part
overload 1:
SpriteTask.setRot(rot: Vector3): RenderTask | Method Property | Fluent Description | Representation |
|---|---|---|
| rot accepts | typings.2002444080||
| Return Value | typings.-1107424165
overload 2:
SpriteTask.setRot(x: Number, y: Number, z: Number): RenderTask | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | typings.-1950496919||
| y accepts | typings.-1950496919||
| z accepts | typings.-1950496919||
| Return Value | typings.-1107424165
Sets the scale of the task, relative to its attached part
overload 1:
SpriteTask.setScale(scale: Vector3): RenderTask | Method Property | Fluent Description | Representation |
|---|---|---|
| scale accepts | typings.2002444080||
| Return Value | typings.-1107424165
overload 2:
SpriteTask.setScale(x: Number, y: Number, z: Number): RenderTask | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | typings.-1950496919||
| y accepts | typings.-1950496919||
| z accepts | typings.-1950496919||
| Return Value | typings.-1107424165
Sets the width and height used to render this sprite
overload 1:
SpriteTask.setSize(size: Vector2): SpriteTask | Method Property | Fluent Description | Representation |
|---|---|---|
| size accepts | typings.2002444079||
| Return Value | typings.-769810934
overload 2:
SpriteTask.setSize(width: Integer, height: Integer): SpriteTask | Method Property | Fluent Description | Representation |
|---|---|---|
| width accepts | typings.-672261858||
| height accepts | typings.-672261858||
| Return Value | typings.-769810934
Sets this task's texture
The texture's width and height must be provided if the texture is a location
For custom textures, the dimensions are optional
overload 1:
SpriteTask.setTexture(textureLocation: String, width: Integer, height: Integer): SpriteTask | Method Property | Fluent Description | Representation |
|---|---|---|
| textureLocation accepts | typings.-1808118735||
| width accepts | typings.-672261858||
| height accepts | typings.-672261858||
| Return Value | typings.-769810934
overload 2:
SpriteTask.setTexture(texture: Texture): SpriteTask | Method Property | Fluent Description | Representation |
|---|---|---|
| texture accepts | typings.246836475||
| Return Value | typings.-769810934
overload 3:
SpriteTask.setTexture(texture: Texture, width: Integer, height: Integer): SpriteTask | Method Property | Fluent Description | Representation |
|---|---|---|
| texture accepts | typings.246836475||
| width accepts | typings.-672261858||
| height accepts | typings.-672261858||
| Return Value | typings.-769810934
overload 4:
SpriteTask.setTexture(textureLocation: String, dimensions: Vector2): SpriteTask | Method Property | Fluent Description | Representation |
|---|---|---|
| textureLocation accepts | typings.-1808118735||
| dimensions accepts | typings.2002444079||
| Return Value | typings.-769810934
overload 5:
SpriteTask.setTexture(texture: Texture, dimensions: Vector2): SpriteTask | Method Property | Fluent Description | Representation |
|---|---|---|
| texture accepts | typings.246836475||
| dimensions accepts | typings.2002444079||
| Return Value | typings.-769810934
Sets this texture UV offset
The Region and Dimension are used to calculate the end UV
overload 1:
SpriteTask.setUV(uv: Vector2): SpriteTask | Method Property | Fluent Description | Representation |
|---|---|---|
| uv accepts | typings.2002444079||
| Return Value | typings.-769810934
overload 2:
SpriteTask.setUV(u: Number, v: Number): SpriteTask | Method Property | Fluent Description | Representation |
|---|---|---|
| u accepts | typings.-1950496919||
| v accepts | typings.-1950496919||
| Return Value | typings.-769810934
Set this texture UV offset, in pixels, based on the texture's dimension
overload 1:
SpriteTask.setUVPixels(uv: Vector2): SpriteTask | Method Property | Fluent Description | Representation |
|---|---|---|
| uv accepts | typings.2002444079||
| Return Value | typings.-769810934
overload 2:
SpriteTask.setUVPixels(u: Number, v: Number): SpriteTask | Method Property | Fluent Description | Representation |
|---|---|---|
| u accepts | typings.-1950496919||
| v accepts | typings.-1950496919||
| Return Value | typings.-769810934
Sets whether or not this task should be rendered
overload 1:
SpriteTask.setVisible(visible: Boolean): RenderTask | Method Property | Fluent Description | Representation |
|---|---|---|
| visible accepts | typings.1729365000||
| Return Value | typings.-1107424165
Sets the width and height used to render this sprite
overload 1:
SpriteTask.size(size: Vector2): SpriteTask | Method Property | Fluent Description | Representation |
|---|---|---|
| size accepts | typings.2002444079||
| Return Value | typings.-769810934
overload 2:
SpriteTask.size(width: Integer, height: Integer): SpriteTask | Method Property | Fluent Description | Representation |
|---|---|---|
| width accepts | typings.-672261858||
| height accepts | typings.-672261858||
| Return Value | typings.-769810934
Sets this task's texture
The texture's width and height must be provided if the texture is a location
For custom textures, the dimensions are optional
overload 1:
SpriteTask.texture(textureLocation: String, width: Integer, height: Integer): SpriteTask | Method Property | Fluent Description | Representation |
|---|---|---|
| textureLocation accepts | typings.-1808118735||
| width accepts | typings.-672261858||
| height accepts | typings.-672261858||
| Return Value | typings.-769810934
overload 2:
SpriteTask.texture(texture: Texture): SpriteTask | Method Property | Fluent Description | Representation |
|---|---|---|
| texture accepts | typings.246836475||
| Return Value | typings.-769810934
overload 3:
SpriteTask.texture(texture: Texture, width: Integer, height: Integer): SpriteTask | Method Property | Fluent Description | Representation |
|---|---|---|
| texture accepts | typings.246836475||
| width accepts | typings.-672261858||
| height accepts | typings.-672261858||
| Return Value | typings.-769810934
overload 4:
SpriteTask.texture(textureLocation: String, dimensions: Vector2): SpriteTask | Method Property | Fluent Description | Representation |
|---|---|---|
| textureLocation accepts | typings.-1808118735||
| dimensions accepts | typings.2002444079||
| Return Value | typings.-769810934
overload 5:
SpriteTask.texture(texture: Texture, dimensions: Vector2): SpriteTask | Method Property | Fluent Description | Representation |
|---|---|---|
| texture accepts | typings.246836475||
| dimensions accepts | typings.2002444079||
| Return Value | typings.-769810934
Sets this texture UV offset
The Region and Dimension are used to calculate the end UV
overload 1:
SpriteTask.uv(uv: Vector2): SpriteTask | Method Property | Fluent Description | Representation |
|---|---|---|
| uv accepts | typings.2002444079||
| Return Value | typings.-769810934
overload 2:
SpriteTask.uv(u: Number, v: Number): SpriteTask | Method Property | Fluent Description | Representation |
|---|---|---|
| u accepts | typings.-1950496919||
| v accepts | typings.-1950496919||
| Return Value | typings.-769810934
Set this texture UV offset, in pixels, based on the texture's dimension
overload 1:
SpriteTask.uvPixels(uv: Vector2): SpriteTask | Method Property | Fluent Description | Representation |
|---|---|---|
| uv accepts | typings.2002444079||
| Return Value | typings.-769810934
overload 2:
SpriteTask.uvPixels(u: Number, v: Number): SpriteTask | Method Property | Fluent Description | Representation |
|---|---|---|
| u accepts | typings.-1950496919||
| v accepts | typings.-1950496919||
| Return Value | typings.-769810934
Sets whether or not this task should be rendered
overload 1:
SpriteTask.visible(visible: Boolean): RenderTask | Method Property | Fluent Description | Representation |
|---|---|---|
| visible accepts | typings.1729365000||
| Return Value | typings.-1107424165