Skip to main content

samp_sdk/omp/generated/
player_vehicles.rs

1//! `IPlayerVehicleData` — generated by `cargo xtask gen-omp` from `Server/Components/Vehicles/vehicles.hpp`.
2//! Implemented by `PlayerVehicleData` in the server's `Vehicles`.
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 `IPlayerVehicleData*`.
20    pub IPlayerVehicleData;
21}
22
23/// `SomePlayerData_UID` in `Server/Components/Vehicles/vehicles.hpp`.
24pub const PLAYER_VEHICLES_UID: UID = 0xa960485be6c70fb2;
25
26/// The player's `IPlayerVehicleData`, or null when the component providing it is not loaded.
27///
28/// Found by walking the player's extension map for `PLAYER_VEHICLES_UID` — the
29/// virtual `getExtension` does not consult that map. `IExtension`
30/// is `IPlayerVehicleData`'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_vehicles(player: *mut IPlayer) -> *mut IPlayerVehicleData {
36    unsafe { extension(player.cast::<u8>(), PLAYER_VEHICLES_UID) }.cast::<IPlayerVehicleData>()
37}
38
39slots! {
40    /// `IVehicle * IPlayerVehicleData::getVehicle()`
41    SLOT_GET_VEHICLE: usize = 3, 3;
42    /// `void IPlayerVehicleData::resetVehicle()`
43    SLOT_RESET_VEHICLE: usize = 4, 4;
44    /// `int IPlayerVehicleData::getSeat()`
45    SLOT_GET_SEAT: usize = 5, 5;
46    /// `bool IPlayerVehicleData::isInModShop()`
47    SLOT_IS_IN_MOD_SHOP: usize = 6, 6;
48    /// `bool IPlayerVehicleData::isInDriveByMode()`
49    SLOT_IS_IN_DRIVE_BY_MODE: usize = 7, 7;
50    /// `bool IPlayerVehicleData::isCuffed()`
51    SLOT_IS_CUFFED: usize = 8, 8;
52}
53
54virtual_fns! {
55    /// `IVehicle * IPlayerVehicleData::getVehicle()`.
56    ///
57    /// # Safety
58    /// `data` must be a live `IPlayerVehicleData`.
59    #[must_use]
60    pub fn player_vehicles_vehicle(
61        data: IPlayerVehicleData,
62    ) -> *mut IVehicle = [0, SLOT_GET_VEHICLE] or std::ptr::null_mut();
63
64    /// `void IPlayerVehicleData::resetVehicle()`.
65    ///
66    /// # Safety
67    /// `data` must be a live `IPlayerVehicleData`.
68    pub fn player_vehicles_reset_vehicle(data: IPlayerVehicleData) = [0, SLOT_RESET_VEHICLE];
69
70    /// `int IPlayerVehicleData::getSeat()`.
71    ///
72    /// # Safety
73    /// `data` must be a live `IPlayerVehicleData`.
74    #[must_use]
75    pub fn player_vehicles_seat(data: IPlayerVehicleData) -> i32 = [0, SLOT_GET_SEAT] or 0;
76
77    /// `bool IPlayerVehicleData::isInModShop()`.
78    ///
79    /// # Safety
80    /// `data` must be a live `IPlayerVehicleData`.
81    #[must_use]
82    pub fn player_vehicles_is_in_mod_shop(
83        data: IPlayerVehicleData,
84    ) -> bool = [0, SLOT_IS_IN_MOD_SHOP] or false;
85
86    /// `bool IPlayerVehicleData::isInDriveByMode()`.
87    ///
88    /// # Safety
89    /// `data` must be a live `IPlayerVehicleData`.
90    #[must_use]
91    pub fn player_vehicles_is_in_drive_by_mode(
92        data: IPlayerVehicleData,
93    ) -> bool = [0, SLOT_IS_IN_DRIVE_BY_MODE] or false;
94
95    /// `bool IPlayerVehicleData::isCuffed()`.
96    ///
97    /// # Safety
98    /// `data` must be a live `IPlayerVehicleData`.
99    #[must_use]
100    pub fn player_vehicles_is_cuffed(
101        data: IPlayerVehicleData,
102    ) -> bool = [0, SLOT_IS_CUFFED] or false;
103}