samp_sdk/omp/generated/
player_console.rs

1//! `IPlayerConsoleData` — generated by `cargo xtask gen-omp` from `Server/Components/Console/console.hpp`.
2//! Implemented by `PlayerConsoleData` in the server's `Console`.
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 `IPlayerConsoleData*`.
20    pub IPlayerConsoleData;
21}
22
23/// `PlayerConsoleData_UID` in `Server/Components/Console/console.hpp`.
24pub const PLAYER_CONSOLE_UID: UID = 0x9f8d20f2f471cbae;
25
26/// The player's `IPlayerConsoleData`, or null when the component providing it is not loaded.
27///
28/// Found by walking the player's extension map for `PLAYER_CONSOLE_UID` — the
29/// virtual `getExtension` does not consult that map. `IExtension`
30/// is `IPlayerConsoleData`'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_console(player: *mut IPlayer) -> *mut IPlayerConsoleData {
36    unsafe { extension(player.cast::<u8>(), PLAYER_CONSOLE_UID) }.cast::<IPlayerConsoleData>()
37}
38
39slots! {
40    /// `bool IPlayerConsoleData::hasConsoleAccess()`
41    SLOT_HAS_CONSOLE_ACCESS: usize = 3, 3;
42    /// `void IPlayerConsoleData::setConsoleAccessibility(bool)`
43    SLOT_SET_CONSOLE_ACCESSIBILITY: usize = 4, 4;
44}
45
46virtual_fns! {
47    /// `bool IPlayerConsoleData::hasConsoleAccess()`.
48    ///
49    /// # Safety
50    /// `data` must be a live `IPlayerConsoleData`.
51    #[must_use]
52    pub fn player_console_has_console_access(
53        data: IPlayerConsoleData,
54    ) -> bool = [0, SLOT_HAS_CONSOLE_ACCESS] or false;
55
56    /// `void IPlayerConsoleData::setConsoleAccessibility(bool)`.
57    ///
58    /// # Safety
59    /// `data` must be a live `IPlayerConsoleData`.
60    pub fn player_console_set_console_accessibility(
61        data: IPlayerConsoleData,
62        set: bool,
63    ) = [0, SLOT_SET_CONSOLE_ACCESSIBILITY];
64}
samp_sdk/omp/generated/player_console.rs

samp_sdk/omp/generated/
player_console.rs
