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

EntityNameplateCustomization.getScale

Gets scale factor of the nameplate
overload 1:
EntityNameplateCustomization:getScale()
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 nil
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 nil

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(rgb)
Method Property Fluent Description Representation
rgb accepts a Vector3
Return Value nil
overload 2:
EntityNameplateCustomization:setBackgroundColor(rgba)
Method Property Fluent Description Representation
rgba accepts a Vector4
Return Value nil
overload 3:
EntityNameplateCustomization:setBackgroundColor(rgb, a)
Method Property Fluent Description Representation
rgb accepts a Vector3
a accepts a Number
Return Value nil
overload 4:
EntityNameplateCustomization:setBackgroundColor(r, g, b)
Method Property Fluent Description Representation
r accepts a Number
g accepts a Number
b accepts a Number
Return Value nil
overload 5:
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 nil

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

EntityNameplateCustomization.visible

figura.docs.nameplate_entity.visible
field signature:
visible
Method Property Fluent Description Representation
Field Type a Boolean

EntityNameplateCustomization.shadow

figura.docs.nameplate_entity.shadow
field signature:
shadow
Method Property Fluent Description Representation
Field Type a Boolean

EntityNameplateCustomization.outline

figura.docs.nameplate_entity.outline
field signature:
outline
Method Property Fluent Description Representation
Field Type a Boolean
a a