[2023.1.13]PlaceholderAPI WIKI/帮助文档 汉化

代码:

1. <repositories>
   
2. <repository>
   
3. <id>placeholderapi</id>
   
4. <url>https://repo.extendedclip.com/content/repositories/placeholderapi/</url>
   
5. </repository>
   
6. </repositories>
   
7. <dependencies>
   
8. <dependency>
   
9. <groupId>me.clip</groupId>
   
10. <artifactId>placeholderapi</artifactId>
    
11. <version>{VERSION}</version>
    
12. <scope>provided</scope>
    
13. </dependency>
    
14. </dependencies>

代码:

1. repositories {
   
2. maven {
   
3. url = 'https://repo.extendedclip.com/content/repositories/placeholderapi/'
   
4. }
   
5. }
   
6. 
   
7. dependencies {
   
8. compileOnly 'me.clip:placeholderapi:{VERSION}'
   
9. }
   

代码:

1. name: ExamplePlugin
   
2. version: 1.0
   
3. author: author
   
4. main: your.main.path.here
   
5. 
   
6. softdepend: [PlaceholderAPI] # 如果你的插件不要PlaceholderAPI也能运行，但是有功能需要它，这样写.
   

代码:

1. name: ExamplePlugin
   
2. version: 1.0
   
3. author: author
   
4. main: your.main.path.here
   
5. 
   
6. depend: [PlaceholderAPI] # 如果你的插件要PlaceholderAPI才能运行，这样写.
   

代码:

1. package at.helpch.placeholderapi;
   
2. 
   
3. import me.clip.placeholderapi.PlaceholderAPI;
   
4. 
   
5. import org.bukkit.Bukkit;
   
6. import org.bukkit.event.EventHandler;
   
7. import org.bukkit.event.EventPriority;
   
8. import org.bukkit.event.Listener;
   
9. import org.bukkit.event.player.PlayerJoinEvent;
   
10. import org.bukkit.plugin.java.JavaPlugin;
    
11. import me.clip.placeholderapi.PlaceholderAPI;
    
12. 
    
13. public class JoinExample extends JavaPlugin implements Listener {
    
14. 
    
15. @Override
    
16. public void onEnable() {
    
17. 
    
18. if (Bukkit.getPluginManager().getPlugin("PlaceholderAPI") != null) {
    
19. /*
    
20. * 当PlaceholderAPI载入时，我们在这注册事件监听器(EventListener)
    
21. * 因为所有的事件都在主类中(这个[this]类),所以我们就直接使用"this"来取代类名
    
22. */
    
23. Bukkit.getPluginManager().registerEvents(this, this);
    
24. } else {
    
25. /*
    
26. * 这一段代表着插件收到了PlaceholderAPI并未安装的信息，并且丢出报错来避免问题
    
27. */
    
28. getLogger().warn("没有检查到PlaceholderAPI插件!此插件是必须的.");
    
29. Bukkit.getPluginManager().disablePlugin(this);
    
30. }
    
31. }
    
32. 
    
33. @EventHandler(priority = EventPriority.HIGHEST)
    
34. public void onJoin(PlayerJoinEvent event) {
    
35. String joinText = "%player_name% &a加入了服务器! 他的等级是&f%vault_rank%";
    
36. 
    
37. /*
    
38. * 我们用"setPlaceholders"方法来显示变量
    
39. * 这将会返回%vault_rank%当前玩家所在的权限组名
    
40. */
    
41. joinText = PlaceholderAPI.setPlaceholders(event.getPlayer(), joinText);
    
42. 
    
43. event.setJoinMessage(joinText);
    
44. }
    
45. }
    

代码:

1. package at.helpch.placeholderapi.example.expansions;
   
2. 
   
3. import org.bukkit.OfflinePlayer;
   
4. import me.clip.placeholderapi.expansion.PlaceholderExpansion;
   
5. 
   
6. public class SomeExpansion extends PlaceholderExpansion {
   
7. 
   
8. @Override
   
9. public String getAuthor() {
   
10. return "某个作者";
    
11. }
    
12. 
    
13. @Override
    
14. public String getIdentifier() {
    
15. return "例子";
    
16. }
    
17. 
    
18. @Override
    
19. public String getVersion() {
    
20. return "版本11.45.14";
    
21. }
    
22. }
    

