Struct yy_typings::object_yy::ObjectProperty

pub struct ObjectProperty {
    pub common_data: CommonData<ConstGmObjectProperty>,
    pub var_type: ObjectPropertyTypes,
    pub value: String,
    pub range_enabled: bool,
    pub range_min: f64,
    pub range_max: f64,
    pub list_items: Vec<String>,
    pub multiselect: bool,
    pub filters: Vec<String>,
}

Object “properties” are set in the Gms2 window and allow the user to override those properties either in child objects of a parent, or in the Room (or both!). This allows for simple customization in the room editor.

Fields

common_data: CommonData<ConstGmObjectProperty>

var_type: ObjectPropertyTypes

The type of property which is preset. Some, or all, of the rest of the information in this struct will be used based on the property type.

value: String

The serialized value of the property type. This corresponds exactly to what the Gms2 box will have inside it as a string.

range_enabled: bool

If the range Ui option is enabled for this type. This is ignored unless var_type is Real or Integer.

range_min: f64

The minimum range. Minimin should be less than max, but does not error if so.

range_max: f64

The maximum range. Minimin should be less than max, but does not error if so.

list_items: Vec<String>

The items which can be selected when var_type is set to List. Ignored in any other var_type.

multiselect: bool

If set to true when var_type is set to List, allows the User to select multiple options.

filters: Vec<String>

Not sure what this is supposed to be. In the meantime, we’ve typed it as a blank array.

Trait Implementations

impl Clone for ObjectProperty

fn clone(&self) -> ObjectProperty

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ObjectProperty

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

Formats the value using the given formatter.

impl Default for ObjectProperty

fn default() -> Self

Return ObjectProperty { common_data: Default::default(), var_type: Default::default(), value: Default::default(), range_enabled: Default::default(), range_min: Default::default(), range_max: Default::default(), list_items: Default::default(), multiselect: Default::default(), filters: Default::default() }

impl<'de> Deserialize<'de> for ObjectProperty

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq<ObjectProperty> for ObjectProperty

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<ObjectProperty> for ObjectProperty

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

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

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

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

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

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

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

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

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

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

impl Serialize for ObjectProperty

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ObjectProperty