Enum yy_typings::object_yy::EventType

pub enum EventType {
    Create,
    Destroy,
    Cleanup,
    Step(Stage),
    Alarm(usize),
    Draw(DrawEvent),
    Collision,
    Mouse(MouseEvent),
    KeyDown(VirtualKeyCode),
    KeyPress(VirtualKeyCode),
    KeyRelease(VirtualKeyCode),
    Gesture(GestureEvent),
    Other(OtherEvent),
    Async(AsyncEvent),
}

Describes the current event type. Users can make most events freely, though special care should be taken that Alarm's .0 field is less than ALARM_MAX, and the same for the OtherEvent's usize wrappers. To make sure some event has been validly created, is_valid has been provided.

Note: only serde_json serialization and deserialization is supported for EventType. Yaml, and other text / WYSIWYG data formats should be fine, but Bincode and other binary sequences are unlikely to succesfully serialize this. This is due to our use of serde's flatten, which runs afoul of this issue: https://github.com/servo/bincode/issues/245

Variants

Create

Destroy

Cleanup

Step(Stage)

Alarm(usize)

Draw(DrawEvent)

Collision

Mouse(MouseEvent)

KeyDown(VirtualKeyCode)

KeyPress(VirtualKeyCode)

KeyRelease(VirtualKeyCode)

Gesture(GestureEvent)

Other(OtherEvent)

Async(AsyncEvent)

Implementations

impl EventType

pub const ALARM_MAX: usize

The maximum number of alarms which are available in the Gms2 IDE.

pub fn filename(&self) -> (&'static str, usize)

Gets the filename for a given event with its requisite base. We return in this format to reduce allocating a string per call, as this filename will likely become allocated on some path in the future.

let (base_name, numeric_id) = EventType::Create;
assert_eq!(base_name, "Create_");
assert_eq!(numeric_id, 0);

pub fn parse_filename(
    value: &str,
    event_num: usize
) -> Result<EventType, EventTypeConvertErrors>

Parses a given filename and number into an EventType, if valid.

pub fn is_valid(value: EventType) -> bool

Trait Implementations

impl Clone for EventType

fn clone(&self) -> EventType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for EventType

impl Debug for EventType

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

Formats the value using the given formatter.

impl Default for EventType

fn default() -> Self

Return EventType::Create

impl<'de> Deserialize<'de> for EventType

fn deserialize<D>(deserializer: D) -> Result<EventType, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Eq for EventType

impl From<EventType> for EventIntermediary

fn from(o: EventType) -> Self

Performs the conversion.

impl Hash for EventType

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 EventType

fn cmp(&self, other: &EventType) -> 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<EventType> for EventType

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

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

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

This method tests for !=.

impl PartialOrd<EventType> for EventType

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

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

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

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

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

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

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

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

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

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

impl Serialize for EventType

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralEq for EventType

impl StructuralPartialEq for EventType

impl TryFrom<EventIntermediary> for EventType

type Error = EventTypeConvertErrors

The type returned in the event of a conversion error.

fn try_from(o: EventIntermediary) -> Result<Self, Self::Error>

Performs the conversion.