mirror of
https://github.com/PlaceholderAPI/PlaceholderAPI
synced 2026-02-06 12:17:13 +01:00
Compare commits
5 Commits
feature/wi
...
feat/wiki-
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
b0e02d4755 | ||
|
|
13d1ae8336 | ||
|
|
d654cce5c1 | ||
|
|
6b78ec0da2 | ||
|
|
447ccd925c |
@@ -2,27 +2,20 @@ document$.subscribe(async => {
|
|||||||
const api_code = document.querySelectorAll('[data-md-component="api-version"]');
|
const api_code = document.querySelectorAll('[data-md-component="api-version"]');
|
||||||
|
|
||||||
function loadAPIInfo(data) {
|
function loadAPIInfo(data) {
|
||||||
const mcVersion = data["mcVersion"];
|
const version = data["version"];
|
||||||
const hyVersion = data["hyVersion"];
|
const versionToken = "{version}";
|
||||||
|
|
||||||
const mcVersionToken = "{papiVersion}";
|
|
||||||
const hyVersionToken = "{papiHytaleVersion}"
|
|
||||||
for (const codeBlock of api_code) {
|
for (const codeBlock of api_code) {
|
||||||
codeBlock.innerHTML = codeBlock.innerHTML
|
codeBlock.innerHTML = codeBlock.innerHTML.replace(new RegExp(versionToken, 'g'), version);
|
||||||
.replace(new RegExp(mcVersionToken, 'g'), mcVersion)
|
|
||||||
.replace(new RegExp(hyVersionToken, 'g'), hyVersion);
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
async function fetchAPIInfo() {
|
async function fetchAPIInfo() {
|
||||||
const [mcRelease, hyRelease] = await Promise.all([
|
const release = await fetch("https://repo.extendedclip.com/api/maven/latest/version/releases/me/clip/placeholderapi").then(_ => _.json());
|
||||||
fetch("https://repo.extendedclip.com/api/maven/latest/version/releases/me/clip/placeholderapi").then(_ => _.json()),
|
|
||||||
fetch("https://repo.helpch.at/api/maven/latest/version/releases/at/helpch/placeholderapi-hytale").then(_ => _.json())
|
console.log(release)
|
||||||
])
|
|
||||||
|
|
||||||
const data = {
|
const data = {
|
||||||
"mcVersion": mcRelease.version,
|
"version": release.version
|
||||||
"hyVersion": hyRelease.version
|
|
||||||
}
|
}
|
||||||
|
|
||||||
__md_set("__api_tag", data, sessionStorage);
|
__md_set("__api_tag", data, sessionStorage);
|
||||||
@@ -31,7 +24,7 @@ document$.subscribe(async => {
|
|||||||
|
|
||||||
if(location.href.includes("/developers/using-placeholderapi")) {
|
if(location.href.includes("/developers/using-placeholderapi")) {
|
||||||
const cachedApi = __md_get("__api_tag", sessionStorage);
|
const cachedApi = __md_get("__api_tag", sessionStorage);
|
||||||
if ((cachedApi != null) && (cachedApi["mcVersion"])) {
|
if ((cachedApi != null) && (cachedApi["version"])) {
|
||||||
loadAPIInfo(cachedApi);
|
loadAPIInfo(cachedApi);
|
||||||
} else {
|
} else {
|
||||||
fetchAPIInfo();
|
fetchAPIInfo();
|
||||||
|
|||||||
@@ -273,9 +273,6 @@ package com.example.plugin;
|
|||||||
import com.example.plugin.expansion.SomeExpansion;
|
import com.example.plugin.expansion.SomeExpansion;
|
||||||
import com.hypixel.hytale.server.core.plugin.JavaPlugin;
|
import com.hypixel.hytale.server.core.plugin.JavaPlugin;
|
||||||
import com.hypixel.hytale.server.core.plugin.JavaPluginInit;
|
import com.hypixel.hytale.server.core.plugin.JavaPluginInit;
|
||||||
import com.hypixel.hytale.common.plugin.PluginIdentifier;
|
|
||||||
import com.hypixel.hytale.server.core.HytaleServer;
|
|
||||||
|
|
||||||
|
|
||||||
public class SomePlugin extends JavaPlugin {
|
public class SomePlugin extends JavaPlugin {
|
||||||
|
|
||||||
@@ -283,12 +280,7 @@ public class SomePlugin extends JavaPlugin {
|
|||||||
super(init)
|
super(init)
|
||||||
}
|
}
|
||||||
|
|
||||||
@Override
|
// TODO: Example of checking for PAPI and registering expansion
|
||||||
protected void start() {
|
|
||||||
if (HytaleServer.get().getPluginManager().getPlugin(PluginIdentifier.fromString("HelpChat:PlaceholderAPI")) != null) {
|
|
||||||
new SomeExpansion(this).register();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
@@ -6,12 +6,10 @@ description: Guide on how to use PlaceholderAPI in your own plugin.
|
|||||||
|
|
||||||
This page is about using PlaceholderAPI in your own plugin, to either let other plugins use your plugin, or just use placeholders from other plugins in your own.
|
This page is about using PlaceholderAPI in your own plugin, to either let other plugins use your plugin, or just use placeholders from other plugins in your own.
|
||||||
|
|
||||||
Please note, that the examples in this page are only available for **PlaceholderAPI 2.10.0 (1.0.0 for Hytale version) or newer**!
|
Please note, that the examples in this page are only available for **PlaceholderAPI 2.10.0 or higher**!
|
||||||
|
|
||||||
## First steps
|
## First steps
|
||||||
|
|
||||||
### Add PlaceholderAPI to your Project
|
|
||||||
|
|
||||||
Before you can actually make use of PlaceholderAPI, you first have to import it into your project.
|
Before you can actually make use of PlaceholderAPI, you first have to import it into your project.
|
||||||
Use the below code example matching your project type and dependency manager.
|
Use the below code example matching your project type and dependency manager.
|
||||||
|
|
||||||
@@ -28,16 +26,9 @@ Use the below code example matching your project type and dependency manager.
|
|||||||
<dependency>
|
<dependency>
|
||||||
<groupId>me.clip</groupId>
|
<groupId>me.clip</groupId>
|
||||||
<artifactId>placeholderapi</artifactId>
|
<artifactId>placeholderapi</artifactId>
|
||||||
<version>{papiVersion}</version>
|
<version>{version}</version>
|
||||||
<scope>provided</scope>
|
<scope>provided</scope>
|
||||||
</dependency>
|
</dependency>
|
||||||
|
|
||||||
<!-- Optional: Component support on Paper Servers (Since 2.12.0) -->
|
|
||||||
<dependency>
|
|
||||||
<groupId>me.clip</groupId>
|
|
||||||
<artifactId>placeholderapi-paper</artifactId>
|
|
||||||
<version>{papiVersion}</version>
|
|
||||||
<scope>provided</scope>
|
|
||||||
</dependencies>
|
</dependencies>
|
||||||
```
|
```
|
||||||
////
|
////
|
||||||
@@ -51,10 +42,7 @@ repositories {
|
|||||||
}
|
}
|
||||||
|
|
||||||
dependencies {
|
dependencies {
|
||||||
compileOnly 'me.clip:placeholderapi:{papiVersion}'
|
compileOnly 'me.clip:placeholderapi:{version}'
|
||||||
|
|
||||||
// Optional: Component support on Paper Servers (Since 2.12.0)
|
|
||||||
compileOnly 'me.clip:placeholderapi-paper:{papiVersion}'
|
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
////
|
////
|
||||||
@@ -84,7 +72,7 @@ dependencies {
|
|||||||
<dependency>
|
<dependency>
|
||||||
<groupId>at.helpch</groupId>
|
<groupId>at.helpch</groupId>
|
||||||
<artifactId>placeholderapi-hytale</artifactId>
|
<artifactId>placeholderapi-hytale</artifactId>
|
||||||
<version>{papiHytaleVersion}</version>
|
<version>{version}</version>
|
||||||
<scope>provided</scope>
|
<scope>provided</scope>
|
||||||
</dependency>
|
</dependency>
|
||||||
</dependencies>
|
</dependencies>
|
||||||
@@ -103,16 +91,16 @@ repositories {
|
|||||||
dependencies {
|
dependencies {
|
||||||
// Replace {hytaleVersion} with the version you need.
|
// Replace {hytaleVersion} with the version you need.
|
||||||
compileOnly 'com.hypixel.hytale:Server:{hytaleVersion}'
|
compileOnly 'com.hypixel.hytale:Server:{hytaleVersion}'
|
||||||
compileOnly 'at.helpch:placeholderapi-hytale:{papiHytaleVersion}'
|
compileOnly 'at.helpch:placeholderapi-hytale:{version}'
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
////
|
////
|
||||||
///
|
///
|
||||||
|
|
||||||
/// details | What is `{papiVersion}`/`{papiHytaleVersion}`?
|
/// details | What is `{version}`?
|
||||||
type: question
|
type: question
|
||||||
|
|
||||||
Using Javascript, `{papiVersion}` and `{papiHytaleVersion}` is replaced with the latest available API version of PlaceholderAPI for Minecraft and Hytale respectively.
|
Using Javascript, `{version}` is replaced with the latest available API version of PlaceholderAPI.
|
||||||
Should you see the placeholder as-is does it mean that you either block Javascript, or that the version couldn't be obtained in time during page load.
|
Should you see the placeholder as-is does it mean that you either block Javascript, or that the version couldn't be obtained in time during page load.
|
||||||
|
|
||||||
You can always find the latest version matching the API version on the [releases tab](https://github.com/PlaceholderAPI/PlaceholderAPI/releases) of the GitHub Repository.
|
You can always find the latest version matching the API version on the [releases tab](https://github.com/PlaceholderAPI/PlaceholderAPI/releases) of the GitHub Repository.
|
||||||
@@ -255,20 +243,10 @@ A full guide on how to create expansions can be found on the [Creating a Placeho
|
|||||||
## Setting placeholders in your plugin
|
## Setting placeholders in your plugin
|
||||||
|
|
||||||
PlaceholderAPI offers the ability, to automatically parse placeholders from other plugins within your own plugin, giving the ability for your plugin to support thousands of other placeholders without depending on each plugin individually.
|
PlaceholderAPI offers the ability, to automatically parse placeholders from other plugins within your own plugin, giving the ability for your plugin to support thousands of other placeholders without depending on each plugin individually.
|
||||||
To use placeholders from other plugins in your own plugin, you simply have to [(soft)depend on PlaceholderAPI](#set-placeholderapi-as-softdepend) and use the `setPlaceholders` method.
|
To use placeholders from other plugins in our own plugin, we simply have to [(soft)depend on PlaceholderAPI](#set-placeholderapi-as-softdepend) and use the `setPlaceholders` method.
|
||||||
|
|
||||||
It is also important to point out, that any required plugin/dependency for an expansion has to be on the server and enabled, or the `setPlaceholders` method will just return the placeholder itself (do nothing).
|
It is also important to point out, that any required plugin/dependency for an expansion has to be on the server and enabled, or the `setPlaceholders` method will just return the placeholder itself (do nothing).
|
||||||
|
|
||||||
/// info | New since 2.12.0
|
|
||||||
Starting with version 2.12.0 is it now possible to provide Components from the Adventure library to have placeholders parsed in.
|
|
||||||
|
|
||||||
In order to use this new feature are the following things required to be true:
|
|
||||||
|
|
||||||
- You depend on `placeholderapi-paper` and not just `placeholderapi`
|
|
||||||
- Your plugin runs on a Paper-based Server. Spigot-based servers will not work!
|
|
||||||
- You use `PAPIComponent` instead of `PlaceholderAPI` to parse Components.
|
|
||||||
///
|
|
||||||
|
|
||||||
/// tab | Spigot, Paper, ...
|
/// tab | Spigot, Paper, ...
|
||||||
|
|
||||||
The following is an example plugin that sends `%player_name% joined the server! They are rank %vault_rank%` as the Join message, having the placeholders be replaced by PlaceholderAPI.
|
The following is an example plugin that sends `%player_name% joined the server! They are rank %vault_rank%` as the Join message, having the placeholders be replaced by PlaceholderAPI.
|
||||||
@@ -323,14 +301,11 @@ public class JoinExample extends JavaPlugin implements Listener {
|
|||||||
|
|
||||||
Example output: `Notch joined the server! They are rank Admin`
|
Example output: `Notch joined the server! They are rank Admin`
|
||||||
|
|
||||||
//// info | New since 2.12.0
|
|
||||||
Using `placeholderapi-papi` and `PAPIComponents` instead of `PlaceholderAPI` allows you to parse placeholders inside Adventure Components.
|
|
||||||
////
|
|
||||||
///
|
///
|
||||||
|
|
||||||
/// tab | Hytale
|
/// tab | Hytale
|
||||||
|
|
||||||
The following is an example plugin that sends `Welcome %player_name%!` as the Join message, having the placeholders be replaced by PlaceholderAPI.
|
The following is an example plugin that sends `%player_name% joined the server! They are rank %vault_rank%` as the Join message, having the placeholders be replaced by PlaceholderAPI.
|
||||||
|
|
||||||
``` { .java .annotate title="JoinExample.java" }
|
``` { .java .annotate title="JoinExample.java" }
|
||||||
packate com.example.plugin;
|
packate com.example.plugin;
|
||||||
@@ -341,7 +316,6 @@ import com.hypixel.hytale.server.core.event.events.player.PlayerReadyEvent;
|
|||||||
import com.hypixel.hytale.server.core.Message;
|
import com.hypixel.hytale.server.core.Message;
|
||||||
import com.hypixel.hytale.server.core.plugin.JavaPlugin;
|
import com.hypixel.hytale.server.core.plugin.JavaPlugin;
|
||||||
import com.hypixel.hytale.server.core.plugin.JavaPluginInit;
|
import com.hypixel.hytale.server.core.plugin.JavaPluginInit;
|
||||||
import com.hypixel.hytale.server.core.universe.Universe;
|
|
||||||
|
|
||||||
public class JoinExample extends JavaPlugin {
|
public class JoinExample extends JavaPlugin {
|
||||||
|
|
||||||
@@ -352,14 +326,13 @@ public class JoinExample extends JavaPlugin {
|
|||||||
@Override
|
@Override
|
||||||
protected void setup() {
|
protected void setup() {
|
||||||
// (1)
|
// (1)
|
||||||
Universe.get().getWorlds().keySet().forEach(name -> getEventRegistry().register(PlayerReadyEvent.class, name, this::onPlayerReady));
|
getEventRegistry().registerGlobal(PlayerReadyEvent.class, this::onPlayerReady);
|
||||||
}
|
}
|
||||||
|
|
||||||
public void onPlayerReady(PlayerReadyEvent event) {
|
public void onPlayerReady(PlayerReadyEvent event) {
|
||||||
Player player = event.getPlayer();
|
Player player = event.getPlayer();
|
||||||
// (2)
|
// (2)
|
||||||
player.sendMessage(PlaceholderAPI.setPlaceholders(Message.raw("Welcome %player_name%!"), player))
|
player.sendMessage(PlaceholderAPI.setPlaceholders(Message.raw("Welcome %player_name%!"), player))
|
||||||
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -22,7 +22,7 @@ When a plugin or [`/papi parse me %placeholder%`](users/commands.md#papi-parse)
|
|||||||
Some expansions may not be integrated into a plugin or don't even have a plugin to depend on, meaning that they may be their own separate jar file that you have to download.
|
Some expansions may not be integrated into a plugin or don't even have a plugin to depend on, meaning that they may be their own separate jar file that you have to download.
|
||||||
Such expansions can usually be found on the eCloud of PlaceholderAPI and be downloaded using the [`/papi ecloud download <expansion>`](users/commands.md#papi-ecloud-download) command.
|
Such expansions can usually be found on the eCloud of PlaceholderAPI and be downloaded using the [`/papi ecloud download <expansion>`](users/commands.md#papi-ecloud-download) command.
|
||||||
|
|
||||||
Whether an expansion is available on the eCloud or not can be found out in the [Placeholder List](users/placeholder-list.md) with any expansion displaying a papi command being downlodable.
|
Whether an expansion is available on the eCloud or not can be found out in the [Placeholder List](users/placeholder-list/index.md) with any expansion displaying a papi command being downlodable.
|
||||||
|
|
||||||
- ### Plugin actually supports PlaceholderAPI
|
- ### Plugin actually supports PlaceholderAPI
|
||||||
|
|
||||||
@@ -37,7 +37,7 @@ When a plugin or [`/papi parse me %placeholder%`](users/commands.md#papi-parse)
|
|||||||
Double-check that the placeholder you set doesn't contain a typo. You can use [`/papi ecloud placeholders <expansion>`](users/commands.md#papi-ecloud-placeholders) (replace `<expansion>` with the name of the expansion) to get a list of all the placeholders the expansion may have.
|
Double-check that the placeholder you set doesn't contain a typo. You can use [`/papi ecloud placeholders <expansion>`](users/commands.md#papi-ecloud-placeholders) (replace `<expansion>` with the name of the expansion) to get a list of all the placeholders the expansion may have.
|
||||||
Keep in mind that this only works for separate expansions on the eCloud and not for those that are loaded by plugins.
|
Keep in mind that this only works for separate expansions on the eCloud and not for those that are loaded by plugins.
|
||||||
|
|
||||||
Additionally can the placeholder list from the eCloud be outdated. It is recommended to check the [Placeholder List](users/placeholder-list.md) or see if there is any documentation for the placeholders you want to use.
|
Additionally can the placeholder list from the eCloud be outdated. It is recommended to check the [Placeholder List](users/placeholder-list/index.md) or see if there is any documentation for the placeholders you want to use.
|
||||||
|
|
||||||
- ### Plugin is enabled
|
- ### Plugin is enabled
|
||||||
|
|
||||||
|
|||||||
@@ -19,7 +19,7 @@ It also has a community-curated list of all available Placeholder expansions and
|
|||||||
|
|
||||||
- [:octicons-chevron-right-16: Commands](users/commands.md)
|
- [:octicons-chevron-right-16: Commands](users/commands.md)
|
||||||
- [:octicons-chevron-right-16: Using Placeholders](users/using-placeholders.md)
|
- [:octicons-chevron-right-16: Using Placeholders](users/using-placeholders.md)
|
||||||
- [:octicons-chevron-right-16: Placeholder List](users/placeholder-list.md)
|
- [:octicons-chevron-right-16: Placeholder List](users/placeholder-list/index.md)
|
||||||
- [:octicons-chevron-right-16: Plugins using PlaceholderAPI](users/plugins-using-placeholderapi.md)
|
- [:octicons-chevron-right-16: Plugins using PlaceholderAPI](users/plugins-using-placeholderapi.md)
|
||||||
|
|
||||||
- ### :material-file-code: Dev Guides
|
- ### :material-file-code: Dev Guides
|
||||||
|
|||||||
@@ -30,9 +30,9 @@ The pages listed under this section are meant for server owners who want to use
|
|||||||
|
|
||||||
----
|
----
|
||||||
|
|
||||||
Community-curated list of available PlaceholderExpansions and their placeholders.
|
Community-curated lists of available Placeholder Expansions and their placeholders for the Minecraft and Hytale versions of PlaceholderAPI.
|
||||||
|
|
||||||
- [:octicons-chevron-right-16: Go to Page](placeholder-list.md)
|
- [:octicons-chevron-right-16: Go to Page](placeholder-list/index.md)
|
||||||
|
|
||||||
- ### Plugins using PlaceholderAPI
|
- ### Plugins using PlaceholderAPI
|
||||||
|
|
||||||
@@ -42,4 +42,4 @@ The pages listed under this section are meant for server owners who want to use
|
|||||||
|
|
||||||
- [:octicons-chevron-right-16: Go to Page](plugins-using-placeholderapi.md)
|
- [:octicons-chevron-right-16: Go to Page](plugins-using-placeholderapi.md)
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|||||||
283
docs/users/placeholder-list/hytale.md
Normal file
283
docs/users/placeholder-list/hytale.md
Normal file
@@ -0,0 +1,283 @@
|
|||||||
|
# Hytale
|
||||||
|
|
||||||
|
This is a list of all available placeholders for the Hytale version of PlaceholderAPI.
|
||||||
|
For the Minecraft version, visit [this page](minecraft.md).
|
||||||
|
|
||||||
|
A download-command may be found in the infobox located below the title of the Expansion.
|
||||||
|
Should `Built into Plugin` be displayed is the Expansion included in the Plugin it depends on. Should a URL be shown does it mean you have to download it manually and add it to the `expansions` folder yourself.
|
||||||
|
|
||||||
|
/// note
|
||||||
|
This placeholder list is provided "as-is" without any guarantee of being accurate and/or up-to-date.
|
||||||
|
|
||||||
|
Page is only updated on request. We recommend contributing to this list by [making a Pull request](https://github.com/PlaceholderAPI/PlaceholderAPI/pulls).
|
||||||
|
Further details on how to contribute to this list or the wiki as a whole can be found on the [README file of the Wiki](https://github.com/PlaceholderAPI/PlaceholderAPI/blob/wiki/README.md).
|
||||||
|
///
|
||||||
|
|
||||||
|
- [Standalone](#standalone)
|
||||||
|
- A
|
||||||
|
- *No Expansions*
|
||||||
|
- B
|
||||||
|
- *No Expansions*
|
||||||
|
- C
|
||||||
|
- *No Expansions*
|
||||||
|
- D
|
||||||
|
- *No Expansions*
|
||||||
|
- E
|
||||||
|
- *No Expansions*
|
||||||
|
- F
|
||||||
|
- *No Expansions*
|
||||||
|
- G
|
||||||
|
- *No Expansions*
|
||||||
|
- H
|
||||||
|
- *No Expansions*
|
||||||
|
- I
|
||||||
|
- *No Expansions*
|
||||||
|
- J
|
||||||
|
- *No Expansions*
|
||||||
|
- K
|
||||||
|
- *No Expansions*
|
||||||
|
- L
|
||||||
|
- *No Expansions*
|
||||||
|
- M
|
||||||
|
- *No Expansions*
|
||||||
|
- N
|
||||||
|
- *No Expansions*
|
||||||
|
- O
|
||||||
|
- *No Expansions*
|
||||||
|
- P
|
||||||
|
- [Player](#player)
|
||||||
|
- Q
|
||||||
|
- *No Expansions*
|
||||||
|
- R
|
||||||
|
- *No Expansions*
|
||||||
|
- S
|
||||||
|
- *No Expansions*
|
||||||
|
- T
|
||||||
|
- *No Expansions*
|
||||||
|
- U
|
||||||
|
- *No Expansions*
|
||||||
|
- V
|
||||||
|
- *No Expansions*
|
||||||
|
- W
|
||||||
|
- *No Expansions*
|
||||||
|
- X
|
||||||
|
- *No Expansions*
|
||||||
|
- Y
|
||||||
|
- *No Expansions*
|
||||||
|
- Z
|
||||||
|
- *No Expansions*
|
||||||
|
|
||||||
|
----
|
||||||
|
|
||||||
|
- [Plugin-placeholders](#plugin-placeholders)
|
||||||
|
- A
|
||||||
|
- *No Expansions*
|
||||||
|
- B
|
||||||
|
- *No Expansions*
|
||||||
|
- C
|
||||||
|
- *No Expansions*
|
||||||
|
- D
|
||||||
|
- *No Expansions*
|
||||||
|
- E
|
||||||
|
- *No Expansions*
|
||||||
|
- F
|
||||||
|
- *No Expansions*
|
||||||
|
- G
|
||||||
|
- *No Expansions*
|
||||||
|
- H
|
||||||
|
- *No Expansions*
|
||||||
|
- I
|
||||||
|
- *No Expansions*
|
||||||
|
- J
|
||||||
|
- *No Expansions*
|
||||||
|
- K
|
||||||
|
- *No Expansions*
|
||||||
|
- L
|
||||||
|
- *No Expansions*
|
||||||
|
- M
|
||||||
|
- *No Expansions*
|
||||||
|
- N
|
||||||
|
- *No Expansions*
|
||||||
|
- O
|
||||||
|
- *No Expansions*
|
||||||
|
- P
|
||||||
|
- *No Expansions*
|
||||||
|
- Q
|
||||||
|
- *No Expansions*
|
||||||
|
- R
|
||||||
|
- *No Expansions*
|
||||||
|
- S
|
||||||
|
- *No Expansions*
|
||||||
|
- T
|
||||||
|
- *No Expansions*
|
||||||
|
- U
|
||||||
|
- *No Expansions*
|
||||||
|
- V
|
||||||
|
- *No Expansions*
|
||||||
|
- W
|
||||||
|
- *No Expansions*
|
||||||
|
- X
|
||||||
|
- *No Expansions*
|
||||||
|
- Y
|
||||||
|
- *No Expansions*
|
||||||
|
- Z
|
||||||
|
- *No Expansions*
|
||||||
|
|
||||||
|
----
|
||||||
|
|
||||||
|
## Standalone
|
||||||
|
|
||||||
|
Expansions listed here don't need any plugin/mod or extra library to function properly, unless mentioned otherwise.
|
||||||
|
A majority of these Expansions are maintained by the PlaceholderAPI team and can be considered *official*.
|
||||||
|
|
||||||
|
### **Player**
|
||||||
|
/// command | papi ecloud download Player
|
||||||
|
///
|
||||||
|
|
||||||
|
```
|
||||||
|
%player_uuid%
|
||||||
|
%player_username%
|
||||||
|
%player_language%
|
||||||
|
%player_world_uuid%
|
||||||
|
%player_x%
|
||||||
|
%player_y%
|
||||||
|
%player_z%
|
||||||
|
%player_yaw%
|
||||||
|
%player_pitch%
|
||||||
|
%player_has_played_before%
|
||||||
|
%player_name%
|
||||||
|
%player_gamemode%
|
||||||
|
%player_world%
|
||||||
|
%player_biome%
|
||||||
|
%player_item_in_hand%
|
||||||
|
%player_item_in_hand_quantity%
|
||||||
|
%player_item_in_hand_durability%
|
||||||
|
%player_item_in_hand_broken%
|
||||||
|
%player_item_in_hand_unbreakable%
|
||||||
|
%player_current_fall_distance%
|
||||||
|
%player_view_radius%
|
||||||
|
%player_client_view_radius%
|
||||||
|
%player_since_last_spawn_nanos%
|
||||||
|
%player_mount_entity_id%
|
||||||
|
%player_is_collidable%
|
||||||
|
%player_health%
|
||||||
|
%player_health_max%
|
||||||
|
%player_health_min%
|
||||||
|
%player_ammo%
|
||||||
|
%player_ammo_max%
|
||||||
|
%player_ammo_min%
|
||||||
|
%player_stamina%
|
||||||
|
%player_stamina_max%
|
||||||
|
%player_stamina_min%
|
||||||
|
%player_mana%
|
||||||
|
%player_mana_max%
|
||||||
|
%player_mana_min%
|
||||||
|
%player_oxygen%
|
||||||
|
%player_oxygen_max%
|
||||||
|
%player_oxygen_min%
|
||||||
|
%player_signature_energy%
|
||||||
|
%player_signature_energy_max%
|
||||||
|
%player_signature_energy_min%
|
||||||
|
%player_has_permission_<permission>%
|
||||||
|
```
|
||||||
|
|
||||||
|
----
|
||||||
|
|
||||||
|
### **Server**
|
||||||
|
/// command | papi ecloud download Server
|
||||||
|
///
|
||||||
|
|
||||||
|
```
|
||||||
|
%server_name%
|
||||||
|
%server_online%
|
||||||
|
%server_worlds%
|
||||||
|
%server_max_players%
|
||||||
|
%server_max_view_radius%
|
||||||
|
%server_motd%
|
||||||
|
%server_default_gamemode%
|
||||||
|
%server_default_world%
|
||||||
|
%server_rate_limit_enabled%
|
||||||
|
%server_rate_limit_packets_per_second%
|
||||||
|
%server_rate_limit_burst_capacity%
|
||||||
|
%server_is_booting%
|
||||||
|
%server_is_shutting_down%
|
||||||
|
%server_boot_timestamp%
|
||||||
|
%server_uptime_millis%
|
||||||
|
%server_uptime_seconds%
|
||||||
|
%server_uptime%
|
||||||
|
%server_plugin_count%
|
||||||
|
```
|
||||||
|
|
||||||
|
----
|
||||||
|
|
||||||
|
### **World**
|
||||||
|
/// command | papi ecloud download World
|
||||||
|
///
|
||||||
|
|
||||||
|
```
|
||||||
|
%world_total%
|
||||||
|
%world_biome%
|
||||||
|
%world_time%
|
||||||
|
%world_timein12%
|
||||||
|
%world_fulltime%
|
||||||
|
%world_dayprogress%
|
||||||
|
%world_moonphase%
|
||||||
|
%world_sunlightfactor%
|
||||||
|
%world_date%
|
||||||
|
%world_sunddirection_x%
|
||||||
|
%world_sunddirection_y%
|
||||||
|
%world_sunddirection_z%
|
||||||
|
%world_name_<world>%
|
||||||
|
%world_uuid_<world>%
|
||||||
|
%world_seed_<world>%
|
||||||
|
%world_canpvp_<world>%
|
||||||
|
%world_spawnnpc_<world>%
|
||||||
|
%world_npcfrozen_<world>%
|
||||||
|
%world_falldamage_<world>%
|
||||||
|
%world_objectivemarkers_<world>%
|
||||||
|
%world_entities_<world>%
|
||||||
|
%world_players_<world>%
|
||||||
|
%world_players_<world>_<group>%
|
||||||
|
%world_haspermission_<world>_<permission>%
|
||||||
|
%world_playerexist_<world>_<playername>%
|
||||||
|
%world_recentjoin_<world>%
|
||||||
|
%world_recentquit_<world>%
|
||||||
|
```
|
||||||
|
|
||||||
|
----
|
||||||
|
|
||||||
|
## Plugin-placeholders
|
||||||
|
|
||||||
|
Expansions listed here require the linked resource (plugin/mod) to work properly.
|
||||||
|
|
||||||
|
Most of the listed Expansions are NOT made and maintained by the PlaceholderAPI team.
|
||||||
|
Please see ?510 for a list of all expansions officially maintained by the PlaceholderAPI team.
|
||||||
|
|
||||||
|
### **[LuckPerms](https://www.spigotmc.org/resources/28140/)**
|
||||||
|
/// command | papi ecloud download LuckPerms
|
||||||
|
///
|
||||||
|
|
||||||
|
```
|
||||||
|
%luckperms_prefix%
|
||||||
|
%luckperms_suffix%
|
||||||
|
%luckperms_meta_<metakey>%
|
||||||
|
%luckperms_prefix_element_<element>%
|
||||||
|
%luckperms_suffix_element_<element>%
|
||||||
|
%luckperms_context_<contextkey>%
|
||||||
|
%luckperms_groups%
|
||||||
|
%luckperms_primary_group_name%
|
||||||
|
%luckperms_has_permission_<permission>%
|
||||||
|
%luckperms_inherits_permission_<permission>%
|
||||||
|
%luckperms_check_permission_<permission>%
|
||||||
|
%luckperms_in_group_<group>%
|
||||||
|
%luckperms_inherits_group_<group>%
|
||||||
|
%luckperms_on_track_<track>%
|
||||||
|
%luckperms_has_groups_on_track_<track>%
|
||||||
|
%luckperms_highest_group_by_weight%
|
||||||
|
%luckperms_lowest_group_by_weight%
|
||||||
|
%luckperms_first_group_on_tracks_<tracks>%
|
||||||
|
%luckperms_last_group_on_tracks_<tracks>%
|
||||||
|
%luckperms_expiry_time_<permission>%
|
||||||
|
%luckperms_inherited_expiry_time_<permission>%
|
||||||
|
%luckperms_group_expiry_time_<groupname>%
|
||||||
|
```
|
||||||
20
docs/users/placeholder-list/index.md
Normal file
20
docs/users/placeholder-list/index.md
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
# Placeholder List
|
||||||
|
|
||||||
|
PlaceholderAPI is home of countless community-made Placeholder Expansions.
|
||||||
|
To help you find the expansion you need, we are providing official placeholder lists that include available PlaceholderAPI expansions and their placeholders for both Minecraft (Spigot, Paper, etc.) and Hytale.
|
||||||
|
|
||||||
|
<div class="grid cards" markdown>
|
||||||
|
|
||||||
|
- ## [Minecraft](minecraft.md)
|
||||||
|
|
||||||
|
----
|
||||||
|
|
||||||
|
Placeholder list for the Minecraft version of PlaceholderAPI.
|
||||||
|
|
||||||
|
- ## [Hytale](hytale.md)
|
||||||
|
|
||||||
|
----
|
||||||
|
|
||||||
|
Placeholder list for the Hytale version of PlaceholderAPI.
|
||||||
|
|
||||||
|
</div>
|
||||||
@@ -2,9 +2,10 @@
|
|||||||
description: Community-curated list of available PlaceholderExpansions and their placeholders.
|
description: Community-curated list of available PlaceholderExpansions and their placeholders.
|
||||||
---
|
---
|
||||||
|
|
||||||
# Placeholder List
|
# Minecraft
|
||||||
|
|
||||||
This is a list of all available placeholders.
|
This is a list of all available placeholders for the Minecraft version of PlaceholderAPI.
|
||||||
|
For the Hytale version, visit [this page](hytale.md).
|
||||||
|
|
||||||
A download-command may be found in the infobox located below the title of the Expansion.
|
A download-command may be found in the infobox located below the title of the Expansion.
|
||||||
Should `Built into Plugin` be displayed is the Expansion included in the Plugin it depends on. Should a URL be shown does it mean you have to download it manually and add it to the `expansions` folder yourself.
|
Should `Built into Plugin` be displayed is the Expansion included in the Plugin it depends on. Should a URL be shown does it mean you have to download it manually and add it to the `expansions` folder yourself.
|
||||||
File diff suppressed because it is too large
Load Diff
@@ -39,7 +39,7 @@ This feature exists since version 2.11.4 of PlaceholderAPI
|
|||||||
The way PlaceholderAPI's system works, allows a Placeholder Expansion and its corresponding placeholders to either be included within a plugin (If placeholder requires said plugin) or to be available as a separate jar file on the eCloud of PlaceholderAPI.
|
The way PlaceholderAPI's system works, allows a Placeholder Expansion and its corresponding placeholders to either be included within a plugin (If placeholder requires said plugin) or to be available as a separate jar file on the eCloud of PlaceholderAPI.
|
||||||
Depending on what type you have, will you need to do some extra steps to use the placeholder from the Placeholder Expansion.
|
Depending on what type you have, will you need to do some extra steps to use the placeholder from the Placeholder Expansion.
|
||||||
|
|
||||||
One way to find out, if an Expansion is included or separate, is to check the [Placeholder List](placeholder-list.md) page for any entry of it.
|
One way to find out, if an Expansion is included or separate, is to check the [Placeholder List](placeholder-list/index.md) page for any entry of it.
|
||||||
If it exists on the page, can you check the infobox right below the title of the Expansion for one of the following cases:
|
If it exists on the page, can you check the infobox right below the title of the Expansion for one of the following cases:
|
||||||
|
|
||||||
- `papi ecloud download <expansion>`: The expansion is on the ecloud and needs to be downloaded using the [`/papi ecloud download` command](commands.md#papi-ecloud-download).
|
- `papi ecloud download <expansion>`: The expansion is on the ecloud and needs to be downloaded using the [`/papi ecloud download` command](commands.md#papi-ecloud-download).
|
||||||
|
|||||||
@@ -76,7 +76,10 @@ nav:
|
|||||||
- users/index.md
|
- users/index.md
|
||||||
- users/commands.md
|
- users/commands.md
|
||||||
- users/using-placeholders.md
|
- users/using-placeholders.md
|
||||||
- users/placeholder-list.md
|
- Placeholder List:
|
||||||
|
- users/placeholder-list/index.md
|
||||||
|
- users/placeholder-list/minecraft.md
|
||||||
|
- users/placeholder-list/hytale.md
|
||||||
- users/plugins-using-placeholderapi.md
|
- users/plugins-using-placeholderapi.md
|
||||||
- Dev Guides:
|
- Dev Guides:
|
||||||
- developers/index.md
|
- developers/index.md
|
||||||
|
|||||||
Reference in New Issue
Block a user