Skip to content

Commit 578ee3e

Browse files
committed
Improve player_interact documentation
1 parent 3c56d0a commit 578ee3e

File tree

1 file changed

+15
-14
lines changed

1 file changed

+15
-14
lines changed

src/main/java/com/laytonsmith/core/events/drivers/PlayerEvents.java

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -802,20 +802,21 @@ public String getName() {
802802
@Override
803803
public String docs() {
804804
return "{} "
805-
+ "Fires when a player left or right clicks. Note that this event may fire for"
806-
+ " the main hand, off hand, or twice, one for each hand, depending on the item priority and what"
807-
+ " is clicked. If you don't want multiple events, you can prefilter on hand. If you want to remove"
808-
+ " the item that is being used, you must also cancel the event."
809-
+ "{action: One of either left_click_block, right_click_block, left_click_air, or right_click_air."
810-
+ " If left or right_click_air, neither facing, location, nor position will be present."
811-
+ " | block: The type of block they clicked, or null if clicked air or if the block is now empty."
812-
+ " | item: The item array the player used to click, or null if not holding anything in that hand"
813-
+ " | player: The player associated with this event"
814-
+ " | facing: The (lowercase) face of the block they clicked. (One of "
815-
+ StringUtils.Join(MCBlockFace.values(), ", ", ", or ") + ") |"
816-
+ "location: The location array of the block they clicked |"
817-
+ "position: Vector array of the position on the block that was right clicked (MC 1.20.1+) |"
818-
+ "hand: The hand used to click with, can be either main_hand or off_hand}"
805+
+ "Fires when a player left or right clicks. Dropping items can also fire this event for the"
806+
+ " main_hand if the player is not facing a block or is in adventure mode. This event may fire"
807+
+ " multiple times for each click, main_hand and/or off_hand, depending on item priorities and what"
808+
+ " block is clicked. You may want to prefilter by hand. An instant break block can fire two events"
809+
+ " in one tick, one for the block broken and one for the block or air behind it. If you want to"
810+
+ " remove the item that is being used, you should also cancel the event."
811+
+ "{action: Can be left_click_block, right_click_block, left_click_air, or right_click_air."
812+
+ " | player | hand: The hand used, can be either main_hand or off_hand."
813+
+ " | item: The item array in the hand used, or null if there is nothing in that hand."
814+
+ " | block: The type of block clicked, or null if no block was clicked."
815+
+ " | location: The location array of the block clicked (exists only if block clicked)"
816+
+ " | facing: The face of the block clicked: up, down, north, east, west, or south."
817+
+ " (exists only if block clicked)"
818+
+ " | position: Vector array of the position on the block that was right clicked."
819+
+ " (exists only if block right-clicked) (MC 1.20.1+)}"
819820
+ "{}"
820821
+ "{}";
821822
}

0 commit comments

Comments
 (0)