代码:

1. package at.helpch.placeholderapi.example.expansions;
   
2. 
   
3. import org.bukkit.OfflinePlayer;
   
4. import me.clip.placeholderapi.expansion.PlaceholderExpansion;
   
5. 
   
6. public class SomeExpansion extends PlaceholderExpansion {
   
7. 
   
8. @Override
   
9. public String getAuthor() {
   
10. return "someauthor";
    
11. }
    
12. 
    
13. @Override
    
14. public String getIdentifier() {
    
15. return "example";
    
16. }
    
17. 
    
18. @Override
    
19. public String getVersion() {
    
20. return "1.0.0";
    
21. }
    
22. 
    
23. @Override
    
24. public String onRequest(OfflinePlayer player, String params) {
    
25. if(params.equalsIgnoreCase("name")) {
    
26. return player == null ? null : player.getName(); // "name"需要玩家有效
    
27. }
    
28. 
    
29. if(params.equalsIgnoreCase("placeholder1")) {
    
30. return "变量文本1";
    
31. }
    
32. 
    
33. if(params.equalsIgnoreCase("placeholder2")) {
    
34. return "变量文本2";
    
35. }
    
36. 
    
37. return null; // 这个变量这个扩展不认识
    
38. }
    
39. }
    

代码:

1. SomePlugin plugin; // 这应该要是你的扩展所依赖的插件
   
2. 
   
3. @Override
   
4. public boolean canregister() {
   
5. // 这会将插件设置为通过PluginManager获得的SomePlugin实例
   
6. return (plugin = (SomePlugin) Bukkit.getPluginManager().getPlugin(getRequiredPlugin())) != null;
   
7. }

代码:

1. package at.helpch.placeholderapi.example.expansions;
   
2. 
   
3. import at.helpch.placeholderapi.example.SomePlugin;
   
4. import org.bukkit.OfflinePlayer;
   
5. import me.clip.placeholderapi.expansion.PlaceholderExpansion;
   
6. 
   
7. public class SomeExpansion extends PlaceholderExpansion {
   
8. 
   
9. SomePlugin plugin; // This instance is assigned in canRegister()
   
10. 
    
11. @Override
    
12. public String getAuthor() {
    
13. return "someauthor";
    
14. }
    
15. 
    
16. @Override
    
17. public String getIdentifier() {
    
18. return "example";
    
19. }
    
20. 
    
21. @Override
    
22. public String getVersion() {
    
23. return "1.0.0";
    
24. }
    
25. 
    
26. @Override
    
27. public String getRequiredPlugin() {
    
28. return "SomePlugin";
    
29. }
    
30. 
    
31. @Override
    
32. public boolean canRegister() {
    
33. return (plugin = (SomePlugin) Bukkit.getPluginManager().getPlugin(getRequiredPlugin())) != null;
    
34. }
    
35. 
    
36. @Override
    
37. public String onRequest(OfflinePlayer player, String params) {
    
38. if(params.equalsIgnoreCase("placeholder1")){
    
39. return plugin.getConfig().getString("placeholders.placeholder1", "default1");
    
40. }
    
41. 
    
42. if(params.equalsIgnoreCase("placeholder2")){
    
43. return plugin.getConfig().getString("placeholders.placeholder2", "default2");
    
44. }
    
45. 
    
46. return null; // Placeholder is unknown by the expansion
    
47. }
    
48. }
    

代码:

1. public class SomeExpansion extends PlaceholderExpansion {
   
2. final SomePlugin plugin; // 实例是在构造函数中创建的，不会被修改，因此它可以为final
   
3. 
   
4. public SomeExpansion(SomePlugin plugin) {
   
5. this.plugin = plugin;
   
6. }
   
7. }

代码:

1. package at.helpch.placeholderapi.example.expansions;
   
2. 
   
3. import at.helpch.placeholderapi.example.SomePlugin;
   
4. import org.bukkit.OfflinePlayer;
   
5. import me.clip.placeholderapi.expansion.PlaceholderExpansion;
   
