[−][src]Struct rbx_reflection::RbxPropertyDescriptor
Describes a property on a Roblox instance.
Canonical Properties
Canonical properties are considered the source of truth for a value and are the preferred name when referring to a property.
Properties that are not canonical will generally link to a canonical
variant. Properties may have different types between canonical and
non-canonical forms, like Part.BrickColor
and Part.Color
.
There are generally two classes of non-canonical property that can overlap:
- Deprecated aliases, like
Camera.CoordinateFrame
- Serialized forms, like
BasePart.Color3uint8
orFire.size_xml
Serialized forms of canonical properties are not reported as serializable. Instead, their canonical forms will be. Mapping back to the serialized names is up to a serialization implementation.
Methods
impl RbxPropertyDescriptor
[src]
pub fn name(&self) -> &str
[src]
The name of the property, as defined by Roblox.
pub fn property_type(&self) -> &RbxPropertyTypeDescriptor
[src]
The type of the property.
RbxPropertyTypeDescriptor
is more detailed than RbxValueType
: it
contains extra information for enums and can also hold types that aren't
yet implemented by rbx_dom_weak.
pub fn scriptability(&self) -> RbxPropertyScriptability
[src]
Tells what kind of access there is to the property from Lua inside Roblox.
pub fn is_canonical(&self) -> bool
[src]
Whether the property is considered canonical by rbx_reflection.
pub fn serializes(&self) -> bool
[src]
Whether this property will serialize. Non-canonical properties are never
marked as serializable. Instead, their canonical variant (given by
canonical_name()
) will be marked as serializable.
pub fn canonical_name(&self) -> Option<&str>
[src]
If this property is not canonical, gives the name of the canonical variant.
pub fn serialized_name(&self) -> Option<&str>
[src]
If this property is serializable and its serialized name is different
than the name given by name()
, it will be given by serialized_name
.
Trait Implementations
impl PartialEq<RbxPropertyDescriptor> for RbxPropertyDescriptor
[src]
fn eq(&self, other: &RbxPropertyDescriptor) -> bool
[src]
fn ne(&self, other: &RbxPropertyDescriptor) -> bool
[src]
impl Debug for RbxPropertyDescriptor
[src]
Auto Trait Implementations
impl Send for RbxPropertyDescriptor
impl Sync for RbxPropertyDescriptor
Blanket Implementations
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> From<T> for T
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,