listFiles
action_wheel
Action
BlockRaycastTypes A nameplate customization that is specialized for entities 
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: Vector4): EntityNameplateCustomization | Method Property | Fluent Description | Representation |
|---|---|---|
| rgba accepts | typings.2002444081||
| Return Value | typings.1163167243
overload 2:
EntityNameplateCustomization.backgroundColor(r: Number, g: Number, b: Number, a: Number): EntityNameplateCustomization | Method Property | Fluent Description | Representation |
|---|---|---|
| r accepts | typings.-1950496919||
| g accepts | typings.-1950496919||
| b accepts | typings.-1950496919||
| a accepts | typings.-1950496919||
| Return Value | typings.1163167243
Gets the set color of the nameplate background
overload 1:
EntityNameplateCustomization.getBackgroundColor(): Vector4 | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.2002444081
Gets the lighting override value
overload 1:
EntityNameplateCustomization.getLight(): Vector2 | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.2002444079
Gets the pivot of the nameplate, in world coordinates
overload 1:
EntityNameplateCustomization.getPivot(): Vector3 | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.2002444080
Gets the position offset of the nameplate, in world coordinates
overload 1:
EntityNameplateCustomization.getPos(): Vector3 | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.2002444080
Gets scale factor of the nameplate
overload 1:
EntityNameplateCustomization.getScale(): Vector3 | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.2002444080
The text to use in this nameplate
overload 1:
EntityNameplateCustomization.getText(): String | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1808118735
No description available
figura.docs.nameplate_entity.has_outline
overload 1:
EntityNameplateCustomization.hasOutline(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Gets whether or not the nameplate should have shadow
overload 1:
EntityNameplateCustomization.hasShadow(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Gets whether or not the nameplate should be rendered
overload 1:
EntityNameplateCustomization.isVisible(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
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: Vector2): EntityNameplateCustomization | Method Property | Fluent Description | Representation |
|---|---|---|
| light accepts | typings.2002444079||
| Return Value | typings.1163167243
overload 2:
EntityNameplateCustomization.light(blockLight: Integer, skyLight: Integer): EntityNameplateCustomization | Method Property | Fluent Description | Representation |
|---|---|---|
| blockLight accepts | typings.-672261858||
| skyLight accepts | typings.-672261858||
| Return Value | typings.1163167243
Sets whether or not the nameplate should have outline
Incompatible with "shadow"
overload 1:
EntityNameplateCustomization.outline(outline: Boolean): EntityNameplateCustomization | Method Property | Fluent Description | Representation |
|---|---|---|
| outline accepts | typings.1729365000||
| Return Value | typings.1163167243
Sets the color used for the outline in the outline mode
overload 1:
EntityNameplateCustomization.outlineColor(color: Vector3): EntityNameplateCustomization | Method Property | Fluent Description | Representation |
|---|---|---|
| color accepts | typings.2002444080||
| Return Value | typings.1163167243
overload 2:
EntityNameplateCustomization.outlineColor(r: Number, g: Number, b: Number): EntityNameplateCustomization | Method Property | Fluent Description | Representation |
|---|---|---|
| r accepts | typings.-1950496919||
| g accepts | typings.-1950496919||
| b accepts | typings.-1950496919||
| Return Value | typings.1163167243
Sets the pivot of the nameplate, in world coordinates
overload 1:
EntityNameplateCustomization.pivot(pivot: Vector3): EntityNameplateCustomization | Method Property | Fluent Description | Representation |
|---|---|---|
| pivot accepts | typings.2002444080||
| Return Value | typings.1163167243
overload 2:
EntityNameplateCustomization.pivot(x: Number, y: Number, z: Number): EntityNameplateCustomization | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | typings.-1950496919||
| y accepts | typings.-1950496919||
| z accepts | typings.-1950496919||
| Return Value | typings.1163167243
Sets the position offset of the nameplate, in world coordinates
overload 1:
EntityNameplateCustomization.pos(pos: Vector3): EntityNameplateCustomization | Method Property | Fluent Description | Representation |
|---|---|---|
| pos accepts | typings.2002444080||
| Return Value | typings.1163167243
overload 2:
EntityNameplateCustomization.pos(x: Number, y: Number, z: Number): EntityNameplateCustomization | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | typings.-1950496919||
| y accepts | typings.-1950496919||
| z accepts | typings.-1950496919||
| Return Value | typings.1163167243
Sets the scale factor of the nameplate
overload 1:
EntityNameplateCustomization.scale(scale: Vector3): EntityNameplateCustomization | Method Property | Fluent Description | Representation |
|---|---|---|
| scale accepts | typings.2002444080||
| Return Value | typings.1163167243
overload 2:
EntityNameplateCustomization.scale(x: Number, y: Number, z: Number): EntityNameplateCustomization | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | typings.-1950496919||
| y accepts | typings.-1950496919||
| z accepts | typings.-1950496919||
| Return Value | typings.1163167243
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: Vector4): EntityNameplateCustomization | Method Property | Fluent Description | Representation |
|---|---|---|
| rgba accepts | typings.2002444081||
| Return Value | typings.1163167243
overload 2:
EntityNameplateCustomization.setBackgroundColor(r: Number, g: Number, b: Number, a: Number): EntityNameplateCustomization | Method Property | Fluent Description | Representation |
|---|---|---|
| r accepts | typings.-1950496919||
| g accepts | typings.-1950496919||
| b accepts | typings.-1950496919||
| a accepts | typings.-1950496919||
| Return Value | typings.1163167243
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: Vector2): EntityNameplateCustomization | Method Property | Fluent Description | Representation |
|---|---|---|
| light accepts | typings.2002444079||
| Return Value | typings.1163167243
overload 2:
EntityNameplateCustomization.setLight(blockLight: Integer, skyLight: Integer): EntityNameplateCustomization | Method Property | Fluent Description | Representation |
|---|---|---|
| blockLight accepts | typings.-672261858||
| skyLight accepts | typings.-672261858||
| Return Value | typings.1163167243
Sets whether or not the nameplate should have outline
Incompatible with "shadow"
overload 1:
EntityNameplateCustomization.setOutline(outline: Boolean): EntityNameplateCustomization | Method Property | Fluent Description | Representation |
|---|---|---|
| outline accepts | typings.1729365000||
| Return Value | typings.1163167243
Sets the color used for the outline in the outline mode
overload 1:
EntityNameplateCustomization.setOutlineColor(color: Vector3): EntityNameplateCustomization | Method Property | Fluent Description | Representation |
|---|---|---|
| color accepts | typings.2002444080||
| Return Value | typings.1163167243
overload 2:
EntityNameplateCustomization.setOutlineColor(r: Number, g: Number, b: Number): EntityNameplateCustomization | Method Property | Fluent Description | Representation |
|---|---|---|
| r accepts | typings.-1950496919||
| g accepts | typings.-1950496919||
| b accepts | typings.-1950496919||
| Return Value | typings.1163167243
Sets the pivot of the nameplate, in world coordinates
overload 1:
EntityNameplateCustomization.setPivot(pivot: Vector3): EntityNameplateCustomization | Method Property | Fluent Description | Representation |
|---|---|---|
| pivot accepts | typings.2002444080||
| Return Value | typings.1163167243
overload 2:
EntityNameplateCustomization.setPivot(x: Number, y: Number, z: Number): EntityNameplateCustomization | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | typings.-1950496919||
| y accepts | typings.-1950496919||
| z accepts | typings.-1950496919||
| Return Value | typings.1163167243
Sets the position offset of the nameplate, in world coordinates
overload 1:
EntityNameplateCustomization.setPos(pos: Vector3): EntityNameplateCustomization | Method Property | Fluent Description | Representation |
|---|---|---|
| pos accepts | typings.2002444080||
| Return Value | typings.1163167243
overload 2:
EntityNameplateCustomization.setPos(x: Number, y: Number, z: Number): EntityNameplateCustomization | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | typings.-1950496919||
| y accepts | typings.-1950496919||
| z accepts | typings.-1950496919||
| Return Value | typings.1163167243
Sets the scale factor of the nameplate
overload 1:
EntityNameplateCustomization.setScale(scale: Vector3): EntityNameplateCustomization | Method Property | Fluent Description | Representation |
|---|---|---|
| scale accepts | typings.2002444080||
| Return Value | typings.1163167243
overload 2:
EntityNameplateCustomization.setScale(x: Number, y: Number, z: Number): EntityNameplateCustomization | Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | typings.-1950496919||
| y accepts | typings.-1950496919||
| z accepts | typings.-1950496919||
| Return Value | typings.1163167243
Sets whether or not the nameplate should have shadow
Incompatible with "outline"
overload 1:
EntityNameplateCustomization.setShadow(shadow: Boolean): EntityNameplateCustomization | Method Property | Fluent Description | Representation |
|---|---|---|
| shadow accepts | typings.1729365000||
| Return Value | typings.1163167243
The text to use in this nameplate
overload 1:
EntityNameplateCustomization.setText(text: String): NameplateCustomization | Method Property | Fluent Description | Representation |
|---|---|---|
| text accepts | typings.-1808118735||
| Return Value | typings.1807280712
Sets whether or not the nameplate should be rendered
overload 1:
EntityNameplateCustomization.setVisible(visible: Boolean): EntityNameplateCustomization | Method Property | Fluent Description | Representation |
|---|---|---|
| visible accepts | typings.1729365000||
| Return Value | typings.1163167243
Sets whether or not the nameplate should have shadow
Incompatible with "outline"
overload 1:
EntityNameplateCustomization.shadow(shadow: Boolean): EntityNameplateCustomization | Method Property | Fluent Description | Representation |
|---|---|---|
| shadow accepts | typings.1729365000||
| Return Value | typings.1163167243
Sets whether or not the nameplate should be rendered
overload 1:
EntityNameplateCustomization.visible(visible: Boolean): EntityNameplateCustomization | Method Property | Fluent Description | Representation |
|---|---|---|
| visible accepts | typings.1729365000||
| Return Value | typings.1163167243