Struct GMRef 

pub struct GMRef<T> { /* private fields */ }

A reference to another GameMaker element.

This is typically a Reference by ID in the data file format, but is also used for texture page items (which are pointers).

GMRef has (fake) generic types to make it clearer which type it belongs to.

• Example without: pub texture_mask: GMRef
• Example with: pub texture_mask: GMRef<GMSprite>

It can be resolved to the data it references using the .resolve() method, which needs the vector the elements are stored in. This means that removing or inserting elements in the middle of the list will shift all their GMRefs; breaking them.

Implementations

impl<T> GMRef<T>

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

Creates a new GameMaker reference with the specified index.

The fake generic type can often be omitted (if the compiler can infer it).

pub fn resolve(self, elements_by_index: &[T]) -> Result<&T>

Attempts to resolve this reference to an element in the given list by its index.

Returns a reference to the element if the index is valid, or an error string if out of bounds.

Parameters

• elements_by_index: A vector of elements indexed by self.index.

Errors

Returns an error if self.index is out of bounds for the provided vector.

pub fn resolve_mut(self, elements_by_index: &mut [T]) -> Result<&mut T>

Attempts to resolve this reference to an element in the given list by its index.

Returns a reference to the element if the index is valid, or an error string if out of bounds.

Parameters

• elements_by_index: A vector of elements indexed by self.index.

Errors

Returns an error if self.index is out of bounds for the provided vector.

Trait Implementations

impl<T> Clone for GMRef<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for GMRef<T>

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

Formats the value using the given formatter.

impl From<Collision> for GMRef<GMGameObject>

fn from(collision: Collision) -> Self

Converts to this type from the input type.

impl From<GMRef<GMGameObject>> for Collision

fn from(game_object_ref: GMRef<GMGameObject>) -> Self

Converts to this type from the input type.

impl<T> From<GMRef<T>> for u32

fn from(gm_ref: GMRef<T>) -> Self

Converts to this type from the input type.

impl<T> From<GMRef<T>> for usize

fn from(gm_ref: GMRef<T>) -> Self

Converts to this type from the input type.

impl<T> From<u32> for GMRef<T>

fn from(index: u32) -> Self

Converts to this type from the input type.

impl<T> From<usize> for GMRef<T>

fn from(index: usize) -> Self

Converts to this type from the input type.

impl<T> Hash for GMRef<T>

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<T> PartialEq for GMRef<T>

fn eq(&self, other: &Self) -> 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<T> Copy for GMRef<T>

impl<T> Eq for GMRef<T>

impl<T> GMElement for GMRef<T>