Class endstone::PlayerRiptideEvent¶

ClassList > endstone > PlayerRiptideEvent

Called when a player activates the riptide enchantment, using their trident to propel them through the air. More...

Inherits the following classes: endstone::PlayerEvent

Public Functions¶

Type	Name
	ENDSTONE_EVENT (PlayerRiptideEvent)
	PlayerRiptideEvent (const NotNull< Player > & player, ItemStack item)
const ItemStack &	getItem () const Gets the item containing the used enchantment.

Type	Name
	PlayerEvent (const NotNull< Player > & player)
const NotNull< Player > &	getPlayer () const Returns the player involved in this event.
	~PlayerEvent () override

Type	Name
	Event (bool async=false)
	Event (const Event &) = delete
	Event (Event &&) = default
virtual std::string	getEventName () const = 0 Gets a user-friendly identifier for this event.
bool	isAsynchronous () const Any custom event that should not by synchronized with other events must use the specific constructor.
Event &	operator= (const Event &) = delete
Event &	operator= (Event &&) = default
virtual	~Event () = default

Type	Name
NotNull< Player >	player_

Note:

The riptide action is currently performed client side, so manipulating the player in this event may have undesired effects.

endstone::PlayerRiptideEvent::ENDSTONE_EVENT (
    PlayerRiptideEvent
)

inline explicit endstone::PlayerRiptideEvent::PlayerRiptideEvent (
    const  NotNull < Player > & player,
    ItemStack item
)

Gets the item containing the used enchantment.

inline const  ItemStack & endstone::PlayerRiptideEvent::getItem () const

Returns:

an ItemStack for the trident being used

The documentation for this class was generated from the following file include/endstone/event/player/player_riptide_event.h