EntityNameplateCustomization
A nameplate customization that is specialized for entities
This page is a WIP. It contains all the information in Figura's documentation but we're working on adding more helpful descriptions.
Text
setText()
The text to use in this nameplate
setText(text)
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
| text | String | - | - |
Returns:
| Type | Description |
|---|---|
NameplateCustomization | - |
Example:
nameplate.Entity:setText("Hi")
getText()
The text to use in this nameplate
getText()
Returns:
| Type | Description |
|---|---|
String | - |
Example:
nameplate.Entity:getText()
setOutline()
Aliases: outline()
Sets whether or not the nameplate should have outline
Incompatible with "shadow"
setOutline(outline)
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
| outline | Boolean | - | - |
Returns:
| Type | Description |
|---|---|
EntityNameplateCustomization | Returns self for chaining |
Example:
nameplate.Entity:setOutline(true)
hasOutline()
Gets whether or not the nameplate should have an outline
hasOutline()
Returns:
| Type | Description |
|---|---|
Boolean | - |
Example:
nameplate.Entity:hasOutline()
setOutlineColor()
Aliases: outlineColor()
Sets the color used for the outline in the outline mode
- Overload 1
- Overload 2
setOutlineColor(color)
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
| color | Vector3 | - | - |
Returns:
| Type | Description |
|---|---|
EntityNameplateCustomization | Returns self for chaining |
setOutlineColor(r, g, b)
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
| r | Number | - | - |
| g | Number | - | - |
| b | Number | - | - |
Returns:
| Type | Description |
|---|---|
EntityNameplateCustomization | Returns self for chaining |
Example:
nameplate.Entity:setOutlineColor(100 / 255, 100 / 255, 100 / 255)
setShadow()
Aliases: shadow()
Sets whether or not the nameplate should have shadow
Incompatible with "outline"
setShadow(shadow)
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
| shadow | Boolean | - | - |
Returns:
| Type | Description |
|---|---|
EntityNameplateCustomization | Returns self for chaining |
Example:
nameplate.Entity:setShadow(true)
hasShadow()
Gets whether or not the nameplate should have shadow
hasShadow()
Returns:
| Type | Description |
|---|---|
Boolean | - |
Example:
nameplate.Entity:hasShadow()
Nameplate Properties
setBackgroundColor()
Aliases: backgroundColor()
Sets the color of the nameplate background
If the alpha value is not given, it will use the vanilla value (as in the accessibility settings)
- Overload 1
- Overload 2
setBackgroundColor(rgba)
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
| rgba | Vector4 | - | - |
Returns:
| Type | Description |
|---|---|
EntityNameplateCustomization | Returns self for chaining |
setBackgroundColor(r, g, b, a)
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
| r | Number | - | - |
| g | Number | - | - |
| b | Number | - | - |
| a | Number | - | - |
Returns:
| Type | Description |
|---|---|
EntityNameplateCustomization | Returns self for chaining |
Example:
nameplate.Entity:setBackgroundColor(100 / 255, 100 / 255, 100 / 255)
getBackgroundColor()
Gets the set color of the nameplate background
getBackgroundColor()
Returns:
| Type | Description |
|---|---|
Vector4 | - |
Example:
nameplate.Entity:getBackgroundColor()
setLight()
Aliases: light()
Sets the light override value
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
- Overload 1
- Overload 2
setLight(light)
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
| light | Vector2 | - | - |
Returns:
| Type | Description |
|---|---|
EntityNameplateCustomization | Returns self for chaining |
setLight(blockLight, skyLight)
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
| blockLight | Integer | - | - |
| skyLight | Integer | - | - |
Returns:
| Type | Description |
|---|---|
EntityNameplateCustomization | Returns self for chaining |
Example:
nameplate.Entity:setLight(15, 15)
getLight()
Gets the lighting override value
getLight()
Returns:
| Type | Description |
|---|---|
Vector2 | - |
Example:
nameplate.Entity:getLight()
setPivot()
Aliases: pivot()
Sets the pivot of the nameplate, in world coordinates
- Overload 1
- Overload 2
setPivot(pivot)
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
| pivot | Vector3 | - | - |
Returns:
| Type | Description |
|---|---|
EntityNameplateCustomization | Returns self for chaining |
setPivot(x, y, z)
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
| x | Number | - | - |
| y | Number | - | - |
| z | Number | - | - |
Returns:
| Type | Description |
|---|---|
EntityNameplateCustomization | Returns self for chaining |
Example:
nameplate.Entity:setPivot(0, 3, 0)
getPivot()
Gets the pivot of the nameplate, in world coordinates
getPivot()
Returns:
| Type | Description |
|---|---|
Vector3 | - |
Example:
nameplate.Entity:getPivot()
setPos()
Aliases: pos()
Sets the position offset of the nameplate, in world coordinates
- Overload 1
- Overload 2
setPos(pos)
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
| pos | Vector3 | - | - |
Returns:
| Type | Description |
|---|---|
EntityNameplateCustomization | Returns self for chaining |
setPos(x, y, z)
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
| x | Number | - | - |
| y | Number | - | - |
| z | Number | - | - |
Returns:
| Type | Description |
|---|---|
EntityNameplateCustomization | Returns self for chaining |
Example:
nameplate.Entity:setPos(0, 1, 0)
getPos()
Gets the position offset of the nameplate, in world coordinates
getPos()
Returns:
| Type | Description |
|---|---|
Vector3 | - |
Example:
nameplate.Entity:getPos()
setScale()
Aliases: scale()
Sets the scale factor of the nameplate
- Overload 1
- Overload 2
setScale(scale)
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
| scale | Vector3 | - | - |
Returns:
| Type | Description |
|---|---|
EntityNameplateCustomization | Returns self for chaining |
setScale(x, y, z)
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
| x | Number | - | - |
| y | Number | - | - |
| z | Number | - | - |
Returns:
| Type | Description |
|---|---|
EntityNameplateCustomization | Returns self for chaining |
Example:
nameplate.Entity:setScale(2, 2, 2)
getScale()
Gets scale factor of the nameplate
getScale()
Returns:
| Type | Description |
|---|---|
Vector3 | - |
Example:
nameplate.Entity:getScale()
setVisible()
Aliases: visible()
Sets whether or not the nameplate should be rendered
setVisible(visible)
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
| visible | Boolean | - | - |
Returns:
| Type | Description |
|---|---|
EntityNameplateCustomization | Returns self for chaining |
Example:
nameplate.Entity:setVisible(false)
isVisible()
Gets whether or not the nameplate should be rendered
isVisible()
Returns:
| Type | Description |
|---|---|
Boolean | - |
Example:
nameplate.Entity:isVisible()