Struct hl_capture::engine::Engine

pub struct Engine {
    _private: PhantomData<*const ()>,
}

A "container" for unsafe engine functions.

It's used for exposing safe interfaces for these functions where they can be used safely (for example, in console command handlers). Engine also serves as a static guarantee of being in the main game thread.

Fields

_private: PhantomData<*const ()>

This field serves two purposes: firstly, it prevents creating the struct not via the unsafe new() method, and secondly, it marks the struct as !Send and !Sync.

Methods

impl Engine

pub unsafe fn new() -> Self

Creates an instance of Engine.

Safety

Unsafe because this function should only be called from the main game thread.

pub fn marker(&self) -> (&Self, MainThreadMarker)

Splits off a MainThreadMarker.

pub fn marker_mut(&mut self) -> (&mut Self, MainThreadMarker)

Splits off a MainThreadMarker from a mutable reference.

pub fn data(&self) -> &MainThreadData

Returns a reference to the main thread global variables.

pub fn data_mut(&mut self) -> &mut MainThreadData

Returns a mutable reference to the main thread global variables.

Important traits for Args<'_>

impl<'_> Iterator for Args<'_> type Item = String;

pub fn args(&self) -> Args

Returns an iterator over the console command arguments.

pub fn con_print(&self, string: &str)

Prints the given string to the game console.

pub fn cmd_argc(&self) -> u32

Returns the number of console command arguments.

pub fn cmd_argv(&self, index: u32) -> String

Returns the console command argument with the given index.

pub fn register_variable(&mut self, cvar: &CVar) -> Result<(), Error>

Registers the given console variable.

pub fn get_engine_cvar(&mut self, cvar: &CVar) -> EngineCVarGuard

Returns the engine CVar wrapped by the given CVar.

Takes a mutable reference to Engine to statically ensure that no engine functions are called while the engine CVar reference is valid.