Struct PropDefinition 

pub struct PropDefinition {

    pub id: String,
    pub name: String,
    pub description: String,
    pub look_description: Option<String>,
    pub glyph: Option<String>,
    pub blocking: bool,
    pub walkthrough: bool,
    pub targetable: bool,
    pub interactive: bool,
    pub has_secondary_state: bool,
    pub default_state: Option<String>,
    pub foley_stub_id: Option<String>,
    pub bump_messages: Vec<String>,
    pub has_inventory: bool,
    pub container_capacity: Option<u32>,
    pub loot_table: Option<String>,
    pub states: HashMap<String, PropStateDef>,
}

Prop definition. Props are interactive or decorative objects placed on maps.

Fields

id: String

Unique prop identifier within the pack.

name: String

Human-readable prop name.

description: String

Prop description shown on examine.

look_description: Option<String>

Extended look description.

glyph: Option<String>

Display glyph (single character string or Unicode).

blocking: bool

Whether the prop blocks entity movement. Default: false.

walkthrough: bool

Whether entities can walk through (overrides blocking for pathing). Default: false.

targetable: bool

Whether the prop can be targeted by abilities. Default: false.

interactive: bool

Whether the prop responds to interact actions. Default: false.

has_secondary_state: bool

Whether the prop has multiple states. Default: false.

default_state: Option<String>

Default state name for multi-state props.

foley_stub_id: Option<String>

Foley sound stub identifier.

bump_messages: Vec<String>

Messages shown when an entity bumps into this prop.

has_inventory: bool

Whether this prop has an inventory. Default: false.

container_capacity: Option<u32>

Maximum items this container can hold.

loot_table: Option<String>

Loot table identifier for container drops.

states: HashMap<String, PropStateDef>

State definitions for multi-state props. Key = state name.

Trait Implementations

impl Clone for PropDefinition

fn clone(&self) -> PropDefinition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PropDefinition

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PropDefinition

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for PropDefinition

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

where __S: Serializer,

Serialize this value into the given Serde serializer.