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
Made by applejuice

TextTask

subclasses RenderTask

A task for rendering some Text

TextTask.getText
Returns the Text from this task
overload 1:
TextTask:getText()
Method Property Fluent Description Representation
Return Value a String

TextTask.setText
Sets the Text for this task render
overload 1:
TextTask:setText(text)
Method Property Fluent Description Representation
text accepts a String
Return Value a TextTask

TextTask.getWidth
Gets this text's max width
Defaults to 0
overload 1:
TextTask:getWidth()
Method Property Fluent Description Representation
Return Value an Integer

TextTask.setBackgroundColor
Sets the background color of this text
If the alpha value is not given, it will use the vanilla value (as in the accessibility settings)
overload 1:
TextTask:setBackgroundColor(rgba)
Method Property Fluent Description Representation
rgba accepts a Vector4
Return Value a TextTask
overload 2:
TextTask:setBackgroundColor(r, g, b, a)
Method Property Fluent Description Representation
r accepts a Number
g accepts a Number
b accepts a Number
a accepts a Number
Return Value a TextTask

TextTask.setWidth
Sets this text's max width, wrapping the text into multiple lines
A width of 0 or less does not wrap the text
Defaults to 0
overload 1:
TextTask:setWidth(width)
Method Property Fluent Description Representation
width accepts an Integer
Return Value a TextTask

TextTask.hasBackground
Check if this text should render its background
Defaults to false
overload 1:
TextTask:hasBackground()
Method Property Fluent Description Representation
Return Value a Boolean

TextTask.setSeeThrough
Sets if this text can be seen behind walls
Defaults to false
overload 1:
TextTask:setSeeThrough(seeThrough)
Method Property Fluent Description Representation
seeThrough accepts a Boolean
Return Value a TextTask

TextTask.getBackgroundColor
Gets this text's background color
overload 1:
TextTask:getBackgroundColor()
Method Property Fluent Description Representation
Return Value a Vector4

TextTask.isSeeThrough
Check if this text can be seen behind walls
Defaults to false
overload 1:
TextTask:isSeeThrough()
Method Property Fluent Description Representation
Return Value a Boolean

TextTask.setWrap
Sets if this text should wrap lines
overload 1:
TextTask:setWrap(wrap)
Method Property Fluent Description Representation
wrap accepts a Boolean
Return Value a TextTask

TextTask.setBackground
Sets if this text should render its background
Defaults to false
overload 1:
TextTask:setBackground(background)
Method Property Fluent Description Representation
background accepts a Boolean
Return Value a TextTask

TextTask.setOutlineColor
Sets the outline color this Text should render
Only compatible with "Outline" mode
overload 1:
TextTask:setOutlineColor(color)
Method Property Fluent Description Representation
color accepts a Vector3
Return Value a TextTask
overload 2:
TextTask:setOutlineColor(r, g, b)
Method Property Fluent Description Representation
r accepts a Number
g accepts a Number
b accepts a Number
Return Value a TextTask

TextTask.HasWrap
Check if this text should wrap lines
overload 1:
TextTask:HasWrap()
Method Property Fluent Description Representation
Return Value a Boolean

TextTask.setAlignment
Sets this Text alignment
Can be either "LEFT", "RIGHT" or "CENTER"
Default "LEFT"
overload 1:
TextTask:setAlignment(alignment)
Method Property Fluent Description Representation
alignment accepts a String
Return Value a TextTask

TextTask.hasOutline
Checks if this task text has an outline
overload 1:
TextTask:hasOutline()
Method Property Fluent Description Representation
Return Value a Boolean

TextTask.hasShadow
Checks if this task text has shadow
overload 1:
TextTask:hasShadow()
Method Property Fluent Description Representation
Return Value a Boolean

TextTask.setOutline
Toggles if the text should render with an outline
The text will always render at full brightness if it is given an outline
Not compatible with "Shadow" and "Emissive" modes
overload 1:
TextTask:setOutline(outline)
Method Property Fluent Description Representation
outline accepts a Boolean
Return Value a TextTask

TextTask.getOutlineColor
Gets this tasks text outline color
overload 1:
TextTask:getOutlineColor()
Method Property Fluent Description Representation
Return Value a Vector3