6. 
   
7. public class SomeExpansion extends PlaceholderExpansion {
   
8. 
   
9. private SomePlugin plugin;
   
10. 
    
11. public SomeExpansion(SomePlugin plugin) {
    
12. this.plugin = plugin;
    
13. }
    
14. 
    
15. @Override
    
16. public String getAuthor() {
    
17. return "someauthor";
    
18. }
    
19. 
    
20. @Override
    
21. public String getIdentifier() {
    
22. return "example";
    
23. }
    
24. 
    
25. @Override
    
26. public String getVersion() {
    
27. return "1.0.0";
    
28. }
    
29. 
    
30. @Override
    
31. public boolean persist() {
    
32. return true; // This is required or else PlaceholderAPI will unregister the Expansion on reload
    
33. }
    
34. 
    
35. @Override
    
36. public String onRequest(OfflinePlayer player, String params) {
    
37. if(params.equalsIgnoreCase("placeholder1")){
    
38. return plugin.getConfig().getString("placeholders.placeholder1", "default1");
    
39. }
    
40. 
    
41. if(params.equalsIgnoreCase("placeholder2")) {
    
42. return plugin.getConfig().getString("placeholders.placeholder2", "default2");
    
43. }
    
44. 
    
45. return null; // Placeholder is unknown by the Expansion
    
46. }
    
47. }
    

代码:

1. package at.helpch.placeholderapi.example
   
2. 
   
3. import org.bukkit.Bukkit;
   
4. import org.bukkit.plugin.java.JavaPlugin;
   
5. 
   
6. public class SomePlugin extends JavaPlugin {
   
7. 
   
8. @Override
   
9. public void onEnable() {
   
10. // 确保PlaceholderAPI已安装的小检查
    
11. if(Bukkit.getPluginManager().getPlugin("PlaceholderAPI") != null) {
    
12. new SomeExpansion(this).register();
    
13. }
    
14. }
    
15. }
    

代码:

1. package at.helpch.placeholderapi.example.expansions;
   
2. 
   
3. import at.helpch.placeholderapi.example.SomePlugin;
   
4. import org.bukkit.ChatColor;
   
5. import org.bukkit.Player;
   
6. import me.clip.placeholderapi.expansion.PlaceholderExpansion;
   
7. import me.clip.placeholderapi.expansion.Relational;
   
8. 
   
9. public class SomeExpansion extends PlaceholderExpansion implements Relational {
   
10. 
    
11. SomePlugin plugin;
    
12. 
    
13. public SomeExpansion(SomePlugin plugin) {
    
14. this.plugin = plugin;
    
15. }
    
16. 
    
17. @Override
    
18. public String getAuthor() {
    
19. return "someauthor";
    
20. }
    
21. 
    
22. @Override
    
23. public String getIdentifier() {
    
24. return "example";
    
25. }
    
26. 
    
27. @Override
    
28. public String getVersion() {
    
29. return "1.0.0";
    
30. }
    
31. 
    
32. @Override
    
33. public boolean persist() {
    
34. return true; // 这一段是必须的，否则PlaceholderAPI会在扩展重载的时候把它注销
    
35. }
    
36. 
    
37. @Override
    
38. public String onPlaceholderRequest(Player one, Player two, String identifier) {
    
39. if(one == null || two == null)
    
40. return null; // 两个玩家都得在线
    
41. 
    
42. if(params.equalsIgnoreCase("friend")) {
    
43. if(plugin.areFriends(one, two)) {
    
44. return ChatColor.GREEN + one.getName() + "和" + two.getName() + " 是朋友!";
    
45. } else {
    
46. return ChatColor.GREEN + one.getName() + "和" + two.getName() + " 不是朋友!";
    
47. }
    
48. }
    
49. 
    
50. return null; // 这个插件没有这样的变量Placeholder
    
51. }
    
52. }
    

代码:

1. package at.helpch.placeholderapi.example.expansions;
   
2. 
   
3. import org.bukkit.OfflinePlayer;
   
4. import me.clip.placeholderapi.expansion.PlaceholderExpansion;
   
5. 
   
