EntityNameplateCustomization

subclasses NameplateCustomization

A nameplate customization that is specialized for entities

EntityNameplateCustomization.setScale

Sets the scale factor of the nameplate
overload 1:
EntityNameplateCustomization:setScale(scale)
Method Property Fluent Description Representation
scale accepts a Vector3
Return Value an EntityNameplateCustomization
overload 2:
EntityNameplateCustomization:setScale(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value an EntityNameplateCustomization

EntityNameplateCustomization.setVisible

Sets whether or not the nameplate should be rendered
overload 1:
EntityNameplateCustomization:setVisible(visible)
Method Property Fluent Description Representation
visible accepts a Boolean
Return Value an EntityNameplateCustomization

EntityNameplateCustomization.isVisible

Gets whether or not the nameplate should be rendered
overload 1:
EntityNameplateCustomization:isVisible()
Method Property Fluent Description Representation
Return Value a Boolean

EntityNameplateCustomization.setBackgroundColor

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:
EntityNameplateCustomization:setBackgroundColor(rgba)
Method Property Fluent Description Representation
rgba accepts a Vector4
Return Value an EntityNameplateCustomization
overload 2:
EntityNameplateCustomization: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 an EntityNameplateCustomization

EntityNameplateCustomization.getBackgroundColor

Gets the set color of the nameplate background
overload 1:
EntityNameplateCustomization:getBackgroundColor()
Method Property Fluent Description Representation
Return Value a Vector4

EntityNameplateCustomization.setOutlineColor

Sets the color used for the outline in the outline mode
overload 1:
EntityNameplateCustomization:setOutlineColor(color)
Method Property Fluent Description Representation
color accepts a Vector3
Return Value an EntityNameplateCustomization
overload 2:
EntityNameplateCustomization:setOutlineColor(r, g, b)
Method Property Fluent Description Representation
r accepts a Number
g accepts a Number
b accepts a Number
Return Value an EntityNameplateCustomization

EntityNameplateCustomization.getPos

Gets the position offset of the nameplate, in world coordinates
overload 1:
EntityNameplateCustomization:getPos()
Method Property Fluent Description Representation
Return Value a Vector3

EntityNameplateCustomization.setPos

Sets the position offset of the nameplate, in world coordinates
overload 1:
EntityNameplateCustomization:setPos(pos)
Method Property Fluent Description Representation
pos accepts a Vector3
Return Value an EntityNameplateCustomization
overload 2:
EntityNameplateCustomization:setPos(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value an EntityNameplateCustomization

EntityNameplateCustomization.getPivot

Gets the pivot of the nameplate, in world coordinates
overload 1:
EntityNameplateCustomization:getPivot()
Method Property Fluent Description Representation
Return Value a Vector3

EntityNameplateCustomization.setPivot

Sets the pivot of the nameplate, in world coordinates
overload 1:
EntityNameplateCustomization:setPivot(pivot)
Method Property Fluent Description Representation
pivot accepts a Vector3
Return Value an EntityNameplateCustomization
overload 2:
EntityNameplateCustomization:setPivot(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value an EntityNameplateCustomization

EntityNameplateCustomization.getScale

Gets scale factor of the nameplate
overload 1:
EntityNameplateCustomization:getScale()
Method Property Fluent Description Representation
Return Value a Vector3

EntityNameplateCustomization.setLight

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

EntityNameplateCustomization.getLight

Gets the lighting override value
overload 1:
EntityNameplateCustomization:getLight()
Method Property Fluent Description Representation
Return Value a Vector2

EntityNameplateCustomization.hasOutline

figura.docs.nameplate_entity.has_outline
overload 1:
EntityNameplateCustomization:hasOutline()
Method Property Fluent Description Representation
Return Value a Boolean

EntityNameplateCustomization.hasShadow

Gets whether or not the nameplate should have shadow
overload 1:
EntityNameplateCustomization:hasShadow()
Method Property Fluent Description Representation
Return Value a Boolean

EntityNameplateCustomization.setOutline

Sets whether or not the nameplate should have outline
Incompatible with "shadow"
overload 1:
EntityNameplateCustomization:setOutline(outline)
Method Property Fluent Description Representation
outline accepts a Boolean
Return Value an EntityNameplateCustomization

EntityNameplateCustomization.setShadow

Sets whether or not the nameplate should have shadow
Incompatible with "outline"
overload 1:
EntityNameplateCustomization:setShadow(shadow)
Method Property Fluent Description Representation
shadow accepts a Boolean
Return Value an EntityNameplateCustomization

EntityNameplateCustomization.getText

Inherited from NameplateCustomization

The text to use in this nameplate
overload 1:
EntityNameplateCustomization:getText()
Method Property Fluent Description Representation
Return Value a String

EntityNameplateCustomization.setText

Inherited from NameplateCustomization

The text to use in this nameplate
overload 1:
EntityNameplateCustomization:setText(text)
Method Property Fluent Description Representation
text accepts a String
Return Value a NameplateCustomization

EntityNameplateCustomization.scale

Sets the scale factor of the nameplate
overload 1:
EntityNameplateCustomization:scale(scale)
Method Property Fluent Description Representation
scale accepts a Vector3
Return Value an EntityNameplateCustomization
overload 2:
EntityNameplateCustomization:scale(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value an EntityNameplateCustomization

EntityNameplateCustomization.visible

Sets whether or not the nameplate should be rendered
overload 1:
EntityNameplateCustomization:visible(visible)
Method Property Fluent Description Representation
visible accepts a Boolean
Return Value an EntityNameplateCustomization

EntityNameplateCustomization.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:
EntityNameplateCustomization:backgroundColor(rgba)
Method Property Fluent Description Representation
rgba accepts a Vector4
Return Value an EntityNameplateCustomization
overload 2:
EntityNameplateCustomization: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 an EntityNameplateCustomization

EntityNameplateCustomization.outlineColor

Sets the color used for the outline in the outline mode
overload 1:
EntityNameplateCustomization:outlineColor(color)
Method Property Fluent Description Representation
color accepts a Vector3
Return Value an EntityNameplateCustomization
overload 2:
EntityNameplateCustomization:outlineColor(r, g, b)
Method Property Fluent Description Representation
r accepts a Number
g accepts a Number
b accepts a Number
Return Value an EntityNameplateCustomization

EntityNameplateCustomization.pos

Sets the position offset of the nameplate, in world coordinates
overload 1:
EntityNameplateCustomization:pos(pos)
Method Property Fluent Description Representation
pos accepts a Vector3
Return Value an EntityNameplateCustomization
overload 2:
EntityNameplateCustomization:pos(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value an EntityNameplateCustomization

EntityNameplateCustomization.pivot

Sets the pivot of the nameplate, in world coordinates
overload 1:
EntityNameplateCustomization:pivot(pivot)
Method Property Fluent Description Representation
pivot accepts a Vector3
Return Value an EntityNameplateCustomization
overload 2:
EntityNameplateCustomization:pivot(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value an EntityNameplateCustomization

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

EntityNameplateCustomization.outline

Sets whether or not the nameplate should have outline
Incompatible with "shadow"
overload 1:
EntityNameplateCustomization:outline(outline)
Method Property Fluent Description Representation
outline accepts a Boolean
Return Value an EntityNameplateCustomization

EntityNameplateCustomization.shadow

Sets whether or not the nameplate should have shadow
Incompatible with "outline"
overload 1:
EntityNameplateCustomization:shadow(shadow)
Method Property Fluent Description Representation
shadow accepts a Boolean
Return Value an EntityNameplateCustomization
a a