TextTask.getAlignment
Returns this Text alignment
Default "LEFT"
overload 1:
TextTask:getAlignment()
Method Property Fluent Description Representation
Return Value a String

TextTask.setShadow
Toggles if the Text should render with a drop shadow
Not compatible with "Outline" mode
overload 1:
TextTask:setShadow(shadow)
Method Property Fluent Description Representation
shadow accepts a Boolean
Return Value a TextTask

TextTask.getName

Inherited from RenderTask

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

TextTask.isEnabled

Inherited from RenderTask

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

TextTask.setScale

Inherited from RenderTask

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

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

TextTask.setEnabled

Inherited from RenderTask

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

TextTask.getRot

Inherited from RenderTask

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

TextTask.getPos

Inherited from RenderTask

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

TextTask.setPos

Inherited from RenderTask

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

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

TextTask.setRot

Inherited from RenderTask

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

TextTask.getScale

Inherited from RenderTask

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

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

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

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

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

TextTask.getOverlay

Inherited from RenderTask

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

TextTask.getLight

Inherited from RenderTask

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

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

TextTask.text
Sets the Text for this task render
overload 1:
TextTask:text(text)
Method Property Fluent Description Representation
text accepts a String
Return Value a TextTask

TextTask.backgroundColor
Sets the background color of this text
If the alpha value is not given, it will use the vanilla value (as in the accessibility settings)
overload 1:
TextTask:backgroundColor(rgba)
Method Property Fluent Description Representation
rgba accepts a Vector4
Return Value a TextTask
overload 2:
TextTask:backgroundColor(r, g, b, a)
Method Property Fluent Description Representation
r accepts a Number
g accepts a Number
b accepts a Number
a accepts a Number
Return Value a TextTask

TextTask.width
Sets this text's max width, wrapping the text into multiple lines
A width of 0 or less does not wrap the text
Defaults to 0
overload 1:
TextTask:width(width)
Method Property Fluent Description Representation
width accepts an Integer
Return Value a TextTask

TextTask.seeThrough
Sets if this text can be seen behind walls
Defaults to false
overload 1:
TextTask:seeThrough(seeThrough)
Method Property Fluent Description Representation
seeThrough accepts a Boolean
Return Value a TextTask

TextTask.wrap
Sets if this text should wrap lines
overload 1:
TextTask:wrap(wrap)
Method Property Fluent Description Representation
wrap accepts a Boolean
Return Value a TextTask

TextTask.background
Sets if this text should render its background
Defaults to false
overload 1:
TextTask:background(background)
Method Property Fluent Description Representation
background accepts a Boolean
Return Value a TextTask

TextTask.outlineColor
Sets the outline color this Text should render
Only compatible with "Outline" mode
overload 1:
TextTask:outlineColor(color)
Method Property Fluent Description Representation
color accepts a Vector3
Return Value a TextTask
overload 2:
TextTask:outlineColor(r, g, b)
Method Property Fluent Description Representation
r accepts a Number
g accepts a Number
b accepts a Number
Return Value a TextTask

TextTask.alignment
Sets this Text alignment
Can be either "LEFT", "RIGHT" or "CENTER"
Default "LEFT"
overload 1:
TextTask:alignment(alignment)
Method Property Fluent Description Representation
alignment accepts a String
Return Value a TextTask

TextTask.outline
Toggles if the text should render with an outline
The text will always render at full brightness if it is given an outline
Not compatible with "Shadow" and "Emissive" modes
overload 1:
TextTask:outline(outline)
Method Property Fluent Description Representation
outline accepts a Boolean
Return Value a TextTask

TextTask.shadow
Toggles if the Text should render with a drop shadow
Not compatible with "Outline" mode
overload 1:
TextTask:shadow(shadow)
Method Property Fluent Description Representation
shadow accepts a Boolean
Return Value a TextTask

TextTask.scale

Inherited from RenderTask

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

TextTask.enabled

Inherited from RenderTask

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

TextTask.pos

Inherited from RenderTask

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

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

TextTask.rot

Inherited from RenderTask

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

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

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