Skip to main content

samp_sdk/omp/generated/
player_textlabels.rs

1//! `IPlayerTextLabelData` — generated by `cargo xtask gen-omp` from `Server/Components/TextLabels/textlabels.hpp`.
2//! Implemented by `PlayerTextLabelData` in the server's `TextLabels`.
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 `IPlayerTextLabelData*`.
20    pub IPlayerTextLabelData;
21}
22
23/// `PlayerTextLabelData_UID` in `Server/Components/TextLabels/textlabels.hpp`.
24pub const PLAYER_TEXTLABELS_UID: UID = 0xb9e2bd0dc5148c3c;
25
26/// The player's `IPlayerTextLabelData`, or null when the component providing it is not loaded.
27///
28/// Found by walking the player's extension map for `PLAYER_TEXTLABELS_UID` — the
29/// virtual `getExtension` does not consult that map. `IExtension`
30/// is `IPlayerTextLabelData`'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_textlabels(player: *mut IPlayer) -> *mut IPlayerTextLabelData {
36    unsafe { extension(player.cast::<u8>(), PLAYER_TEXTLABELS_UID) }.cast::<IPlayerTextLabelData>()
37}
38
39slots! {
40    /// `IPlayerTextLabel * IPlayerTextLabelData::create(StringView, Colour, Vector3, float, bool)`
41    SLOT_CREATE: usize = 3, 5;
42    /// `IPlayerTextLabel * IPlayerTextLabelData::create(StringView, Colour, Vector3, float, bool, IPlayer &)`
43    SLOT_CREATE_ON_PLAYER: usize = 4, 4;
44    /// `IPlayerTextLabel * IPlayerTextLabelData::create(StringView, Colour, Vector3, float, bool, IVehicle &)`
45    SLOT_CREATE_ON_VEHICLE: usize = 5, 3;
46}
47
48virtual_fns! {
49    /// `IPlayerTextLabel * IPlayerTextLabelData::create(StringView, Colour, Vector3, float, bool)`.
50    ///
51    /// # Safety
52    /// `data` must be a live `IPlayerTextLabelData`.
53    #[must_use]
54    pub fn player_textlabels_create(
55        data: IPlayerTextLabelData,
56        text: StringView,
57        colour: Colour,
58        pos: Vector3,
59        draw_dist: f32,
60        los: bool,
61    ) -> *mut IPlayerTextLabel = [0, SLOT_CREATE] or std::ptr::null_mut();
62
63    /// `IPlayerTextLabel * IPlayerTextLabelData::create(StringView, Colour, Vector3, float, bool, IPlayer &)`.
64    ///
65    /// # Safety
66    /// `data` must be a live `IPlayerTextLabelData`.
67    #[must_use]
68    pub fn player_textlabels_create_on_player(
69        data: IPlayerTextLabelData,
70        text: StringView,
71        colour: Colour,
72        pos: Vector3,
73        draw_dist: f32,
74        los: bool,
75        attach: *mut IPlayer,
76    ) -> *mut IPlayerTextLabel = [0, SLOT_CREATE_ON_PLAYER] or std::ptr::null_mut();
77
78    /// `IPlayerTextLabel * IPlayerTextLabelData::create(StringView, Colour, Vector3, float, bool, IVehicle &)`.
79    ///
80    /// # Safety
81    /// `data` must be a live `IPlayerTextLabelData`.
82    #[must_use]
83    pub fn player_textlabels_create_on_vehicle(
84        data: IPlayerTextLabelData,
85        text: StringView,
86        colour: Colour,
87        pos: Vector3,
88        draw_dist: f32,
89        los: bool,
90        attach: *mut IVehicle,
91    ) -> *mut IPlayerTextLabel = [0, SLOT_CREATE_ON_VEHICLE] or std::ptr::null_mut();
92}