StellaStella

Placeholders

##Introduction

Placeholders let you display dynamic information about teams, players and the mod's global state anywhere that supports the Text Placeholder API — chat, scoreboards, tab list, custom messages, etc.

INFO

Requires Patbox's Text Placeholder API to be installed (it is not PlaceholderAPI). Stella registers the stella placeholders automatically when the Text Placeholder API is detected — no extra setup needed.

WARNING

On Fabric the placeholder format differs from the Paper version:

  • The separator is a colon: %stella_team%%stella:team%.
  • Arguments are space-separated instead of joined with _: %stella_exists_admins%%stella:exists admins%.

The same 21 placeholders are available — only the format changes.

When a value can't be resolved (unknown team or player), the placeholder returns the literal string null.

##Supported Placeholders

###Global

Placeholder Description Returned Format
%stella:total_teams% Total number of registered teams. Integer (e.g. 3)
%stella:total_players% Number of distinct players that belong to at least one team. Integer (e.g. 12)
%stella:all_teams% Comma-separated list of every team id. String (e.g. red, blue, yellow)

###About the player viewing the placeholder

Placeholder Description Returned Format
%stella:team% Id of the player's main team (highest priority). String or null
%stella:team_display% Display name of the player's main team. String or null
%stella:team_priority% Priority of the player's main team. Integer or null
%stella:team_color% Hex color of the player's main team. String or null
%stella:in_any_team% Whether the player belongs to any team. Boolean (true / false)
%stella:team_count% How many teams the player belongs to. Integer
%stella:teams_list% Comma-separated list of every team the player belongs to, highest priority first. String or none
%stella:in_team <team>% Whether the player belongs to a specific team. Boolean (true / false)

###About another player (by name)

Placeholder Description Returned Format
%stella:player_team <player>% Id of <player>'s main team. String or null
%stella:player_team_display <player>% Display name of <player>'s main team. String or null
%stella:player_team_count <player>% How many teams <player> belongs to. Integer or null
%stella:player_in_any_team <player>% Whether <player> belongs to any team. Boolean or null
%stella:player_in_team <player>:<team>% Whether <player> belongs to <team>. Note the : between the two arguments. Boolean or null

###About a specific team

Placeholder Description Returned Format
%stella:exists <team>% Whether <team> exists. Boolean (true / false)
%stella:display <team>% Display name of <team>. String or null
%stella:priority <team>% Priority of <team>. Integer or null
%stella:color <team>% Hex color of <team>. String or null
%stella:size <team>% Number of members in <team>. Integer or null

##How to use these placeholders

Drop the placeholder anywhere the Text Placeholder API processes input. Stella replaces it with the live value at render time.

  • The "player viewing" placeholders need a player context — they only resolve when one exists (chat, player-bound scoreboards, etc.). In console contexts they return null.
  • The "about another player" and "about a team" placeholders are context-free and work anywhere.

##Example usage

Your team: %stella:team% (priority %stella:team_priority%)
Teams: %stella:all_teams% — %stella:total_players% players in total
Is xDrygo in red? %stella:player_in_team xDrygo:red%
Does the admins team exist? %stella:exists admins%
WARNING

The exact argument separator (assumed to be a space) should be confirmed against a running server before publishing.