Skip to content

Class endstone::PlayerInputEvent

ClassList > endstone > PlayerInputEvent

Called when a player sends updated input to the server.

  • #include <endstone/event/player/player_input_event.h>

Inherits the following classes: endstone::PlayerEvent

Public Functions

Type Name
ENDSTONE_EVENT (PlayerInputEvent)
PlayerInputEvent (const NotNull< Player > & player, Input input)
Input getInput () const
Gets the new input received from this player.

Public Functions inherited from endstone::PlayerEvent

See endstone::PlayerEvent

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

Public Functions inherited from endstone::Event

See endstone::Event

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

Protected Attributes inherited from endstone::PlayerEvent

See endstone::PlayerEvent

Type Name
NotNull< Player > player_

Public Functions Documentation

function ENDSTONE_EVENT

endstone::PlayerInputEvent::ENDSTONE_EVENT (
    PlayerInputEvent
) 

function PlayerInputEvent

inline explicit endstone::PlayerInputEvent::PlayerInputEvent (
    const  NotNull < Player > & player,
    Input input
) 

function getInput

Gets the new input received from this player.

inline Input endstone::PlayerInputEvent::getInput () const

Returns:

the new input received from this player



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