Class endstone::Input¶

ClassList > endstone > Input

Represents a movement input applied to a player.

#include <endstone/input.h>

Public Functions¶

Type	Name
constexpr	Input () = default
constexpr	Input (bool forward, bool backward, bool left, bool right, bool jump, bool sneak, bool sprint)
	Input (const Input &) = default
	Input (Input &&) noexcept
constexpr bool	isBackward () const Gets whether a backward input is applied.
constexpr bool	isForward () const Gets whether a forward input is applied.
constexpr bool	isJump () const Gets whether a jump input is applied.
constexpr bool	isLeft () const Gets whether a left input is applied.
constexpr bool	isRight () const Gets whether a right input is applied.
constexpr bool	isSneak () const Gets whether a sneak input is applied.
constexpr bool	isSprint () const Gets whether a sprint input is applied.
Input &	operator= (const Input &) = default
Input &	operator= (Input &&) noexcept
constexpr bool	operator== (const Input &) const

Public Functions Documentation¶

function Input [¼]¶

constexpr endstone::Input::Input () = default

function Input [2/4]¶

inline constexpr endstone::Input::Input (
    bool forward,
    bool backward,
    bool left,
    bool right,
    bool jump,
    bool sneak,
    bool sprint
)

function Input [¾]¶

endstone::Input::Input (
    const  Input &
) = default

function Input [4/4]¶

endstone::Input::Input (
    Input &&
) noexcept

function isBackward¶

Gets whether a backward input is applied.

inline constexpr  bool endstone::Input::isBackward () const

Returns:

true if a backward input is applied

function isForward¶

Gets whether a forward input is applied.

inline constexpr  bool endstone::Input::isForward () const

Returns:

true if a forward input is applied

function isJump¶

Gets whether a jump input is applied.

inline constexpr  bool endstone::Input::isJump () const

Returns:

true if a jump input is applied

function isLeft¶

Gets whether a left input is applied.

inline constexpr  bool endstone::Input::isLeft () const

Returns:

true if a left input is applied

function isRight¶

Gets whether a right input is applied.

inline constexpr  bool endstone::Input::isRight () const

Returns:

true if a right input is applied

function isSneak¶

Gets whether a sneak input is applied.

inline constexpr  bool endstone::Input::isSneak () const

Returns:

true if a sneak input is applied

function isSprint¶

Gets whether a sprint input is applied.

inline constexpr  bool endstone::Input::isSprint () const

Returns:

true if a sprint input is applied

function operator=¶

Input & endstone::Input::operator= (
    const  Input &
) = default

function operator=¶

Input & endstone::Input::operator= (
    Input &&
) noexcept

function operator==¶

constexpr  bool endstone::Input::operator== (
    const  Input &
) const

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