Struct GitSoundCommon 

pub struct GitSoundCommon {
    pub generated_type: u32,
    pub object_id: Option<ObjectId>,
    pub x_position: f32,
    pub y_position: f32,
    pub z_position: f32,
}

The part of a sound entry that is what every sound entry carries, whichever form it takes.

Both arms flatten it and the list’s element is it, so the labels here are one declaration reached from both forms rather than two copies.

Fields

generated_type: u32

Generated type (GeneratedType). Values > 255 are truncated and wrapped to an 8-bit byte on save by the engine.

object_id: Option<ObjectId>

Runtime object ID (ObjectId). Save-game only. Runtime object id (ObjectId), which only a saved form carries.

The area-level dispatcher reads it once per element ahead of the static-versus-saved branch, so the engine reads it on both forms and the liveness below is right. What it does not do is author it: every element the engine saves carries one and no element the toolset shipped does. Held as the absence so writing a static placement back does not invent a runtime id for it.

x_position: f32

X position (XPosition).

y_position: f32

Y position (YPosition).

z_position: f32

Z position (ZPosition).

Implementations

impl GitSoundCommon

pub const SCHEMA: [Field; 5]

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.

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

Reads one element of a list of this type.

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

Writes one element of a list of this type.

Trait Implementations

impl Clone for GitSoundCommon

fn clone(&self) -> GitSoundCommon

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GitSoundCommon

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

Formats the value using the given formatter.

impl Default for GitSoundCommon

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 HasSchema for GitSoundCommon

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 GitSoundCommon

fn eq(&self, other: &GitSoundCommon) -> 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 GitSoundCommon