listFiles
action_wheel
Action
BlockRaycastTypes A task for rendering some Text 
Sets this Text alignment
Can be either "LEFT", "RIGHT" or "CENTER"
Default "LEFT"
overload 1:
TextTask.alignment(alignment: String): TextTask | Method Property | Fluent Description | Representation |
|---|---|---|
| alignment accepts | typings.-1808118735||
| Return Value | typings.-939002766
Sets if this text should render its background
Defaults to false
overload 1:
TextTask.background(background: Boolean): TextTask | Method Property | Fluent Description | Representation |
|---|---|---|
| background accepts | typings.1729365000||
| Return Value | typings.-939002766
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: Vector4): TextTask | Method Property | Fluent Description | Representation |
|---|---|---|
| rgba accepts | typings.2002444081||
| Return Value | typings.-939002766
overload 2:
TextTask.backgroundColor(r: Number, g: Number, b: Number, a: Number): TextTask | Method Property | Fluent Description | Representation |
|---|---|---|
| r accepts | typings.-1950496919||
| g accepts | typings.-1950496919||
| b accepts | typings.-1950496919||
| a accepts | typings.-1950496919||
| Return Value | typings.-939002766
Returns this Text alignment
Default "LEFT"
overload 1:
TextTask.getAlignment(): String | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1808118735
Gets this text's background color
overload 1:
TextTask.getBackgroundColor(): Vector4 | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.2002444081
Returns the light override value of this task
overload 1:
TextTask.getLight(): Vector2 | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.2002444079
Get this task's name
overload 1:
TextTask.getName(): String | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1808118735
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(): Matrix3 | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1789003662
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(): Matrix3 | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1789003662
Gets the opacity of this text
overload 1:
TextTask.getOpacity(): Number | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1950496919
Gets this tasks text outline color
overload 1:
TextTask.getOutlineColor(): Vector3 | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.2002444080
Returns the overlay override value of this task
overload 1:
TextTask.getOverlay(): Vector2 | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.2002444079
Gets this task position
overload 1:
TextTask.getPos(): Vector3 | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.2002444080
Recalculates the matrix for this render task, based on its current position, rotation, scale, and pivot, then returns this matrix
overload 1:
TextTask.getPositionMatrix(): Matrix4 | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1789003661
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(): Matrix4 | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1789003661
Gets this task rotation
overload 1:
TextTask.getRot(): Vector3 | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.2002444080
Gets this task scale
overload 1:
TextTask.getScale(): Vector3 | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.2002444080
Returns the Text from this task
overload 1:
TextTask.getText(): String | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1808118735
Gets this text's max width
Defaults to 0
overload 1:
TextTask.getWidth(): Integer | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-672261858
Check if this text should render its background
Defaults to false
overload 1:
TextTask.hasBackground(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Checks if this task text has an outline
overload 1:
TextTask.hasOutline(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Checks if this task text has shadow
overload 1:
TextTask.hasShadow(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Check if this text should wrap lines
overload 1:
TextTask.hasWrap(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Check if this text can be seen behind walls
Defaults to false
overload 1:
TextTask.isSeeThrough(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Checks if this task is visible
overload 1:
TextTask.isVisible(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
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: Vector2): RenderTask | Method Property | Fluent Description | Representation |
|---|---|---|
| light accepts | typings.2002444079||
| Return Value | typings.-1107424165
overload 2:
TextTask.light(blockLight: Integer, skyLight: Integer): RenderTask | Method Property | Fluent Description | Representation |
|---|---|---|
| blockLight accepts | typings.-672261858||
| skyLight accepts | typings.-672261858||
| Return Value | typings.-1107424165
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: Matrix4): RenderTask | Method Property | Fluent Description | Representation |
|---|---|---|
| matrix accepts | typings.-1789003661||
| Return Value | typings.-1107424165
Sets the opacity of this text
overload 1:
TextTask.opacity(opacity: Number): TextTask | Method Property | Fluent Description | Representation |
|---|---|---|
| opacity accepts | typings.-1950496919||
| Return Value | typings.-939002766
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: Boolean): TextTask | Method Property | Fluent Description | Representation |
|---|---|---|
| outline accepts | typings.1729365000||
| Return Value | typings.-939002766
Sets the outline color this Text should render
Only compatible with "Outline" mode
overload 1:
TextTask.outlineColor(color: Vector3): TextTask | Method Property | Fluent Description | Representation |
|---|---|---|
| color accepts | typings.2002444080||
| Return Value | typings.-939002766
overload 2:
TextTask.outlineColor(r: Number, g: Number, b: Number): TextTask | Method Property | Fluent Description | Representation |
|---|---|---|
| r accepts | typings.-1950496919||
| g accepts | typings.-1950496919||
| b accepts | typings.-1950496919||
| Return Value | typings.-939002766
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: Vector2): RenderTask | Method Property | Fluent Description | Representation |
|---|---|---|
| overlay accepts | typings.2002444079||
| Return Value | typings.-1107424165
overload 2:
TextTask.overlay(whiteOverlay: Integer, hurtOverlay: Integer): RenderTask | Method Property | Fluent Description | Representation |
|---|---|---|
| whiteOverlay accepts | typings.-672261858||
| hurtOverlay accepts | typings.-672261858||
| Return Value | typings.-1107424165
Sets the position of the task, relative to its attached part
Uses model coordinates
overload 1:
TextTask.pos(pos: Vector3): RenderTask | Method Property | Fluent Description | Representation |
|---|---|---|
| pos accepts | typings.2002444080||
| Return Value | typings.-1107424165
overload 2:
TextTask.pos(x: Number, y: Number, z: Number): RenderTask | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | typings.-1950496919||
| y accepts | typings.-1950496919||
| z accepts | typings.-1950496919||
| Return Value | typings.-1107424165
Removes this render task from the parent model part
overload 1:
TextTask.remove(): RenderTask | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1107424165
Sets the rotation of the task, relative to its attached part
overload 1:
TextTask.rot(rot: Vector3): RenderTask | Method Property | Fluent Description | Representation |
|---|---|---|
| rot accepts | typings.2002444080||
| Return Value | typings.-1107424165
overload 2:
TextTask.rot(x: Number, y: Number, z: Number): RenderTask | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | typings.-1950496919||
| y accepts | typings.-1950496919||
| z accepts | typings.-1950496919||
| Return Value | typings.-1107424165
Sets the scale of the task, relative to its attached part
overload 1:
TextTask.scale(scale: Vector3): RenderTask | Method Property | Fluent Description | Representation |
|---|---|---|
| scale accepts | typings.2002444080||
| Return Value | typings.-1107424165
overload 2:
TextTask.scale(x: Number, y: Number, z: Number): RenderTask | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | typings.-1950496919||
| y accepts | typings.-1950496919||
| z accepts | typings.-1950496919||
| Return Value | typings.-1107424165
Sets if this text can be seen behind walls
Defaults to false
overload 1:
TextTask.seeThrough(seeThrough: Boolean): TextTask | Method Property | Fluent Description | Representation |
|---|---|---|
| seeThrough accepts | typings.1729365000||
| Return Value | typings.-939002766
Sets this Text alignment
Can be either "LEFT", "RIGHT" or "CENTER"
Default "LEFT"
overload 1:
TextTask.setAlignment(alignment: String): TextTask | Method Property | Fluent Description | Representation |
|---|---|---|
| alignment accepts | typings.-1808118735||
| Return Value | typings.-939002766
Sets if this text should render its background
Defaults to false
overload 1:
TextTask.setBackground(background: Boolean): TextTask | Method Property | Fluent Description | Representation |
|---|---|---|
| background accepts | typings.1729365000||
| Return Value | typings.-939002766
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: Vector4): TextTask | Method Property | Fluent Description | Representation |
|---|---|---|
| rgba accepts | typings.2002444081||
| Return Value | typings.-939002766
overload 2:
TextTask.setBackgroundColor(r: Number, g: Number, b: Number, a: Number): TextTask | Method Property | Fluent Description | Representation |
|---|---|---|
| r accepts | typings.-1950496919||
| g accepts | typings.-1950496919||
| b accepts | typings.-1950496919||
| a accepts | typings.-1950496919||
| Return Value | typings.-939002766
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: Vector2): RenderTask | Method Property | Fluent Description | Representation |
|---|---|---|
| light accepts | typings.2002444079||
| Return Value | typings.-1107424165
overload 2:
TextTask.setLight(blockLight: Integer, skyLight: Integer): RenderTask | Method Property | Fluent Description | Representation |
|---|---|---|
| blockLight accepts | typings.-672261858||
| skyLight accepts | typings.-672261858||
| Return Value | typings.-1107424165
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: Matrix4): RenderTask | Method Property | Fluent Description | Representation |
|---|---|---|
| matrix accepts | typings.-1789003661||
| Return Value | typings.-1107424165
Sets the opacity of this text
overload 1:
TextTask.setOpacity(opacity: Number): TextTask | Method Property | Fluent Description | Representation |
|---|---|---|
| opacity accepts | typings.-1950496919||
| Return Value | typings.-939002766
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: Boolean): TextTask | Method Property | Fluent Description | Representation |
|---|---|---|
| outline accepts | typings.1729365000||
| Return Value | typings.-939002766
Sets the outline color this Text should render
Only compatible with "Outline" mode
overload 1:
TextTask.setOutlineColor(color: Vector3): TextTask | Method Property | Fluent Description | Representation |
|---|---|---|
| color accepts | typings.2002444080||
| Return Value | typings.-939002766
overload 2:
TextTask.setOutlineColor(r: Number, g: Number, b: Number): TextTask | Method Property | Fluent Description | Representation |
|---|---|---|
| r accepts | typings.-1950496919||
| g accepts | typings.-1950496919||
| b accepts | typings.-1950496919||
| Return Value | typings.-939002766
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: Vector2): RenderTask | Method Property | Fluent Description | Representation |
|---|---|---|
| overlay accepts | typings.2002444079||
| Return Value | typings.-1107424165
overload 2:
TextTask.setOverlay(whiteOverlay: Integer, hurtOverlay: Integer): RenderTask | Method Property | Fluent Description | Representation |
|---|---|---|
| whiteOverlay accepts | typings.-672261858||
| hurtOverlay accepts | typings.-672261858||
| Return Value | typings.-1107424165
Sets the position of the task, relative to its attached part
Uses model coordinates
overload 1:
TextTask.setPos(pos: Vector3): RenderTask | Method Property | Fluent Description | Representation |
|---|---|---|
| pos accepts | typings.2002444080||
| Return Value | typings.-1107424165
overload 2:
TextTask.setPos(x: Number, y: Number, z: Number): RenderTask | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | typings.-1950496919||
| y accepts | typings.-1950496919||
| z accepts | typings.-1950496919||
| Return Value | typings.-1107424165
Sets the rotation of the task, relative to its attached part
overload 1:
TextTask.setRot(rot: Vector3): RenderTask | Method Property | Fluent Description | Representation |
|---|---|---|
| rot accepts | typings.2002444080||
| Return Value | typings.-1107424165
overload 2:
TextTask.setRot(x: Number, y: Number, z: Number): RenderTask | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | typings.-1950496919||
| y accepts | typings.-1950496919||
| z accepts | typings.-1950496919||
| Return Value | typings.-1107424165
Sets the scale of the task, relative to its attached part
overload 1:
TextTask.setScale(scale: Vector3): RenderTask | Method Property | Fluent Description | Representation |
|---|---|---|
| scale accepts | typings.2002444080||
| Return Value | typings.-1107424165
overload 2:
TextTask.setScale(x: Number, y: Number, z: Number): RenderTask | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | typings.-1950496919||
| y accepts | typings.-1950496919||
| z accepts | typings.-1950496919||
| Return Value | typings.-1107424165
Sets if this text can be seen behind walls
Defaults to false
overload 1:
TextTask.setSeeThrough(seeThrough: Boolean): TextTask | Method Property | Fluent Description | Representation |
|---|---|---|
| seeThrough accepts | typings.1729365000||
| Return Value | typings.-939002766
Toggles if the Text should render with a drop shadow
Not compatible with "Outline" mode
overload 1:
TextTask.setShadow(shadow: Boolean): TextTask | Method Property | Fluent Description | Representation |
|---|---|---|
| shadow accepts | typings.1729365000||
| Return Value | typings.-939002766
Sets the Text for this task render
overload 1:
TextTask.setText(text: String): TextTask | Method Property | Fluent Description | Representation |
|---|---|---|
| text accepts | typings.-1808118735||
| Return Value | typings.-939002766
Sets whether or not this task should be rendered
overload 1:
TextTask.setVisible(visible: Boolean): RenderTask | Method Property | Fluent Description | Representation |
|---|---|---|
| visible accepts | typings.1729365000||
| Return Value | typings.-1107424165
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: Integer): TextTask | Method Property | Fluent Description | Representation |
|---|---|---|
| width accepts | typings.-672261858||
| Return Value | typings.-939002766
Sets if this text should wrap lines
overload 1:
TextTask.setWrap(wrap: Boolean): TextTask | Method Property | Fluent Description | Representation |
|---|---|---|
| wrap accepts | typings.1729365000||
| Return Value | typings.-939002766
Toggles if the Text should render with a drop shadow
Not compatible with "Outline" mode
overload 1:
TextTask.shadow(shadow: Boolean): TextTask | Method Property | Fluent Description | Representation |
|---|---|---|
| shadow accepts | typings.1729365000||
| Return Value | typings.-939002766
Sets the Text for this task render
overload 1:
TextTask.text(text: String): TextTask | Method Property | Fluent Description | Representation |
|---|---|---|
| text accepts | typings.-1808118735||
| Return Value | typings.-939002766
Sets whether or not this task should be rendered
overload 1:
TextTask.visible(visible: Boolean): RenderTask | Method Property | Fluent Description | Representation |
|---|---|---|
| visible accepts | typings.1729365000||
| Return Value | typings.-1107424165
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: Integer): TextTask | Method Property | Fluent Description | Representation |
|---|---|---|
| width accepts | typings.-672261858||
| Return Value | typings.-939002766
Sets if this text should wrap lines
overload 1:
TextTask.wrap(wrap: Boolean): TextTask | Method Property | Fluent Description | Representation |
|---|---|---|
| wrap accepts | typings.1729365000||
| Return Value | typings.-939002766