Skip to main content

EntityNameplateCustomization

Nameplate customization that applies to Entity (the nameplate above your head)

setText(string)​

Sets the text of the nameplate

nameplate.Entity:setText("Hi")

getText()​

Gets the text of the nameplate as set by setText

nameplate.Entity:getText()

setVisible(bool)​

Sets the visibility of the nameplate

nameplate.Entity:setVisible(false)

isVisible()​

Gets the visibility of the nameplate

nameplate.Entity:isVisible()

setPos(Vector3)​

Sets the position of the nameplate in blocks, this is an offset of the pivot location so 0,0,0 is the pivot's location

nameplate.Entity:setPos(0, 1, 0)

getPos()​

Gets the position of the nameplate

nameplate.Entity:getPos()

setScale(Vector3)​

Sets the scale of the nameplate

nameplate.Entity:setScale(2, 2, 2)

getScale()​

Gets the scale of the nameplate

nameplate.Entity:getScale()

setPivot(Vector3)​

Sets the pivot of the nameplate

nameplate.Entity:setPivot(0, 3, 0)

getPivot()​

Gets the pivot of the nameplate

nameplate.Entity:getPivot()

setLight(Vector2)​

Sets the brightness of the nameplate text, the first arg is blockLight and the second arg is skyLight

nameplate.Entity:setLight(15, 15)

getLight()​

Gets the brightness of the nameplate text as set by setLight

nameplate.Entity:getLight()

setOutline(bool)​

Sets if the nameplate text should be outlined. Incompatible with setShadow

nameplate.Entity:setOutline(true)

hasOutline()​

Gets if the nameplate has an outline

nameplate.Entity:hasOutline()

setOutlineColor(Vector3)​

Sets the color used for the outline in rgb format and 0-1 ex: (100/255,100/255,100/255)

nameplate.Entity:setOutlineColor(100 / 255, 100 / 255, 100 / 255)

setBackgroundColor(Vector4)​

Sets the color of the nameplate background, in rgba format and 0-1 ex: (100/255,100/255,100/255,100/255)

nameplate.Entity:setBackgroundColor(100 / 255, 100 / 255, 100 / 255)

getBackgroundColor()​

Gets the color of the nameplate background as set by setBackgroundColor

nameplate.Entity:getBackgroundColor()

setShadow(bool)​

Sets if the nameplate text has a shadow

nameplate.Entity:setShadow(true)

hasShadow()​

Gets if the nameplate has a shadow

nameplate.Entity:hasShadow()