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

ItemTask

subclasses RenderTask

A task for rendering an Item

ItemTask.setItem
Sets the Item for this task render
overload 1:
ItemTask:setItem(item)
Method Property Fluent Description Representation
item accepts a String
Return Value an ItemTask
overload 2:
ItemTask:setItem(item)
Method Property Fluent Description Representation
item accepts an ItemStack
Return Value an ItemTask

ItemTask.setDisplayMode
Sets the item display mode for this task
overload 1:
ItemTask:setDisplayMode(displayMode)
Method Property Fluent Description Representation
displayMode accepts a String
Return Value an ItemTask

ItemTask.getDisplayMode
Gets this task item display mode
overload 1:
ItemTask:getDisplayMode()
Method Property Fluent Description Representation
Return Value a String

ItemTask.getName

Inherited from RenderTask

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

ItemTask.remove

Inherited from RenderTask

Removes this render task from the parent model part
overload 1:
ItemTask:remove()
Method Property Fluent Description Representation
Return Value a RenderTask

ItemTask.setScale

Inherited from RenderTask

Sets the scale of the task, relative to its attached part
overload 1:
ItemTask:setScale(scale)
Method Property Fluent Description Representation
scale accepts a Vector3
Return Value a RenderTask
overload 2:
ItemTask: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

ItemTask.isVisible

Inherited from RenderTask

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

ItemTask.getPos

Inherited from RenderTask

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

ItemTask.getRot

Inherited from RenderTask

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

ItemTask.setPos

Inherited from RenderTask

Sets the position of the task, relative to its attached part
Uses model coordinates
overload 1:
ItemTask:setPos(pos)
Method Property Fluent Description Representation
pos accepts a Vector3
Return Value a RenderTask
overload 2:
ItemTask: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

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

ItemTask.setRot

Inherited from RenderTask

Sets the rotation of the task, relative to its attached part
overload 1:
ItemTask:setRot(rot)
Method Property Fluent Description Representation
rot accepts a Vector3
Return Value a RenderTask
overload 2:
ItemTask: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

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

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

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

ItemTask.getLight

Inherited from RenderTask

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

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

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

ItemTask.getOverlay

Inherited from RenderTask

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

ItemTask.setVisible

Inherited from RenderTask

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

ItemTask.getScale

Inherited from RenderTask

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

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

ItemTask.item
Sets the Item for this task render
overload 1:
ItemTask:item(item)
Method Property Fluent Description Representation
item accepts a String
Return Value an ItemTask
overload 2:
ItemTask:item(item)
Method Property Fluent Description Representation
item accepts an ItemStack
Return Value an ItemTask

ItemTask.displayMode
Sets the item display mode for this task
overload 1:
ItemTask:displayMode(displayMode)
Method Property Fluent Description Representation
displayMode accepts a String
Return Value an ItemTask

ItemTask.scale

Inherited from RenderTask

Sets the scale of the task, relative to its attached part
overload 1:
ItemTask:scale(scale)
Method Property Fluent Description Representation
scale accepts a Vector3
Return Value a RenderTask
overload 2:
ItemTask: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

ItemTask.pos

Inherited from RenderTask

Sets the position of the task, relative to its attached part
Uses model coordinates
overload 1:
ItemTask:pos(pos)
Method Property Fluent Description Representation
pos accepts a Vector3
Return Value a RenderTask
overload 2:
ItemTask: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

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

ItemTask.rot

Inherited from RenderTask

Sets the rotation of the task, relative to its attached part
overload 1:
ItemTask:rot(rot)
Method Property Fluent Description Representation
rot accepts a Vector3
Return Value a RenderTask
overload 2:
ItemTask: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

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

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

ItemTask.visible

Inherited from RenderTask

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