Buy Me a Coffee at ko-fi.com

Sets the Block for this task render

overload 1:
BlockTask.block(block: String): BlockTask
typings.-1808118735typings.-1418559598
Method PropertyFluent DescriptionRepresentation
block accepts
Return Value
overload 2:
BlockTask.block(block: BlockState): BlockTask
typings.-1026048988typings.-1418559598
Method PropertyFluent DescriptionRepresentation
block accepts
Return Value

Returns the light override value of this task

overload 1:
BlockTask.getLight(): Vector2
typings.2002444079
Method PropertyFluent DescriptionRepresentation
Return Value

Get this task's name

overload 1:
BlockTask.getName(): String
typings.-1808118735
Method PropertyFluent DescriptionRepresentation
Return Value

Recalculates the normal matrix for this render task, based on its current position, rotation, scale, and pivot, then returns this matrix

overload 1:
BlockTask.getNormalMatrix(): Matrix3
typings.-1789003662
Method PropertyFluent DescriptionRepresentation
Return Value

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:
BlockTask.getNormalMatrixRaw(): Matrix3
typings.-1789003662
Method PropertyFluent DescriptionRepresentation
Return Value

Returns the overlay override value of this task

overload 1:
BlockTask.getOverlay(): Vector2
typings.2002444079
Method PropertyFluent DescriptionRepresentation
Return Value

Gets this task position

overload 1:
BlockTask.getPos(): Vector3
typings.2002444080
Method PropertyFluent DescriptionRepresentation
Return Value

Recalculates the matrix for this render task, based on its current position, rotation, scale, and pivot, then returns this matrix

overload 1:
BlockTask.getPositionMatrix(): Matrix4
typings.-1789003661
Method PropertyFluent DescriptionRepresentation
Return Value

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:
BlockTask.getPositionMatrixRaw(): Matrix4
typings.-1789003661
Method PropertyFluent DescriptionRepresentation
Return Value

Gets this task rotation

overload 1:
BlockTask.getRot(): Vector3
typings.2002444080
Method PropertyFluent DescriptionRepresentation
Return Value

Gets this task scale

overload 1:
BlockTask.getScale(): Vector3
typings.2002444080
Method PropertyFluent DescriptionRepresentation
Return Value

Checks if this task is visible

overload 1:
BlockTask.isVisible(): Boolean
typings.1729365000
Method PropertyFluent DescriptionRepresentation
Return Value

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:
BlockTask.light(light: Vector2): RenderTask
typings.2002444079typings.-1107424165
Method PropertyFluent DescriptionRepresentation
light accepts
Return Value
overload 2:
BlockTask.light(blockLight: Integer, skyLight: Integer): RenderTask
typings.-672261858typings.-672261858typings.-1107424165
Method PropertyFluent DescriptionRepresentation
blockLight accepts
skyLight accepts
Return Value

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:
BlockTask.matrix(matrix: Matrix4): RenderTask
typings.-1789003661typings.-1107424165
Method PropertyFluent DescriptionRepresentation
matrix accepts
Return Value

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:
BlockTask.overlay(overlay: Vector2): RenderTask
typings.2002444079typings.-1107424165
Method PropertyFluent DescriptionRepresentation
overlay accepts
Return Value
overload 2:
BlockTask.overlay(whiteOverlay: Integer, hurtOverlay: Integer): RenderTask
typings.-672261858typings.-672261858typings.-1107424165
Method PropertyFluent DescriptionRepresentation
whiteOverlay accepts
hurtOverlay accepts
Return Value

Sets the position of the task, relative to its attached part
Uses model coordinates

overload 1:
BlockTask.pos(pos: Vector3): RenderTask
typings.2002444080typings.-1107424165
Method PropertyFluent DescriptionRepresentation
pos accepts
Return Value
overload 2:
BlockTask.pos(x: Number, y: Number, z: Number): RenderTask
typings.-1950496919typings.-1950496919typings.-1950496919typings.-1107424165
Method PropertyFluent DescriptionRepresentation
x accepts
y accepts
z accepts
Return Value

Removes this render task from the parent model part

overload 1:
BlockTask.remove(): RenderTask
typings.-1107424165
Method PropertyFluent DescriptionRepresentation
Return Value

Sets the rotation of the task, relative to its attached part

