Struct yy_typings::object_yy::MouseButton

pub struct MouseButton {
    pub mb_code: MouseButtonCode,
    pub local: bool,
}

Fields

mb_code: MouseButtonCode

The mouse button code used for this input.

local: bool

Whether the input is a "global" input, or a "local" input. In the Gms2 IDE, these are separated into different categories. "Local" events only file when the object itself is clicked on, while "global" can be fire whenever the input is held at all.

Implementations

impl MouseButton

pub const GLOBAL_OFFSET: usize

The offset for the event_num if this mouse button is a global. We use this number internally for serialization/deserialization.

pub fn event_offset(&self) -> usize

Calculates the event_num offset for this MouseButton, largely for internal use in serialization and deserialization. We make this public as this library attempts to be 100% public.

Trait Implementations

impl Clone for MouseButton

fn clone(&self) -> MouseButton

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for MouseButton

impl Debug for MouseButton

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for MouseButton

fn default() -> Self

Return MouseButton { mb_code: Default::default(), local: Default::default() }

impl Display for MouseButton

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for MouseButton

impl Hash for MouseButton

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for MouseButton

fn cmp(&self, other: &MouseButton) -> Ordering

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<MouseButton> for MouseButton

fn eq(&self, other: &MouseButton) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &MouseButton) -> bool

This method tests for !=.

impl PartialOrd<MouseButton> for MouseButton

fn partial_cmp(&self, other: &MouseButton) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &MouseButton) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &MouseButton) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &MouseButton) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &MouseButton) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for MouseButton

impl StructuralPartialEq for MouseButton