Skip to main content

samp_sdk/omp/generated/
player_classes.rs

1//! `IPlayerClassData` — generated by `cargo xtask gen-omp` from `Server/Components/Classes/classes.hpp`.
2//! Implemented by `PlayerClassData` in the server's `Classes`.
3//!
4//! Do not edit: change `xtask/omp-wrappers.toml` or the generator and
5//! regenerate. Slots are clang's layout of the header for each ABI, checked
6//! against the official binaries by `cargo xtask check-abi --generated`.
7
8#![allow(unused_imports)]
9
10use crate::omp::containers::{FlatSet, HybridString, Pair, Span};
11use crate::omp::types::{
12    Colour, GTAQuat, Hours, Microseconds, Milliseconds, Minutes, Seconds, StringView, TimePoint,
13    UID, Vector2, Vector3, Vector4, WorldTimePoint,
14};
15use crate::omp::vtable::{call_vtable_small_struct, opaque, slots, virtual_fns};
16use crate::omp::*;
17
18opaque! {
19    /// Opaque handle for `IPlayerClassData*`.
20    pub IPlayerClassData;
21}
22
23/// `PlayerClassData_UID` in `Server/Components/Classes/classes.hpp`.
24pub const PLAYER_CLASSES_UID: UID = 0x185655ded843788b;
25
26/// The player's `IPlayerClassData`, or null when the component providing it is not loaded.
27///
28/// Found by walking the player's extension map for `PLAYER_CLASSES_UID` — the
29/// virtual `getExtension` does not consult that map. `IExtension`
30/// is `IPlayerClassData`'s first base, so the extension pointer is the interface pointer.
31///
32/// # Safety
33/// `player` must be a live `IPlayer`.
34#[must_use]
35pub unsafe fn player_classes(player: *mut IPlayer) -> *mut IPlayerClassData {
36    unsafe { extension(player.cast::<u8>(), PLAYER_CLASSES_UID) }.cast::<IPlayerClassData>()
37}
38
39slots! {
40    /// `const PlayerClass & IPlayerClassData::getClass()`
41    SLOT_GET_CLASS: usize = 3, 3;
42    /// `void IPlayerClassData::setSpawnInfo(const PlayerClass &)`
43    SLOT_SET_SPAWN_INFO: usize = 4, 4;
44    /// `void IPlayerClassData::spawnPlayer()`
45    SLOT_SPAWN_PLAYER: usize = 5, 5;
46}
47
48virtual_fns! {
49    /// `const PlayerClass & IPlayerClassData::getClass()`.
50    ///
51    /// # Safety
52    /// `data` must be a live `IPlayerClassData`.
53    #[must_use]
54    pub fn player_classes_class(
55        data: IPlayerClassData,
56    ) -> *const PlayerClass = [0, SLOT_GET_CLASS] or std::ptr::null();
57
58    /// `void IPlayerClassData::setSpawnInfo(const PlayerClass &)`.
59    ///
60    /// # Safety
61    /// `data` must be a live `IPlayerClassData`.
62    pub fn player_classes_set_spawn_info(
63        data: IPlayerClassData,
64        info: &PlayerClass,
65    ) = [0, SLOT_SET_SPAWN_INFO];
66
67    /// `void IPlayerClassData::spawnPlayer()`.
68    ///
69    /// # Safety
70    /// `data` must be a live `IPlayerClassData`.
71    pub fn player_classes_spawn_player(data: IPlayerClassData) = [0, SLOT_SPAWN_PLAYER];
72}