omp-gdk 2.1.0

Rust SDK for developing open.mp gamemodes
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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135

pub mod events;
pub mod functions;

use std::ffi::c_void;

pub use functions::load_functions;

use crate::{players::Player, types::vector::Vector2};

pub struct Menu {
    handle: *const c_void,
}

impl Menu {
    pub fn get_handle(&self) -> *const c_void {
        self.handle
    }

    pub fn new(handle: *const c_void) -> Self {
        Self { handle }
    }

    /// Creates a menu
    pub fn create(
        title: &str,
        columns: u32,
        position: Vector2,
        column1_widthh: f32,
        column2_width: f32,
    ) -> Option<Menu> {
        let mut _id = 0;
        functions::Menu_Create(
            title,
            columns,
            position.x,
            position.y,
            column1_widthh,
            column2_width,
            &mut _id,
        )
    }

    /// Destroys a menu
    pub fn destroy(&self) -> bool {
        functions::Menu_Destroy(self)
    }

    /// Add item to menu
    pub fn add_item(&self, column: u8, text: &str) -> i32 {
        functions::Menu_AddItem(self, column, text)
    }

    /// Sets the caption of a column in a menu.
    pub fn set_column_header(&self, column: u8, header_title: &str) -> bool {
        functions::Menu_SetColumnHeader(self, column, header_title)
    }

    /// Shows the menu to a player
    pub fn show_for_player(&self, player: &Player) -> bool {
        functions::Menu_ShowForPlayer(self, player)
    }

    /// Hides the menu from a player
    pub fn hide_for_player(&self, player: &Player) -> bool {
        functions::Menu_HideForPlayer(self, player)
    }

    /// Disable a menu, same as destroying it
    pub fn disable(&self) -> bool {
        functions::Menu_Disable(self)
    }

    /// Disable a particular row in menu
    pub fn disable_row(&self, row: u8) -> bool {
        functions::Menu_DisableRow(self, row)
    }

    /// Checks if a menu disabled or not
    pub fn is_disabled(&self) -> bool {
        functions::Menu_IsDisabled(self)
    }

    /// Checks if a row in menu is disabled or not
    pub fn is_row_disabled(&self, row: i32) -> bool {
        functions::Menu_IsRowDisabled(self, row)
    }

    /// Get the number of active columns.
    pub fn get_columns(&self) -> i32 {
        functions::Menu_GetColumns(self)
    }

    /// Get the number of rows in the given column.
    pub fn get_items(&self, column: i32) -> i32 {
        functions::Menu_GetItems(self, column)
    }

    /// Get position of the menu
    pub fn get_pos(&self) -> Vector2 {
        let mut pos = Vector2::default();
        functions::Menu_GetPos(self, &mut pos.x, &mut pos.y);
        pos
    }

    /// Get the column width of menu
    pub fn get_column_width(&self) -> (f32, f32) {
        let (mut column1_width, mut column2_width) = (0.0, 0.0);
        functions::Menu_GetColumnWidth(self, &mut column1_width, &mut column2_width);
        (column1_width, column2_width)
    }

    /// Get caption of the menu
    pub fn get_column_header(&self, column: i32) -> String {
        let mut header = String::new();
        functions::Menu_GetColumnHeader(self, column, &mut header, 32);
        header
    }

    /// Get an item at particular row and column in menu
    pub fn get_item(&self, column: i32, row: i32) -> String {
        let mut title = String::new();
        functions::Menu_GetItem(self, column, row, &mut title, 32);
        title
    }

    /// Get the id of the menu object
    pub fn get_id(&self) -> i32 {
        functions::Menu_GetID(self)
    }

    /// Get menu instance from id
    pub fn from_id(id: i32) -> Option<Menu> {
        functions::Menu_FromID(id)
    }
}