Struct yy_typings::object_yy::ObjectProperty
source · [−]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>,
}
Expand description
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
sourceimpl Clone for ObjectProperty
impl Clone for ObjectProperty
sourcefn clone(&self) -> ObjectProperty
fn clone(&self) -> ObjectProperty
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for ObjectProperty
impl Debug for ObjectProperty
sourceimpl Default for ObjectProperty
impl Default for ObjectProperty
sourcefn default() -> Self
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() }
sourceimpl<'de> Deserialize<'de> for ObjectProperty
impl<'de> Deserialize<'de> for ObjectProperty
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl PartialEq<ObjectProperty> for ObjectProperty
impl PartialEq<ObjectProperty> for ObjectProperty
sourcefn eq(&self, other: &ObjectProperty) -> bool
fn eq(&self, other: &ObjectProperty) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourceimpl PartialOrd<ObjectProperty> for ObjectProperty
impl PartialOrd<ObjectProperty> for ObjectProperty
sourcefn partial_cmp(&self, other: &ObjectProperty) -> Option<Ordering>
fn partial_cmp(&self, other: &ObjectProperty) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
sourceimpl Serialize for ObjectProperty
impl Serialize for ObjectProperty
impl StructuralPartialEq for ObjectProperty
Auto Trait Implementations
impl RefUnwindSafe for ObjectProperty
impl Send for ObjectProperty
impl Sync for ObjectProperty
impl Unpin for ObjectProperty
impl UnwindSafe for ObjectProperty
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more