rrplug 4.2.1

framework for R2Northstar plugins
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66

//! minimal abstraction for convars

use std::ffi::c_void;

use super::get_engine_data;
use crate::{
    bindings::cvar::{
        command::ConCommandBase,
        convar::{ConVar, ConVarMallocType, ConVarRegisterType},
        RawCVar,
    },
    errors::CVarQueryError,
    mid::utils::try_cstring,
    offset_functions,
};

offset_functions! {
    CVAR_GLOBALS + CvarGlobals for WhichDll::Engine => {
        convar_vtable = *mut c_void where offset(0x67FD28);
        convar_register = ConVarRegisterType where offset(0x417230);
        iconvar_vtable = *mut ConCommandBase where offset(0x67FDC8);
        convar_malloc = ConVarMallocType where offset(0x415C20);
    }
}

/// finds a convar by name
///
/// # Example
/// ```no_run
/// # use rrplug::mid::engine::get_engine_data;
/// # use rrplug::mid::engine::convars::find_convar_with_cvar;
/// # fn sub() -> Option<()> {
/// let convar = find_convar_with_cvar("spewlog_enable", &get_engine_data()?.get_cvar()).ok()?;
/// # Some(())
/// # }
/// ```
pub fn find_convar_with_cvar(
    name: &str,
    cvar: &RawCVar,
) -> Result<&'static mut ConVar, CVarQueryError> {
    let name = try_cstring(name)?;
    unsafe {
        cvar.find_convar(name.as_ptr())
            .as_mut()
            .ok_or(CVarQueryError::NotFound)
    }
}

/// finds a convar by name
///
/// # Example
/// ```no_run
/// # use rrplug::mid::engine::convars::find_convar;
/// # fn sub() -> Option<()> {
/// let convar = find_convar("spewlog_enable").ok()?;
/// # Some(())
/// # }
/// ```
pub fn find_convar(name: &str) -> Result<&'static mut ConVar, CVarQueryError> {
    find_convar_with_cvar(
        name,
        get_engine_data()
            .ok_or(CVarQueryError::NoCVarInterface)?
            .cvar,
    )
}