Skip to content
Permalink
Browse files
Improve API docs for clear_commands(), spawn_entity(), and player_int…
…eract
  • Loading branch information
PseudoKnight committed Apr 8, 2020
1 parent de11f40 commit 15614fde169b0306a3d5520aec5d25dbef80a428
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 8 deletions.
@@ -804,7 +804,8 @@ public String docs() {
+ " player: <macro> The player that triggered the event} "
+ "Fires when a player left or right clicks a block or the air. Note that this event may fire for"
+ " the main hand, off hand, or twice, one for each hand, depending on the item priority and what"
+ " is clicked. If you don't want multiple events, you can prefilter on hand."
+ " is clicked. If you don't want multiple events, you can prefilter on hand. If you want to remove"
+ " the item that is being used, you must also cancel the event."
+ "{action: One of either left_click_block, right_click_block, left_click_air, or right_click_air."
+ " If left or right_click_air, neither facing nor location will be present."
+ " | block: The type of block they clicked, or null if clicked air or if the block is now empty."
@@ -511,8 +511,8 @@ public Integer[] numArgs() {

@Override
public String docs() {
return "void {} Attempts to clear all registered commands on the server. Note that this probably has some special"
+ " limitations, but they are a bit unclear as to what commands can and cannot be unregistered.";
return "void {} Attempts to clear all registered commands on the server. Vanilla and default Spigot"
+ " functions are not affected, but all plugins commands are.";
}

@Override
@@ -1210,13 +1210,13 @@ public String docs() {
}
return "array {entityType, [qty], [location], [closure]} Spawns the specified number of entities of the"
+ " given type at the given location. Returns an array of entity UUIDs of what is spawned."
+ " Qty defaults to 1 and location defaults to the location of the commandsender,"
+ " Qty defaults to 1 and location defaults to the location of the commandsender,"
+ " if it is a block or player. If the commandsender is console, location must be supplied."
+ " ---- Entitytype can be one of " + StringUtils.Join(spawnable, ", ", " or ", ", or ") + "."
+ " FALLING_BLOCK will be always be sand with this function (see {{function|spawn_falling_block}})."
+ " DROPPED_ITEM will be dirt by default (see {{function|drop_item}})."
+ " A closure can be used as the last argument to modify the entity before adding it to the world."
+ " The entity's UUID is passed to the closure. FALLING_BLOCK does not support closures.";
+ " FALLING_BLOCK will be SAND (can use {{function|spawn_falling_block}} instead)."
+ " DROPPED_ITEM will be STONE (can use {{function|drop_item}} instead)."
+ " If not FALLING_BLOCK or DROPPED_ITEM, a closure can be used as the last argument to modify the"
+ " entity before adding it to the world. The entity's UUID is passed to the closure.";
}

@Override

0 comments on commit 15614fd

Please sign in to comment.