Skip to content

Commit

Permalink
Documentation corrections
Browse files Browse the repository at this point in the history
  • Loading branch information
APickledWalrus committed May 24, 2024
1 parent 459d8d3 commit 65b2064
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 11 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@
@Name("Placeholder")
@Description("An expression to obtain the placeholder (or part of it) in a placeholder request event.")
@Examples({
"on placeholderapi placeholder request for the prefix \"custom\":",
"placeholderapi placeholder with the prefix \"skriptplaceholders\":",
"\tbroadcast \"Placeholder: %the placeholder%\"",
"\tbroadcast \"Prefix: %the placeholder prefix%\"",
"\tbroadcast \"Identifier: %the placeholder identifier%\"",
"on mvdw placeholder request for the placeholder \"custom_hey\":",
"mvdw placeholder named \"skriptplaceholders_test\":",
"\tbroadcast \"Placeholder: %the placeholder%\""
})
@Since("1.0.0, 1.3.0 (MVdWPlaceholderAPI support)")
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@
@Name("Placeholder Result")
@Description("The value of a placeholder in a placeholder event. Can be set, reset, or deleted.")
@Examples({
"on placeholderapi placeholder request for the prefix \"skriptplaceholders\":",
"placeholderapi placeholder with the prefix \"skriptplaceholders\":",
"\tif the identifier is \"author\": # Placeholder is \"%skriptplaceholders_author%\"",
"\t\tset the result to \"APickledWalrus\"",
"on mvdw placeholder request for the placeholder \"skriptplaceholders_author\":",
"mvdw placeholder named \"skriptplaceholders_author\":",
"\t# Placeholder is \"{skriptplaceholders_author}\"",
"\tset the result to \"APickledWalrus\""
})
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,12 @@
@Name("Relational Placeholder Players")
@Description("The two players involved in a relational placeholder request.")
@Examples({
"on placeholderapi placeholder request for the relational prefix \"skriptplaceholders\":",
"\tif the identifier is \"rel_longer_name\": # Placeholder is \"%skriptplaceholders_author%\"",
"placeholderapi relational placeholder with the prefix \"skriptplaceholders\":",
"\tif the identifier is \"longer_name\": # Placeholder is \"%rel_skriptplaceholders_longer_name%\"",
"\t\tif the length of the name of the first player > the length of the name of the second player:",
"\t\t\tset the result to the name of the first player",
"\t\telse:",
"\t\t\tset the result to the name of the second player"
"\t\t\tset the result to the name of the second player",
})
@Since("1.7.0")
public class ExprRelationalPlaceholderPlayers extends SimpleExpression<Player> {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,16 +36,16 @@
"The code will be executed every time the placeholder plugin requests a value for the placeholder."
})
@Examples({
"on placeholderapi placeholder request for the prefix \"skriptplaceholders\":",
"placeholderapi placeholder with the prefix \"skriptplaceholders\":",
"\tif the identifier is \"author\": # Placeholder is \"%skriptplaceholders_author%\"",
"\t\tset the result to \"APickledWalrus\"",
"on placeholderapi placeholder request for the relational prefix \"skriptplaceholders\":",
"placeholderapi relational placeholder with the prefix \"skriptplaceholders\":",
"\tif the identifier is \"longer_name\": # Placeholder is \"%rel_skriptplaceholders_longer_name%\"",
"\t\tif the length of the name of the first player > the length of the name of the second player:",
"\t\t\tset the result to the name of the first player",
"\t\telse:",
"\t\t\tset the result to the name of the second player",
"on mvdw placeholder request for the placeholder \"skriptplaceholders_author\":",
"mvdw placeholder named \"skriptplaceholders_author\":",
"\t# Placeholder is \"{skriptplaceholders_author}\"",
"\tset the result to \"APickledWalrus\""
})
Expand Down Expand Up @@ -139,7 +139,7 @@ public void unload() {
public @NotNull String toString(@Nullable Event event, boolean debug) {
switch (plugin) {
case PLACEHOLDER_API:
return "placeholderapi " + (isRelational ? "relational " : "") + "placeholder for the prefix " + placeholder;
return "placeholderapi " + (isRelational ? "relational " : "") + "placeholder with the prefix " + placeholder;
case MVDW_PLACEHOLDER_API:
return "mvdwplaceholderapi placeholder named " + placeholder;
default:
Expand Down

0 comments on commit 65b2064

Please sign in to comment.