Placeholders

Placeholders

This page lists all available NClaim placeholders for use with PlaceholderAPI, along with example usages and explanations.

---

Player Placeholders

Placeholder	Description	Example Usage (PAPI)
%nclaim_player_balance%	Shows the player's current balance	%nclaim_player_balance%

---

Config Placeholders

Retrieve values directly from your config file.

Placeholder Format	Description	Example Usage
%nclaim_get_string_{path}%	Gets a string value	%nclaim_get_string_prefix% (returns prefix string)
%nclaim_get_int_{path}%	Gets an integer value	%nclaim_get_int_autoSave%
%nclaim_get_boolean_{path}%	Gets a boolean value	%nclaim_get_boolean_database_enabled%
%nclaim_get_list_{path}_{index}%	Gets a value from a string list by index	%nclaim_get_list_motd_0%

---

Claim Value Placeholders

Display value of claims or chunks.

Placeholder Format	Description	Example Usage
%nclaim_claim_main_value_{world}_{chunkX}_{chunkZ}%	Value of the main chunk	%nclaim_claim_main_value_world_0_0%
%nclaim_claim_total_value_{world}_{chunkX}_{chunkZ}%	Total value of all chunks in the claim	%nclaim_claim_total_value_world_0_0%
%nclaim_block_value_{material}%	Value of a specific block type	%nclaim_block_value_DIAMOND_BLOCK%

---

Claim Info Placeholders

Get information about a claim for a specific chunk.

Placeholder Format	Description	Example Usage
%nclaim_expiration_{world}_{chunkX}_{chunkZ}%	Time left until claim expiration	%nclaim_expiration_world_0_0%
%nclaim_owner_{world}_{chunkX}_{chunkZ}%	Owner of the claim	%nclaim_owner_world_0_0%
%nclaim_coop_count_{world}_{chunkX}_{chunkZ}%	Number of coop players in the claim	%nclaim_coop_count_world_0_0%
%nclaim_total_size_{world}_{chunkX}_{chunkZ}%	Total size (number of chunks) in the claim	%nclaim_total_size_world_0_0%

---

Error Handling

• If the placeholder returns "Invalid format", "Invalid Index", or "Invalid material" double-check your parameters.
• Coordinates (chunkX, chunkZ) must be integers.
• world must be the exact name of the world.

---

Notes

• Placeholders are used with PlaceholderAPI.
• Replace {world}, {chunkX}, {chunkZ}, {material}, {path}, and {index} with your own values.
• Example: To show the claim owner's name for chunk 5, -2 in world world, use %nclaim_owner_world_5_-2%.
• For block names, use uppercase and underscores (e.g., DIAMOND_BLOCK).

---

If you need custom placeholders or further help, open an issue or contact support!