Struct eos_rs::api::script_vars::LocalScriptVariableMut

pub struct LocalScriptVariableMut<'a>(_, _, _);

Mutable reference to a local script variable, see ScriptVariableRead and ScriptVariableWrite.

Trait Implementations

impl<'a> PartialEq<LocalScriptVariableMut<'a>> for LocalScriptVariableMut<'a>

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<'a> ScriptVariableRead for LocalScriptVariableMut<'a>

fn id(&self) -> ScriptVariableId

Returns the variable ID

fn descriptor(&self) -> &script_var

Loads a script variable descriptor for a given ID.

fn is_local(&self) -> bool

Returns whether or not this is a local variable (as opposed to a global one).

fn var_type(&self) -> ScriptVariableValueType

Returns the type of the variable

fn is_array(&self) -> bool

Returns whether or not the variable is an array.

fn capacity(&self) -> usize

Returns the number of elements in the array or 1 if it’s not an array.

fn name(&self) -> &str

Returns the name of the variable.

fn value_raw(&self) -> i32

Loads the value of a script variable. If this variable is an array, the value at index 0 is returned.

fn value_raw_indexed(&self, index: i32) -> i32

Loads the value of a script variable at some index (for script variables that are arrays).

fn value(&self) -> ScriptVariableValue

Loads the value of a script variable.

fn value_indexed(&self, index: i32) -> ScriptVariableValue

Loads the value of a script variable at some index (for script variables that are arrays).

fn sum(&self) -> i32

Loads the sum of all values of the script variable (for script variables that are arrays).

fn var_eq<S: AsScriptVariableId>(&self, other: S) -> bool

Checks if two script variables have equal values. For arrays, compares elementwise for the length of the first variable.

impl<'a> ScriptVariableWrite for LocalScriptVariableMut<'a>

fn zero_init(&mut self, var_id: ScriptVariableId)

Zero-initialize the values of the given script variable.

fn write_raw(&mut self, value: i32)

Writes the given value to a script variable.

fn write_raw_indexed(&mut self, index: i32, value: i32)

Writes the given value to a script variable at the given index (if this is an array).

fn write(&mut self, value: ScriptVariableValue)

Writes the given value to a script variable.

unsafe fn write_as_scenario(&mut self, value1: u8, value2: u8)

Writes to the given variable as if it were a scenario variable.

fn write_indexed(&mut self, index: i32, value: ScriptVariableValue)

Writes the given value to a script variable (if this is an array).

impl<'a> Eq for LocalScriptVariableMut<'a>