Struct rbx_reflection::RbxPropertyDescriptor

pub struct RbxPropertyDescriptor { /* fields omitted */ }

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 or Fire.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

pub fn name(&self) -> &str

The name of the property, as defined by Roblox.

pub fn property_type(&self) -> &RbxPropertyTypeDescriptor

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

Tells what kind of access there is to the property from Lua inside Roblox.

pub fn is_canonical(&self) -> bool

Whether the property is considered canonical by rbx_reflection.

pub fn serializes(&self) -> bool

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>

If this property is not canonical, gives the name of the canonical variant.

pub fn serialized_name(&self) -> Option<&str>

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

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

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

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

This method tests for !=.

impl Debug for RbxPropertyDescriptor

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

Formats the value using the given formatter.