6. /**
   
7. * This class will automatically register as a placeholder expansion
   
8. * when a jar including this class is added to the directory
   
9. * {@code /plugins/PlaceholderAPI/expansions} on your server.
   
10. * <br>
    
11. * <br>If you create such a class inside your own plugin, you have to
    
12. * register it manually in your plugins {@code onEnable()} by using
    
13. * {@code new YourExpansionClass().register();}
    
14. */
    
15. public class SomeExpansion extends PlaceholderExpansion {
    
16. 
    
17. /**
    
18. * This method should always return true unless we
    
19. * have a dependency we need to make sure is on the server
    
20. * for our placeholders to work!
    
21. *
    
22. * @return always true since we do not have any dependencies.
    
23. */
    
24. @Override
    
25. public boolean canRegister(){
    
26. return true;
    
27. }
    
28. 
    
29. /**
    
30. * The name of the person who created this expansion should go here.
    
31. *
    
32. * @return The name of the author as a String.
    
33. */
    
34. @Override
    
35. public String getAuthor(){
    
36. return "someauthor";
    
37. }
    
38. 
    
39. /**
    
40. * The placeholder identifier should go here.
    
41. * <br>This is what tells PlaceholderAPI to call our onRequest
    
42. * method to obtain a value if a placeholder starts with our
    
43. * identifier.
    
44. * <br>The identifier has to be lowercase and can't contain _ or %
    
45. *
    
46. * @return The identifier in {@code %<identifier>_<value>%} as String.
    
47. */
    
48. @Override
    
49. public String getIdentifier(){
    
50. return "example";
    
51. }
    
52. 
    
53. /**
    
54. * This is the version of this expansion.
    
55. * <br>You don't have to use numbers, since it is set as a String.
    
56. *
    
57. * @return The version as a String.
    
58. */
    
59. @Override
    
60. public String getVersion(){
    
61. return "1.0.0";
    
62. }
    
63. 
    
64. /**
    
65. * This is the method called when a placeholder with our identifier
    
66. * is found and needs a value.
    
67. * <br>We specify the value identifier in this method.
    
68. * <br>Since version 2.9.1 can you use OfflinePlayers in your requests.
    
69. *
    
70. * @paramplayer
    
71. *   A {@link org.bukkit.OfflinePlayer OfflinePlayer}.
    
72. * @paramidentifier
    
73. *   A String containing the identifier/value.
    
74. *
    
75. * @return Possibly-null String of the requested identifier.
    
76. */
    
77. @Override
    
78. public String onRequest(OfflinePlayer player, String identifier){
    
79. 
    
80. // %example_placeholder1%
    
81. if(identifier.equals("placeholder1")){
    
82. return "placeholder1 works";
    
83. }
    
84. 
    
85. // %example_placeholder2%
    
86. if(identifier.equals("placeholder2")){
    
87. return "placeholder2 works";
    
88. }
    
89. 
    
90. // We return null if an invalid placeholder (f.e. %example_placeholder3%)
    
91. // was provided
    
92. return null;
    
93. }
    
94. }
    

代码:

1. package at.helpch.placeholderapi.example.expansions;
   
2. 
   
3. import org.bukkit.OfflinePlayer;
   
4. import me.clip.placeholderapi.expansion.PlaceholderExpansion;
   
5. import at.helpch.placeholderapi.example.SomePlugin;
   
6. 
   
7. /**
   
8. * This class will automatically register as a placeholder expansion
   
9. * when a jar including this class is added to the directory
   
10. * {@code /plugins/PlaceholderAPI/expansions} on your server.
    
11. * <br>
    
12. * <br>If you create such a class inside your own plugin, you have to
    
13. * register it manually in your plugins {@code onEnable()} by using
    
14. * {@code new YourExpansionClass().register();}
    
15. */
    
