Show everything

Miscellaneous Types

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

TextTask

subclasses RenderTask

A task for rendering some Text

TextTask.right
figura.docs.text_task.set_right
overload 1:
TextTask:right(right)
Method Property Fluent Description Representation
right accepts a Boolean
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 RenderTask

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 nil

TextTask.centered
figura.docs.text_task.set_centered
overload 1:
TextTask:centered(centered)
Method Property Fluent Description Representation
centered accepts a Boolean
Return Value a RenderTask

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

TextTask.isCentered
figura.docs.text_task.is_centered
overload 1:
TextTask:isCentered()
Method Property Fluent Description Representation
Return Value a Boolean

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

TextTask.setCentered
figura.docs.text_task.set_centered
overload 1:
TextTask:setCentered(centered)
Method Property Fluent Description Representation
centered accepts a Boolean
Return Value nil

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 nil

TextTask.isRight
figura.docs.text_task.is_right
overload 1:
TextTask:isRight()
Method Property Fluent Description Representation
Return Value a Boolean

TextTask.setRight
figura.docs.text_task.set_right
overload 1:
TextTask:setRight(right)
Method Property Fluent Description Representation
right accepts a Boolean
Return Value nil

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

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

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 RenderTask

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 nil

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 RenderTask

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

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

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

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

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

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

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

Inherited from RenderTask

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

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 nil

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