Struct Collision

pub struct Collision {
    pub entry: LvdEntry,
    pub col_flags: ColFlags,
    pub vertices: Vec<Vector2>,
    pub normals: Vec<Vector2>,
    pub cliffs: Vec<CollisionCliff>,
    pub materials: Vec<CollisionMaterial>,
    pub unknowns: Vec<UnknownEntry>,
}

A single collision in the level. Includes shape, ledges, collision material, flags about the collision properties, and all other properties of the collision.

Fields

entry: LvdEntry

The generic object data of the collision

col_flags: ColFlags

The flags specifying certain aspects of the collision behavior (whether the collision is rigged to an animated bone, whether the platform can be dropped through, etc.)

vertices: Vec<Vector2>

The vertices describing the shape of the collision

normals: Vec<Vector2>

The collision “normals”, these are unit vectors describing the direction the collision is solid from. It effectively points “outward”. So a normal of Vector2(0.0, 1.0) means the collision is solid from the top side.

cliffs: Vec<CollisionCliff>

Data describing grabbable ledges, internally called “cliffs”, present in this collision. This describes how far away the ledge can be grabbed from as well as what vertex/edge the cliff is a part of.

materials: Vec<CollisionMaterial>

For each segment in the collision, describe the “material”. For example, a slippery stage may have a line_material of GroundCollAttr::GROUND_COLL_ATTR_ICE. This has no relation to graphical materials, only physics/sounds are affected by this.

unknowns: Vec<UnknownEntry>

Trait Implementations

impl BinRead for Collision

type Args = ()

The type used for the args parameter of read_args() and read_options().

fn read_options<R: Read + Seek>( __binrw_generated_var_reader: &mut R, __binrw_generated_var_options: &ReadOptions, __binrw_generated_var_arguments: Self::Args, ) -> BinResult<Self>

Read Self from the reader using the given ReadOptions and arguments.

fn read<R>(reader: &mut R) -> Result<Self, Error>

where R: Read + Seek, Self::Args: Default,

Read Self from the reader using default arguments.

fn read_args<R>(reader: &mut R, args: Self::Args) -> Result<Self, Error>

where R: Read + Seek,

Read Self from the reader using the given arguments.

fn after_parse<R>( &mut self, _: &mut R, _: &ReadOptions, _: Self::Args, ) -> Result<(), Error>

where R: Read + Seek,

Runs any post-processing steps required to finalize construction of the object.

impl BinWrite for Collision

type Args = ()

The type of arguments needed to be supplied in order to write this type, usually a tuple.

fn write_options<W: Write + Seek>( &self, writer: &mut W, options: &WriteOptions, _: Self::Args, ) -> Result<(), Error>

Write the type to a writer, given the options on how to write it and the type-specific arguments

fn write_to<W>(&self, writer: &mut W) -> Result<(), Error>

where W: Write + Seek, Self::Args: Default,

Write a type to a writer while assuming no arguments are needed.

fn write_with_args<W>( &self, writer: &mut W, args: Self::Args, ) -> Result<(), Error>

where W: Write + Seek,

Write the type to a writer while providing the default WriteOptions

impl Debug for Collision

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

Formats the value using the given formatter.

impl HasMagic for Collision

const MAGIC: Self::MagicType

type MagicType = [u8; 12]