Struct PropBody 

pub struct PropBody {
    pub prop_name: Option<AssetId>,
    pub mass: f32,
    pub friction: f32,
    pub restitution: f32,
    pub gravity_scale: f32,
    pub linear_damping: f32,
    pub impact_clip: Option<AudioClipHandle>,
    pub impact_volume: f32,
}

Makes a companion Prop a dynamic physics body.

Attach a PropBody to give a Prop real physics: it falls, collides, stacks, tumbles, and (with pickup: true on the prop) can be carried and thrown. A Prop with a collider but no PropBody is a static, immovable obstacle.

{
  "name": "crate_a_body",
  "type": "PropBody",
  "args": { "prop_name": "crate_a", "mass": 4.0, "friction": 0.6 }
}

Fields

prop_name: Option<AssetId>

The Prop this body drives. Must match a Prop declared in the same world.

mass: f32

Mass in kilograms. 0 lets the simulation derive mass from the collider shape and a default density.

friction: f32

Friction coefficient used for contacts with this body.

restitution: f32

Bounciness in [0, 1]. 0 is fully inelastic.

gravity_scale: f32

Multiplier applied to world gravity for this body. 1.0 is normal.

linear_damping: f32

Linear velocity damping, modelling air drag.

impact_clip: Option<AudioClipHandle>

Optional AudioClip played at the contact point when this body collides hard enough to pass the world’s contact_min_impulse (see PhysicsConfig). Louder impacts play louder.

impact_volume: f32

Linear gain applied to the impact clip at full impulse.

Trait Implementations

impl Authored for PropBody

const TYPE: &'static str = "PropBody"

The registered asset type, as it appears in a world line’s type.

impl Clone for PropBody

fn clone(&self) -> PropBody

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for PropBody

const NAME: &'static str = "PropBody"

The registry name a world authors this component under.

fn from_baked(bytes: &[u8]) -> Result<PropBody, CnResult>

Reconstruct this component from a blob record, whose bytes are the serialized runtime component (cook already ran the asset -> component translation). The default rejects: runtime-only components are never stored in a blob, so only loadable types provide an implementation.

fn inject_locator(&mut self, _locator: PayloadLocator)

Called after construction to inject the payload locator from the blob def. Only meaningful for components with a compiled payload. The default implementation does nothing (correct for most components).

fn inject_name(&mut self, _id: AssetId)

Called after construction to inject the asset’s identity from the blob def. Only meaningful for components that look themselves up by id at runtime. The default implementation does nothing.

impl ComponentSlot for PropBody

const DISCRIMINANT: u8

The component type’s stable id, used as its ComponentId.

fn slot(s: &ComponentStorage) -> &Column<PropBody>

Borrow this type’s column out of the storage.

fn slot_mut(s: &mut ComponentStorage) -> &mut Column<PropBody>

Mutably borrow this type’s column out of the storage.

impl Debug for PropBody

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

Formats the value using the given formatter.

impl Default for PropBody

fn default() -> PropBody

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PropBody

where PropBody: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl RuntimeComponent for PropBody

impl Serialize for PropBody

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

where __S: Serializer,

Serialize this value into the given Serde serializer.