Enum Body

Source

#[repr(u32)]pub enum Body {
Show 19 variants
    Humanoid(Body),
    QuadrupedSmall(Body),
    QuadrupedMedium(Body),
    BirdMedium(Body),
    FishMedium(Body),
    Dragon(Body),
    BirdLarge(Body),
    FishSmall(Body),
    BipedLarge(Body),
    BipedSmall(Body),
    Object(Body),
    Golem(Body),
    Theropod(Body),
    QuadrupedLow(Body),
    Ship(Body),
    Arthropod(Body),
    Item(Body),
    Crustacean(Body),
    Plugin(Body),
}

Variants§

§

Plugin(Body)

Implementations§

Source §

impl Body

Source

pub const NUM_KINDS: usize = 19usize

Number of “kinds” this enum has

Source

fn all_variants() -> Vec<Body>

Source

pub fn iter() -> impl Iterator<Item = Self>

Iterates over all possible variants, including nested ones.

Source §

impl Body

Source

pub fn is_same_species_as(&self, other: &Body) -> bool

Source

pub fn heads(&self) -> Option<usize>

How many heads this body has in the Heads component if any.

Source

pub fn is_humanoid(&self) -> bool

Source

pub fn is_campfire(&self) -> bool

Source

pub fn is_portal(&self) -> bool

Source

pub fn bleeds(&self) -> bool

Source

pub fn stride_length(&self) -> f32

The length of the stride of the body, in metres (not accounting for different legs)

Source

pub fn scale(&self) -> Scale

Source

pub fn density(&self) -> Density

Average density of the body

Source

pub fn mass(&self) -> Mass

Source

pub fn dimensions(&self) -> Vec3<f32>

The width (shoulder to shoulder), length (nose to tail) and height respectively (in metres)

Source

pub fn max_radius(&self) -> f32

Source

pub fn front_radius(&self) -> f32

Source

pub fn min_radius(&self) -> f32

Source

pub fn sausage(&self) -> (Vec2<f32>, Vec2<f32>, f32)

Base of our Capsule Prism used for collisions. Returns line segment and radius. See this wiki page.

Source

pub fn collider(&self) -> Collider

Body collider

Source

pub fn spacing_radius(&self) -> f32

How far away other entities should try to be. Will be added upon the other entity’s spacing_radius. So an entity with 2.0 and an entity with 3.0 will lead to that both entities will try to keep 5.0 units away from each other.

Source

pub fn height(&self) -> f32

Height from the bottom to the top (in metres)

Source

pub fn base_energy(&self) -> u16

Source

pub fn has_death_protection(&self) -> bool

If this body will retain 1 hp when it would die, and consume death protection, and entering a downed state.

Source

pub fn base_health(&self) -> u16

Source

pub fn flying_height(&self) -> f32

Source

pub fn immune_to(&self, buff: BuffKind) -> bool

Source

pub fn combat_multiplier(&self) -> f32

Returns a multiplier representing increased difficulty not accounted for due to AI or not using an actual weapon

Source

pub fn base_poise(&self) -> u16

Source

pub fn eye_height(&self, scale: f32) -> f32

Returns the eye height for this creature.

Source

pub fn default_light_offset(&self) -> Vec3<f32>

Source

pub fn can_strafe(&self) -> bool

Source

pub fn mount_offset(&self) -> Vec3<f32>

Component of the mounting offset specific to the mount

Source

pub fn rider_offset(&self) -> Vec3<f32>

Component of the mounting offset specific to the rider

Source

pub fn tether_offset_leader(&self) -> Vec3<f32>

Source

pub fn tether_offset_follower(&self) -> Vec3<f32>

Source

pub fn localize_npc(&self) -> Content

Should be only used with npc-tell_monster.

If you want to use for displaying names in HUD, add new strings. If you want to use for anything else, add new strings.

Source

pub fn humanoid_gender(&self) -> Option<Gender>

Read comment on Gender for more

Source

pub fn default_gender(&self) -> Gender

Return gender information for this entity.

It’s an imprecise approximation, because body type != gender, and we need more advanced scheme here, but that’s all we have atm.

At the moment used for two things:

Grammatical gender indicator regarding players for proper grammatical agreement in sentences for languages that require it. At the moment can be used only for chat messages, but should be extended further.
Semantic indicator to pick proper name variant for NPC. For example, Hunter vs Huntress or Lion vs Lioness.

Source

pub fn gender_attr(&self) -> &'static str

For use with NPC name localization.

Not a grammatical gender, keep that in mind.

Source §

impl Body

Source

pub fn aerodynamic_forces( &self, rel_flow: &Vel, fluid_density: f32, wings: Option<&Wings>, scale: f32, ) -> Vec3<f32>

Source

pub fn drag_coefficient_liquid(&self, fluid_density: f32, scale: f32) -> f32

Physically incorrect (but relatively dt-independent) way to calculate drag coefficients for liquids.

Source

fn parasite_drag(&self, scale: f32) -> f32

Parasite drag is the sum of pressure drag and skin friction. Skin friction is the drag arising from the shear forces between a fluid and a surface, while pressure drag is due to flow separation. Both are viscous effects.

Source §

impl Body

Source

pub fn base_accel(&self) -> f32

Source

pub fn air_accel(&self) -> f32

Source

pub fn max_speed_approx(&self) -> f32

Attempt to determine the maximum speed of the character when moving on the ground

Source

pub fn base_ori_rate(&self) -> f32

The turn rate in 180°/s (or (rotations per second)/2)

Source

pub fn swim_thrust(&self) -> Option<f32>

Returns thrust force if the body type can swim, otherwise None

Source

pub fn fly_thrust(&self) -> Option<f32>

Returns thrust force if the body type can fly, otherwise None

Source

pub fn vectored_propulsion(&self) -> bool

Returns whether the body uses vectored propulsion

Source

pub fn jump_impulse(&self) -> Option<f32>

Returns jump impulse if the body type can jump, otherwise None

Source

pub fn can_climb(&self) -> bool

Source

pub fn reverse_move_factor(&self) -> f32

Returns how well a body can move backwards while strafing (0.0 = not at all, 1.0 = same as forward)

Source

pub fn projectile_offsets(&self, ori: Vec3<f32>, scale: f32) -> Vec3<f32>

Returns the position where a projectile should be fired relative to this body

Trait Implementations§

Source §

impl Clone for Body

Source §

fn clone(&self) -> Body

Returns a copy of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Source §

impl Component for Body

Source §

type Storage = DerefFlaggedStorage<Body, VecStorage<Body>>

Associated storage type for this component.

Source §

impl Debug for Body

Source §

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

Formats the value using the given formatter. Read more

Source §

impl Default for Body

Source §

fn default() -> Self

Returns the “default value” for a type. Read more

Source §

impl<'de> Deserialize<'de> for Body

Source §

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

Source §

impl Display for Body

Source §

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

Formats the value using the given formatter. Read more

Source §