Show everything

Miscellaneous Types

math
Action Page
Animation
EntityNameplateCustomization NameplateCustomization NameplateCustomizationGroup
Biome BlockState ItemStack
VanillaModelGroup VanillaModelPart VanillaPart
BlockTask ItemTask RenderTask SpriteTask TextTask Vertex
LivingEntityAPI ViewerAPI
Event
Keybind
Vector2 Vector3 Vector4
Matrix2 Matrix3 Matrix4
Particle
Sound
PingFunction
Texture TextureAtlas
Made by applejuice

BlockTask

subclasses RenderTask

A task for rendering a Block

BlockTask.setBlock
Sets the Block for this task render
overload 1:
BlockTask:setBlock(block)
Method Property Fluent Description Representation
block accepts a String
Return Value a BlockTask
overload 2:
BlockTask:setBlock(block)
Method Property Fluent Description Representation
block accepts a BlockState
Return Value a BlockTask

BlockTask.getName

Inherited from RenderTask

Get this task's name
overload 1:
BlockTask:getName()
Method Property Fluent Description Representation
Return Value a String

BlockTask.setScale

Inherited from RenderTask

Sets the scale of the task, relative to its attached part
overload 1:
BlockTask:setScale(scale)
Method Property Fluent Description Representation
scale accepts a Vector3
Return Value a RenderTask
overload 2:
BlockTask:setScale(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a RenderTask

BlockTask.setVisible

Inherited from RenderTask

Sets whether or not this task should be rendered
overload 1:
BlockTask:setVisible(visible)
Method Property Fluent Description Representation
visible accepts a Boolean
Return Value a RenderTask

BlockTask.getOverlay

Inherited from RenderTask

Returns the overlay override value of this task
overload 1:
BlockTask:getOverlay()
Method Property Fluent Description Representation
Return Value a Vector2

BlockTask.getPos

Inherited from RenderTask

Gets this task position
overload 1:
BlockTask:getPos()
Method Property Fluent Description Representation
Return Value a Vector3

BlockTask.getRot

Inherited from RenderTask

Gets this task rotation
overload 1:
BlockTask:getRot()
Method Property Fluent Description Representation
Return Value a Vector3

BlockTask.setRot

Inherited from RenderTask

Sets the rotation of the task, relative to its attached part
overload 1:
BlockTask:setRot(rot)
Method Property Fluent Description Representation
rot accepts a Vector3
Return Value a RenderTask
overload 2:
BlockTask:setRot(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a RenderTask

BlockTask.getLight

Inherited from RenderTask

Returns the light override value of this task
overload 1:
BlockTask:getLight()
Method Property Fluent Description Representation
Return Value a Vector2

BlockTask.setLight

Inherited from RenderTask

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)
Method Property Fluent Description Representation
light accepts a Vector2
Return Value a RenderTask
overload 2:
BlockTask:setLight(blockLight, skyLight)
Method Property Fluent Description Representation
blockLight accepts an Integer
skyLight accepts an Integer
Return Value a RenderTask

BlockTask.getPositionMatrixRaw

Inherited from RenderTask

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()
Method Property Fluent Description Representation
Return Value a Matrix4

BlockTask.setMatrix

Inherited from RenderTask

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)
Method Property Fluent Description Representation
matrix accepts a Matrix4
Return Value a RenderTask

BlockTask.getNormalMatrix

Inherited from RenderTask

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()
Method Property Fluent Description Representation
Return Value a Matrix3

BlockTask.getPositionMatrix

Inherited from RenderTask

Recalculates the matrix for this render task, based on its current position, rotation, scale, and pivot, then returns this matrix
overload 1:
BlockTask:getPositionMatrix()
Method Property Fluent Description Representation
Return Value a Matrix4

BlockTask.getNormalMatrixRaw

Inherited from RenderTask

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()
Method Property Fluent Description Representation
Return Value a Matrix3

BlockTask.getScale

Inherited from RenderTask

Gets this task scale
overload 1:
BlockTask:getScale()
Method Property Fluent Description Representation
Return Value a Vector3

BlockTask.setPos

Inherited from RenderTask

Sets the position of the task, relative to its attached part
Uses model coordinates
overload 1:
BlockTask:setPos(pos)
Method Property Fluent Description Representation
pos accepts a Vector3
Return Value a RenderTask
overload 2:
BlockTask:setPos(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a RenderTask

BlockTask.setOverlay

Inherited from RenderTask

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)
Method Property Fluent Description Representation
overlay accepts a Vector2
Return Value a RenderTask
overload 2:
BlockTask:setOverlay(whiteOverlay, hurtOverlay)
Method Property Fluent Description Representation
whiteOverlay accepts an Integer
hurtOverlay accepts an Integer
Return Value a RenderTask

BlockTask.isVisible

Inherited from RenderTask

Checks if this task is visible
overload 1:
BlockTask:isVisible()
Method Property Fluent Description Representation
Return Value a Boolean

BlockTask.block
Sets the Block for this task render
overload 1:
BlockTask:block(block)
Method Property Fluent Description Representation
block accepts a String
Return Value a BlockTask
overload 2:
BlockTask:block(block)
Method Property Fluent Description Representation
block accepts a BlockState
Return Value a BlockTask

BlockTask.scale

Inherited from RenderTask

Sets the scale of the task, relative to its attached part
overload 1:
BlockTask:scale(scale)
Method Property Fluent Description Representation
scale accepts a Vector3
Return Value a RenderTask
overload 2:
BlockTask:scale(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a RenderTask

BlockTask.visible

Inherited from RenderTask

Sets whether or not this task should be rendered
overload 1:
BlockTask:visible(visible)
Method Property Fluent Description Representation
visible accepts a Boolean
Return Value a RenderTask

BlockTask.rot

Inherited from RenderTask

Sets the rotation of the task, relative to its attached part
overload 1:
BlockTask:rot(rot)
Method Property Fluent Description Representation
rot accepts a Vector3
Return Value a RenderTask
overload 2:
BlockTask:rot(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a RenderTask

BlockTask.light

Inherited from RenderTask

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)
Method Property Fluent Description Representation
light accepts a Vector2
Return Value a RenderTask
overload 2:
BlockTask:light(blockLight, skyLight)
Method Property Fluent Description Representation
blockLight accepts an Integer
skyLight accepts an Integer
Return Value a RenderTask

BlockTask.matrix

Inherited from RenderTask

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)
Method Property Fluent Description Representation
matrix accepts a Matrix4
Return Value a RenderTask

BlockTask.pos

Inherited from RenderTask

Sets the position of the task, relative to its attached part
Uses model coordinates
overload 1:
BlockTask:pos(pos)
Method Property Fluent Description Representation
pos accepts a Vector3
Return Value a RenderTask
overload 2:
BlockTask:pos(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a RenderTask

BlockTask.overlay

Inherited from RenderTask

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)
Method Property Fluent Description Representation
overlay accepts a Vector2
Return Value a RenderTask
overload 2:
BlockTask:overlay(whiteOverlay, hurtOverlay)
Method Property Fluent Description Representation
whiteOverlay accepts an Integer
hurtOverlay accepts an Integer
Return Value a RenderTask
a a