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
67
68
69
70
71
72

#![allow(unsafe_op_in_unsafe_fn)] // some bindings are genereted by cbinden and it doesn't follow this...

use std::fmt::{Debug, Display};

#[cfg(doc)]
use class_types::{cbaseentity::CBaseEntity, cplayer::CPlayer};

pub mod class_types;
pub mod cvar;
pub mod plugin_abi;
pub mod squirrelclasstypes;
pub mod squirreldatatypes;
pub mod squirrelfunctions;

#[repr(C)]
pub struct OffsetStructField<T, const U: usize> {
    _pad: [::std::os::raw::c_char; U],
    value: T,
}

impl<T, const U: usize> std::ops::Deref for OffsetStructField<T, U> {
    type Target = T;

    fn deref(&self) -> &Self::Target {
        &self.value
    }
}

impl<T, const U: usize> std::ops::DerefMut for OffsetStructField<T, U> {
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.value
    }
}

impl<T, const U: usize> OffsetStructField<T, U> {
    pub const fn get_inner(&self) -> &T {
        &self.value
    }

    pub fn get_inner_mut(&mut self) -> &mut T {
        &mut self.value
    }
}

impl<T: Copy + Clone, const U: usize> OffsetStructField<T, U> {
    /// Returns the copy inner of this [`OffsetStructField<T, U>`].
    pub const fn copy_inner(&self) -> T {
        self.value
    }
}

impl<T: Debug, const U: usize> Debug for OffsetStructField<T, U> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.write_str(&format!("{:?}", self.value))
    }
}

impl<T: Display, const U: usize> Display for OffsetStructField<T, U> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.write_str(&format!("{}", self.value))
    }
}

/// trait to share to allow easier multiple up castings of certain classes
///
/// # Ex
///
/// [CBaseEntity] -> [CPlayer]
pub trait DynamicCast<T> {
    fn dynamic_cast(&self) -> Option<&T>;
    fn dynamic_cast_mut(&mut self) -> Option<&mut T>;
}