Struct GitSound 

pub struct GitSound {
    pub common: GitSoundCommon,
    pub template_resref: ResRef,
}

A sound instance placed in the area (struct type 6).

Fields

common: GitSoundCommon

The block both forms carry, which the list declares as its element.

No #[gff]: the arm contributes its parts to the split, and the element is this block, so declaring it here too would make one label two declarations. The arm’s own codec reads and writes it.

template_resref: ResRef

Template resref (TemplateResRef).

Implementations

impl GitSound

pub const SCHEMA: [Field; 1]

This view’s schema, one entry per declared field.

pub const PARTS: &'static [&'static [Field]]

This type’s schema in parts, which is what a container holding it references.

Own fields first, then one part per flattened child in the order they are declared.

pub fn read_declared(root: &GffStruct) -> Self

Reads every declared field off root.

Absent fields take the entry’s own answer, so a fallback is derived from the declaration rather than restated beside it.

A field declaring a hand-written read is left at that answer for the view to overwrite.

pub fn write_declared(&self, root: &mut GffStruct)

Writes every declared field onto root, leaving out the ones their entry says the engine’s own writer leaves out.

A field declaring a hand-written write is not touched here.

impl GitSound

pub fn read_element(structure: &GffStruct) -> Self

Reads one element, with the block the list declares as its element.

pub fn write_element(&self, structure: &mut GffStruct)

Writes one element, the common block included.

Trait Implementations

impl Clone for GitSound

fn clone(&self) -> GitSound

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GitSound

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

Formats the value using the given formatter.

impl Default for GitSound

fn default() -> Self

What a file omitting every label loads to, which is what makes an authored file land in a known state rather than at zero.

impl GitElement for GitSound

fn read(structure: &GffStruct) -> Self

Reads one element.

fn write(&self, id: i32) -> GffStruct

Writes one element into a struct carrying the list’s own id.

impl HasSchema for GitSound

fn schema() -> &'static [Field]

The root field schema for this resource type.

fn parts() -> &'static [&'static [Field]]

The same schema in parts, own fields first.

impl PartialEq for GitSound

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for GitSound