Struct ConsoleVariable 

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

A console variable, by name: one this library registered, or any other (the engine’s included), read and written as T.

Implementations

impl<T> ConsoleVariable<T>

where T: ConsoleValue,

pub const fn new(name: &'static str) -> ConsoleVariable<T>

The variable name, registered or not.

pub fn register(&self, help: &str, default: T) -> Result<(), RustealError>

Register it with its default value: name value in the console sets it. Fails when the name is already a command or variable.

pub fn name(&self) -> &'static str

Its name.

pub fn get(&self) -> Result<T, RustealError>

Its value.

pub fn set(&self, value: T) -> Result<(), RustealError>

Set it, as code does.

Trait Implementations

impl<T> Clone for ConsoleVariable<T>

where T: Clone,

fn clone(&self) -> ConsoleVariable<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Copy for ConsoleVariable<T>

where T: Copy,

impl<T> Debug for ConsoleVariable<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Eq for ConsoleVariable<T>

where T: Eq,

impl<T> PartialEq for ConsoleVariable<T>

where T: PartialEq,

fn eq(&self, other: &ConsoleVariable<T>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<T> StructuralPartialEq for ConsoleVariable<T>

where T: PartialEq,