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

use bitflags::bitflags;
use std::ffi::{c_char, c_void};
use windows::Win32::Foundation::HMODULE;

pub type CreateInterface =
    unsafe extern "C" fn(*const c_char, *mut InterfaceStatus) -> *const c_void;

#[repr(C)]
#[derive(Debug, Copy, Clone)]
pub enum InterfaceStatus {
    IfaceOk = 0,
    IfaceFailed,
}

#[repr(C)]
#[derive(Debug, Copy, Clone)]
pub struct PluginNorthstarData {
    pub handle: HMODULE,
}

#[repr(i32)]
#[derive(Debug, Copy, Clone)]
pub enum LogLevel {
    LogInfo,
    LogWarn,
    LogErr,
}

#[repr(i32)]
#[derive(Debug, Copy, Clone)]
#[non_exhaustive]
pub enum PluginString {
    Name,           // the name of the plugin
    LogName,        // the name used for logging
    DependencyName, // the name used for squirrel dependency constants created. The value returned for this has to be a valid squirrel identifier or the plugin will fail to load
}

#[repr(u32)]
#[derive(Debug, Copy, Clone)]
#[non_exhaustive]
pub enum PluginField {
    Context,
    Color,
}

bitflags! {
    #[derive(Debug, Copy, Clone)]
    pub struct PluginContext: u32 {
        const DEDICATED = 0x1;
        const CLIENT = 0x2;
    }
}

#[repr(C, packed)]
#[derive(Debug, Copy, Clone)]
pub struct PluginColor {
    pub red: u8,
    pub green: u8,
    pub blue: u8,
}