16. public class SomeExpansion extends PlaceholderExpansion {
    
17. 
    
18. // We get an instance of the plugin later.
    
19. private SomePlugin plugin;
    
20. 
    
21. /**
    
22. * Since this expansion requires api access to the plugin "SomePlugin"
    
23. * we must check if said plugin is on the server or not.
    
24. *
    
25. * @return true or false depending on if the required plugin is installed.
    
26. */
    
27. @Override
    
28. public boolean canRegister(){
    
29. return (plugin = (SomePlugin) Bukkit.getPluginManager().getPlugin(getRequiredPlugin())) != null;
    
30. }
    
31. 
    
32. /**
    
33. * The name of the person who created this expansion should go here.
    
34. *
    
35. * @return The name of the author as a String.
    
36. */
    
37. @Override
    
38. public String getAuthor(){
    
39. return "someauthor";
    
40. }
    
41. 
    
42. /**
    
43. * The placeholder identifier should go here.
    
44. * <br>This is what tells PlaceholderAPI to call our onRequest
    
45. * method to obtain a value if a placeholder starts with our
    
46. * identifier.
    
47. * <br>The identifier has to be lowercase and can't contain _ or %
    
48. *
    
49. * @return The identifier in {@code %<identifier>_<value>%} as String.
    
50. */
    
51. @Override
    
52. public String getIdentifier(){
    
53. return "someplugin";
    
54. }
    
55. 
    
56. /**
    
57. * if the expansion requires another plugin as a dependency, the
    
58. * proper name of the dependency should go here.
    
59. * <br>Set this to {@code null} if your placeholders do not require
    
60. * another plugin to be installed on the server for them to work.
    
61. * <br>
    
62. * <br>This is extremely important to set your plugin here, since if
    
63. * you don't do it, your expansion will throw errors.
    
64. *
    
65. * @return The name of our dependency.
    
66. */
    
67. @Override
    
68. public String getRequiredPlugin(){
    
69. return "SomePlugin";
    
70. }
    
71. 
    
72. /**
    
73. * This is the version of this expansion.
    
74. * <br>You don't have to use numbers, since it is set as a String.
    
75. *
    
76. * @return The version as a String.
    
77. */
    
78. @Override
    
79. public String getVersion(){
    
80. return "1.0.0";
    
81. }
    
82. 
    
83. /**
    
84. * This is the method called when a placeholder with our identifier
    
85. * is found and needs a value.
    
86. * <br>We specify the value identifier in this method.
    
87. * <br>Since version 2.9.1 can you use OfflinePlayers in your requests.
    
88. *
    
89. * @paramplayer
    
90. *   A {@link org.bukkit.Player Player}.
    
91. * @paramidentifier
    
92. *   A String containing the identifier/value.
    
93. *
    
94. * @return possibly-null String of the requested identifier.
    
95. */
    
96. @Override
    
97. public String onPlaceholderRequest(Player player, String identifier){
    
98. 
    
99. if(p == null){
    
100. return "";
     
101. }
     
102. 
     
103. // %someplugin_placeholder1%
     
104. if(identifier.equals("placeholder1")){
     
105. return plugin.getConfig().getString("placeholder1", "value doesnt exist");
     
106. }
     
107. 
     
108. // %someplugin_placeholder2%
     
109. if(identifier.equals("placeholder2")){
     
110. return plugin.getConfig().getString("placeholder2", "value doesnt exist");
     
111. }
     
112. 
     
113. // We return null if an invalid placeholder (f.e. %someplugin_placeholder3%)
     
114. // was provided
     
115. return null;
     
116. }
     
117. }
     

代码:

1. package at.helpch.placeholderapi.example.expansions;
   
2. 
   
3. import org.bukkit.OfflinePlayer;
   
4. import me.clip.placeholderapi.expansion.PlaceholderExpansion;
   
5. import at.helpch.placeholderapi.example.SomePlugin;
   
6. 
   
7. /**
   
8. * This class will be registered through the register-method in the
   
9. * plugins onEnable-method.
   
10. */
    
