Type Definition eos_rs::api::script_vars::ScriptVariableId

source · 
pub type ScriptVariableId = script_var_id;
Expand description

A script variable ID with associated methods to get metadata.

Use the associated constants or the Self::new method to get instances of this.

Implementations§

source§

impl ScriptVariableId

This impl provides general metadata about script variables in the game.

source

pub const unsafe fn new(id: u32) -> Self

Returns the ID struct for the script variable with the given ID.

Safety

The caller must make sure the ID is valid (refers to an existing script variable), otherwise this is UB.

source

pub const fn id(&self) -> u32

Returns the ID of this script variable.

Trait Implementations§