overload 1:
BlockTask.rot(rot: Vector3): RenderTask
typings.2002444080typings.-1107424165
Method PropertyFluent DescriptionRepresentation
rot accepts
Return Value
overload 2:
BlockTask.rot(x: Number, y: Number, z: Number): RenderTask
typings.-1950496919typings.-1950496919typings.-1950496919typings.-1107424165
Method PropertyFluent DescriptionRepresentation
x accepts
y accepts
z accepts
Return Value

Sets the scale of the task, relative to its attached part

overload 1:
BlockTask.scale(scale: Vector3): RenderTask
typings.2002444080typings.-1107424165
Method PropertyFluent DescriptionRepresentation
scale accepts
Return Value
overload 2:
BlockTask.scale(x: Number, y: Number, z: Number): RenderTask
typings.-1950496919typings.-1950496919typings.-1950496919typings.-1107424165
Method PropertyFluent DescriptionRepresentation
x accepts
y accepts
z accepts
Return Value

Sets the Block for this task render

overload 1:
BlockTask.setBlock(block: String): BlockTask
typings.-1808118735typings.-1418559598
Method PropertyFluent DescriptionRepresentation
block accepts
Return Value
overload 2:
BlockTask.setBlock(block: BlockState): BlockTask
typings.-1026048988typings.-1418559598
Method PropertyFluent DescriptionRepresentation
block accepts
Return Value

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:
BlockTask.setLight(light: Vector2): RenderTask
typings.2002444079typings.-1107424165
Method PropertyFluent DescriptionRepresentation
light accepts
Return Value
overload 2:
BlockTask.setLight(blockLight: Integer, skyLight: Integer): RenderTask
typings.-672261858typings.-672261858typings.-1107424165
Method PropertyFluent DescriptionRepresentation
blockLight accepts
skyLight accepts
Return Value

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:
BlockTask.setMatrix(matrix: Matrix4): RenderTask
typings.-1789003661typings.-1107424165
Method PropertyFluent DescriptionRepresentation
matrix accepts
Return Value

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:
BlockTask.setOverlay(overlay: Vector2): RenderTask
typings.2002444079typings.-1107424165
Method PropertyFluent DescriptionRepresentation
overlay accepts
Return Value
overload 2:
BlockTask.setOverlay(whiteOverlay: Integer, hurtOverlay: Integer): RenderTask
typings.-672261858typings.-672261858typings.-1107424165
Method PropertyFluent DescriptionRepresentation
whiteOverlay accepts
hurtOverlay accepts
Return Value

Sets the position of the task, relative to its attached part
Uses model coordinates

overload 1:
BlockTask.setPos(pos: Vector3): RenderTask
typings.2002444080typings.-1107424165
Method PropertyFluent DescriptionRepresentation
pos accepts
Return Value
overload 2:
BlockTask.setPos(x: Number, y: Number, z: Number): RenderTask
typings.-1950496919typings.-1950496919typings.-1950496919typings.-1107424165
Method PropertyFluent DescriptionRepresentation
x accepts
y accepts
z accepts
Return Value

Sets the rotation of the task, relative to its attached part

overload 1:
BlockTask.setRot(rot: Vector3): RenderTask
typings.2002444080typings.-1107424165
Method PropertyFluent DescriptionRepresentation
rot accepts
Return Value
overload 2:
BlockTask.setRot(x: Number, y: Number, z: Number): RenderTask
typings.-1950496919typings.-1950496919typings.-1950496919typings.-1107424165
Method PropertyFluent DescriptionRepresentation
x accepts
y accepts
z accepts
Return Value

Sets the scale of the task, relative to its attached part

overload 1:
BlockTask.setScale(scale: Vector3): RenderTask
typings.2002444080typings.-1107424165
Method PropertyFluent DescriptionRepresentation
scale accepts
Return Value
overload 2:
BlockTask.setScale(x: Number, y: Number, z: Number): RenderTask
typings.-1950496919typings.-1950496919typings.-1950496919typings.-1107424165
Method PropertyFluent DescriptionRepresentation
x accepts
y accepts
z accepts
Return Value

Sets whether or not this task should be rendered

overload 1:
BlockTask.setVisible(visible: Boolean): RenderTask
typings.1729365000typings.-1107424165
Method PropertyFluent DescriptionRepresentation
visible accepts
Return Value

Sets whether or not this task should be rendered

overload 1:
BlockTask.visible(visible: Boolean): RenderTask
typings.1729365000typings.-1107424165
Method PropertyFluent DescriptionRepresentation
visible accepts
Return Value