11. public class SomeExpansion extends PlaceholderExpansion {
    
12. 
    
13. private SomePlugin plugin;
    
14. 
    
15. /**
    
16. * Since we register the expansion inside our own plugin, we
    
17. * can simply use this method here to get an instance of our
    
18. * plugin.
    
19. *
    
20. * @param plugin
    
21. *  The instance of our plugin.
    
22. */
    
23. public SomeExpansion(SomePlugin plugin){
    
24. this.plugin = plugin;
    
25. }
    
26. 
    
27. /**
    
28. * Because this is an internal class,
    
29. * you must override this method to let PlaceholderAPI know to not unregister your expansion class when
    
30. * PlaceholderAPI is reloaded
    
31. *
    
32. * @return true to persist through reloads
    
33. */
    
34. @Override
    
35. public boolean persist(){
    
36. return true;
    
37. }
    
38. 
    
39. /**
    
40. * Because this is a internal class, this check is not needed
    
41. * and we can simply return {@code true}
    
42. *
    
43. * @return Always true since it's an internal class.
    
44. */
    
45. @Override
    
46. public boolean canRegister(){
    
47. return true;
    
48. }
    
49. 
    
50. /**
    
51. * The name of the person who created this expansion should go here.
    
52. * <br>For convienience do we return the author from the plugin.yml
    
53. *
    
54. * @return The name of the author as a String.
    
55. */
    
56. @Override
    
57. public String getAuthor(){
    
58. return plugin.getDescription().getAuthors().toString();
    
59. }
    
60. 
    
61. /**
    
62. * The placeholder identifier should go here.
    
63. * <br>This is what tells PlaceholderAPI to call our onRequest
    
64. * method to obtain a value if a placeholder starts with our
    
65. * identifier.
    
66. * <br>The identifier has to be lowercase and can't contain _ or %
    
67. *
    
68. * @return The identifier in {@code %<identifier>_<value>%} as String.
    
69. */
    
70. @Override
    
71. public String getIdentifier(){
    
72. return "someplugin";
    
73. }
    
74. 
    
75. /**
    
76. * This is the version of the expansion.
    
77. * <br>You don't have to use numbers, since it is set as a String.
    
78. *
    
79. * For convienience do we return the version from the plugin.yml
    
80. *
    
81. * @return The version as a String.
    
82. */
    
83. @Override
    
84. public String getVersion(){
    
85. return plugin.getDescription().getVersion();
    
86. }
    
87. 
    
88. /**
    
89. * This is the method called when a placeholder with our identifier
    
90. * is found and needs a value.
    
91. * <br>We specify the value identifier in this method.
    
92. * <br>Since version 2.9.1 can you use OfflinePlayers in your requests.
    
93. *
    
94. * @paramplayer
    
95. *   A {@link org.bukkit.Player Player}.
    
96. * @paramidentifier
    
97. *   A String containing the identifier/value.
    
98. *
    
99. * @return possibly-null String of the requested identifier.
    
100. */
     
101. @Override
     
102. public String onPlaceholderRequest(Player player, String identifier){
     
103. 
     
104. if(player == null){
     
105. return "";
     
106. }
     
107. 
     
108. // %someplugin_placeholder1%
     
109. if(identifier.equals("placeholder1")){
     
110. return plugin.getConfig().getString("placeholder1", "value doesnt exist");
     
111. }
     
112. 
     
113. // %someplugin_placeholder2%
     
114. if(identifier.equals("placeholder2")){
     
115. return plugin.getConfig().getString("placeholder2", "value doesnt exist");
     
116. }
     
117. 
     
118. // We return null if an invalid placeholder (f.e. %someplugin_placeholder3%)
     
119. // was provided
     
120. return null;
     
121. }
     
122. }
     

代码:

1. package at.helpch.placeholderapi.example
   
2. 
   
3. import org.bukkit.Bukkit;
   
4. import org.bukkit.plugin.java.JavaPlugin;
   
5. 
   
6. public class SomePlugin extends JavaPlugin{
   
7. 
   
8. @Override
   
9. public void onEnable(){
   
10. // Small check to make sure that PlaceholderAPI is installed
    
11. if(Bukkit.getPluginManager().getPlugin("PlaceholderAPI") != null){
    
12. new SomeExpansion(this).register();
    
13. }
    
14. }
    
15. }
    

代码:

1. [00:00:01 ERROR]: [PlaceholderAPI] Failed to load Expansion class <expansion> (Is a dependency missing?)
   
2. [00:00:01 ERROR]: [PlaceholderAPI] Cause: NoClassDefFoundError <path>