Struct ObjectId 

pub struct ObjectId(/* private fields */);

A runtime object handle, as the engine hands them out.

A newtype rather than a bare u32 because the two are not interchangeable: zero is a perfectly ordinary object id, so a plain integer field cannot tell “object number zero” from “no object”. Every type carrying one of these had that bug, defaulting to zero and thereby claiming an unplaced object referred to whichever object the engine numbered first.

Default is Self::INVALID, which is what makes the fix structural. A type holding this can keep #[derive(Default)] and get the right value, where a bare u32 needs every author to remember.

Implementations

impl ObjectId

pub const INVALID: Self

The engine-wide OBJECT_INVALID placeholder, carried by anything that has not been assigned a runtime id.

It never lands live. CSWSObject’s base constructor checks for this value and, on a match, discards it for a freshly allocated unique id. Every object type inherits that constructor, so this holds for every ObjectId on the axis: the ten GIT object lists, Ifo’s Mod_Area_list, and the item entries on creatures, placeables and stores alike.

The audited absent-value is still this sentinel, because the replacement is resolution and a typed view projects the file. What changes is what the value means to whoever reads it back: an ObjectId of 0x7F000000 says “allocate me one”, not “this is my id”. A save editor displaying it as an identifier is displaying a request.

pub const fn new(raw: u32) -> Self

Wraps a raw handle.

pub const fn get(self) -> u32

The raw handle, for writing back into a GFF field.

pub const fn is_valid(self) -> bool

Whether this names an actual object rather than the placeholder.

Trait Implementations

impl Clone for ObjectId

fn clone(&self) -> ObjectId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ObjectId

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

Formats the value using the given formatter.

impl Default for ObjectId

fn default() -> Self

Returns the “default value” for a type.

impl From<ObjectId> for u32

fn from(id: ObjectId) -> Self

Converts to this type from the input type.

impl From<u32> for ObjectId

fn from(raw: u32) -> Self

Converts to this type from the input type.

impl GffScalar for ObjectId

The mapping lives beside the newtype rather than in a table inside the derive, which is what lets a view declare an ObjectId field with no edit anywhere else.

const GFF_TYPE: GffType = rakata_formats::schema::GffType::UInt32

The wire type this maps to.

fn from_gff_value(value: &GffValue) -> Option<Self>

Reads a value, accepting every encoding this type can hold.

fn to_gff_value(self) -> GffValue

Writes the one encoding the engine’s own writer emits.

impl Hash for ObjectId

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ObjectId

fn cmp(&self, other: &ObjectId) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ObjectId

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

fn partial_cmp(&self, other: &ObjectId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for ObjectId

impl Eq for ObjectId

impl StructuralPartialEq for ObjectId