Struct hl_capture::cvar::CVar

pub struct CVar {
    pub engine_cvar: *mut cvar_t,
    pub default_value: &'static str,
    pub name: &'static str,
}

Safe wrapper for the engine CVar type.

Fields

engine_cvar: *mut cvar_t

This field has to be public because there's no const fn. It shouldn't be accessed manually.

default_value: &'static str

This field has to be public because there's no const fn. It shouldn't be accessed manually.

name: &'static str

This field has to be public because there's no const fn. It shouldn't be accessed manually.

Methods

impl CVar

pub unsafe fn get_engine_cvar(&self) -> &'static mut cvar_t

Retrieves a mutable reference to the engine CVar.

Safety

Unsafe because this function should only be called from the main game thread. You should also ensure that you don't call any engine functions while holding this reference, because the game also has a mutable reference to this CVar.

pub fn register(&self, engine: &mut Engine) -> Result<(), Error>

Registers this console variable.

pub fn to_string(&self, engine: &mut Engine) -> Result<String, Error>

Returns the string this variable is set to.

pub fn parse<T>(&self, engine: &mut Engine) -> Result<T, Error> where
    T: FromStr,
    <T as FromStr>::Err: Fail, 

Tries parsing this variable's value to the desired type.

Trait Implementations

impl Sync for CVar

impl Send for CVar