Skip to main content

๐Ÿ€ CustomNameplates

This page covers the compatibility with CustomNameplates.

Conditionsโ€‹

Actionsโ€‹

Set Nameplateโ€‹

Applies a specific CustomNameplate to a designated target.

Syntax: customNameplatesApplyNameplate <id>

ParameterSyntaxDefault ValueExplanation
idnameplatenoneThe unique identifier (ID) of the nameplate to be applied.
Example
actions:
applyAngelNameplate: customNameplatesApplyNameplate angel

Check Has Nameplateโ€‹

Verifies whether the player has permission for a specific nameplate.

Syntax: customNameplatesHasNameplate <nameplate> [ignore]

ParameterSyntaxDefault ValueExplanation
nameplateStringnoneThe ID of the nameplate to check for permission.
ignoreignore:BooleanfalseThe option to bypass the existence check in the API.
Example
conditions:
hasAngelNameplate: customNameplatesHasNameplate angel
# Bypassing the existence check even if 'abc' is missing in the settings.
hasAbcNameplate: customNameplatesHasNameplate abc ignore:true
tip
  • ignore:true: Skip the existence check (Permission only).
  • ignore:false: Strict check (API existence + Permission).

Check Equipped Nameplateโ€‹

Verifies whether the player is currently wearing a specific nameplate.

Syntax: customNameplatesEquippedNameplate <nameplate>

ParameterSyntaxDefault ValueExplanation
nameplateStringnoneThe target nameplate ID for the equipment check.
Example
conditions:
isSignNameplate: customNameplatesEquippedNameplate sign

Check Has Bubbleโ€‹

Verifies whether the player has permission for a specific chat bubble.

Syntax: customNameplatesHasBubble <bubble> [ignore]

ParameterSyntaxDefault ValueExplanation
bubbleStringnoneThe ID of the chat bubble to check for permission.
ignoreignore:BooleanfalseThe option to bypass the existence check in the API.
Example
conditions:
hasAdminBubble: customNameplatesHasBubble admin
# Checking permission regardless of the bubble's registration in the API.
hasAbcBubble: customNameplatesHasBubble abc ignore:true
tip
  • ignore:true: Skip the existence check (Permission only).
  • ignore:false: Strict check (API existence + Permission).

Check Equipped Bubbleโ€‹

Verifies whether the player is currently using a specific chat bubble.

Syntax: customNameplatesEquippedBubble <bubble>

ParameterSyntaxDefault ValueExplanation
bubbleStringnoneThe target chat bubble ID for the equipment check.
Example
conditions:
isChatBubble: customNameplatesEquippedBubble chat