Placeholders
Placeholders allow for certain values to be used in certain text inputs in Housing. These placeholders are then automatically formatted into the associated value, and will update whenever the placeholder value is changed.
The command /placeholders displays a list of every Housing placeholder in chat. The command /testplaceholder <placeholder> serves as a text input, and can be used to see the formatting of potential placeholders in chat.
Placeholder List
| Placeholder | Type | Notes |
|---|---|---|
| %server.name% | String | - |
| %server.shortname% | String | - |
| %player.name% | String | - |
| %player.ping% | Formatted Integer | Contains the unit of measurement "ms". Changes color based on the player's current ping: green at under 100ms, yellow at under 250ms, and red at over 250ms. |
| %player.health% | Integer | - |
| %player.maxhealth% | Integer | - |
| %player.hunger% | Integer | - |
| %player.experience% | Integer | - |
| %player.level% | Integer | - |
| %player.version% | String | - |
| %player.protocol% | Integer | - |
| %player.gamemode% | String | - |
| %player.region.name% | String | - |
| %player.location.x% | Integer | - |
| %player.location.y% | Integer | - |
| %player.location.z% | Integer | - |
| %player.location.pitch% | Integer | - |
| %player.location.yaw% | Integer | - |
| %player.group.name% | String | - |
| %player.group.tag% | String | - |
| %player.group.priority% | Integer | - |
| %player.group.color% | Color | - |
| %player.team.name% | String | - |
| %player.team.tag% | String | - |
| %player.team.color% | Color | - |
| %player.team.players/<team name>% | Integer | - |
| %house.name% | String | - |
| %house.guests% | Integer | Counts players from every group except for the owner. |
| %house.cookies% | Integer | Only includes cookies earned within the current week. |
| %house.visitingrules% | String | - |
| %house.players% | Integer | - |
| %date.day/[timezone]% | Formatted Integer | Has leading zeros. See the timezones page for info on Housing timezones. |
| %date.month/[timezone]% | Formatted Integer | Has leading zeros. See the timezones page for info on Housing timezones. |
| %date.year/[timezone]% | Formatted Integer | Has leading zeros. See the timezones page for info on Housing timezones. |
| %date.hour/[timezone]% | Formatted Integer | Has leading zeros. See the timezones page for info on Housing timezones. |
| %date.minute/[timezone]% | Formatted Integer | Has leading zeros. See the timezones page for info on Housing timezones. |
| %date.seconds/[timezone]% | Formatted Integer | Has leading zeros. See the timezones page for info on Housing timezones. |
| %date.unix% | Integer | See Unix Time. |
| %random.int/<inclusive origin> <exclusive bound>% | Integer | "Exclusive bound" means that the second parameter is not a possible output of this placeholder. |
| %stat.player/<key>% | Integer | - |
| %stat.global/<key>% | Integer | - |
| %stat.team/<key> <team name>% | Integer | If the "team name" is omitted, it will default to the player's current team. |
Placeholder Types
There are currently 4 types of placeholder outputs in Housing: integer, formatted integer, string, and color.
- Integer type placeholders will format into a simple number, and can be used in integer inputs (such as the Change Player Stat Action)
- Formatted Integer placeholders format into a slightly edited number. Integers may be formatted with: automatic coloring, a unit of measurement, or appended zeros. These placeholders can still be used in integer inputs.
- String type placeholders will format into a simple length of text, and cannot be used in integer inputs. These can sometimes be colored, but will always contain text.
- Color type placeholders will format into an invisible state, only changing the color of text which comes after the placeholder. This is done with color codes.
Legacy Placeholders
There are various placeholders that are not present in the /placeholders list, but which are still functional in Housing. These placeholders are deprecated, and were all replaced with new placeholders in the March 20th, 2023 Update. These placeholders are shorter than their standardized counterparts, and this can be useful in situations where there is limited available text space.
Legacy placeholders all use double percentage symbols (%%) on either side, instead of the single symbol used in modern placeholders.
| Deprecated Placeholder | Associated Standardized Placeholder |
|---|---|
| %%player%% | %player.name% |
| %%house%% | %house.name% |
| %%guests%% | %house.guests% |
| %%cookies%% | %house.cookies% |
| %%server%% | %server.name% |
| %%ping%% | %player.ping% |
| %%region%% | %player.region% |
| %%group%% | %player.group% |
| %%stat_<stat key>%% | %stat.player/<stat key>% |
| %%globalstat_<stat key>%% | %stat.global/<stat key>% |