diff --git a/PlaceholderExpansion.md b/PlaceholderExpansion.md index f488615..14c50e0 100644 --- a/PlaceholderExpansion.md +++ b/PlaceholderExpansion.md @@ -58,7 +58,9 @@ public class SomeExpansion extends PlaceholderExpansion { } } ``` -Let's quickly break down the different methods you have to implement. + +
What are these options? +

- #### getAuthor This method allows you to set the name of the expansion's author. @@ -74,6 +76,9 @@ Let's quickly break down the different methods you have to implement. Those are all the neccessary parts for your PlaceholderExpansion. Any other methods that are part of the [`PlaceholderExpansion`][placeholderexpansion] class are optional and will usually not be used, or will default to a specific value. Please read the Javadoc comments of those methods for more information. +

+
+ You must choose between one of these two methods for handling the actual parsing of placeholders (Unless you're using [Relational Placeholders](#relational-placeholders)): - #### onRequest(OfflinePlayer, String) @@ -116,7 +121,8 @@ public class SomeExpansion extends PlaceholderExpansion { } ``` -### Full Example +

Full Example

+

> Please read the [`Common Parts` Section](#common-parts) for details on all the methods. @@ -174,6 +180,9 @@ public class SomeExpansion extends PlaceholderExpansion { } ``` +

+
+ ### Register your expansion The main downside of an internal expansion is, that it can't be loaded automatically by PlaceholderAPI and instead requires you to manually register it. @@ -217,7 +226,8 @@ Benefits of this type of expansion are 1) automatic loading through PlaceholderA Downsides can be a more tedious setup to make sure any required plugin/dependency is loaded before registering the Expansion. -### Full Example (Without Dependency) +

Full Example (Without Dependency)

+

> Please read the [`Common Parts` Section](#common-parts) for details on all the methods. @@ -266,7 +276,11 @@ public class SomeExpansion extends PlaceholderExpansion { } ``` -### Full example (With Dependency) +

+
+ +

Full Example (With Dependency)

+

> Please read the [`Common Parts` Section](#common-parts) for details on all the methods. @@ -337,6 +351,9 @@ public class SomeExpansion extends PlaceholderExpansion { } ``` +

+
+ ---- ## Relational Placeholders @@ -351,7 +368,8 @@ Relational Placeholders are always prefixed with `rel_`, meaning that a relation To add relational placeholders will you need to implement the [`Relational`][relational] interface into your Expansion class and override the `onPlaceholderRequest(Player, Player, String)` method. -### Full Example +

Full Example

+

> Please read the [`Common Parts` Section](#common-parts) for details on all the methods. @@ -413,3 +431,6 @@ public class SomeExpansion extends PlaceholderExpansion implements Relational { } } ``` + +

+