RenderTask

Represents a rendering task for Figura to complete each frame
An abstract superclass of ItemTask,
BlockTask, and TextTask

RenderTask.getName

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

RenderTask.remove

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

RenderTask.setScale

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

RenderTask.getScale

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

RenderTask.getPos

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

RenderTask.getRot

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

RenderTask.setPos

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

RenderTask.setMatrix

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

RenderTask.setRot

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

RenderTask.getPositionMatrix

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

RenderTask.getNormalMatrix

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

RenderTask.getNormalMatrixRaw

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

RenderTask.getOverlay

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

RenderTask.setLight

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

RenderTask.getLight

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

RenderTask.setOverlay

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

RenderTask.setVisible

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

RenderTask.isVisible

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

RenderTask.getPositionMatrixRaw

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

RenderTask.scale

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

RenderTask.pos

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

RenderTask.matrix

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

RenderTask.rot

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

RenderTask.light

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

RenderTask.overlay

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

RenderTask.visible

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