RenderTask

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

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.enabled

figura.docs.render_task.set_enabled
overload 1:
RenderTask:enabled(bool)
Method Property Fluent Description Representation
bool accepts a Boolean
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.isEnabled

figura.docs.render_task.is_enabled
overload 1:
RenderTask:isEnabled()
Method Property Fluent Description Representation
Return Value a Boolean

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 nil
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 nil

RenderTask.getRot

Gets this task rotation
overload 1:
RenderTask:getRot()
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.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 nil
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 nil

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 nil
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 nil

RenderTask.getOverlay

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

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

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

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.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.getScale

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

RenderTask.setEnabled

figura.docs.render_task.set_enabled
overload 1:
RenderTask:setEnabled(bool)
Method Property Fluent Description Representation
bool accepts a Boolean
Return Value nil

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
a a