rust-samp-sdk 3.6.0

Low-level FFI bindings for the SA-MP AMX virtual machine and open.mp native component ABI. Used internally by `rust-samp`; depend on it directly only if you need raw access without the higher-level macros and lifecycle.
Documentation
//! `IPlayerVehicleData` — generated by `cargo xtask gen-omp` from `Server/Components/Vehicles/vehicles.hpp`.
//! Implemented by `PlayerVehicleData` in the server's `Vehicles`.
//!
//! Do not edit: change `xtask/omp-wrappers.toml` or the generator and
//! regenerate. Slots are clang's layout of the header for each ABI, checked
//! against the official binaries by `cargo xtask check-abi --generated`.

#![allow(unused_imports)]

use crate::omp::containers::{FlatSet, HybridString, Pair, Span};
use crate::omp::types::{
    Colour, GTAQuat, Hours, Microseconds, Milliseconds, Minutes, Seconds, StringView, TimePoint,
    UID, Vector2, Vector3, Vector4, WorldTimePoint,
};
use crate::omp::vtable::{call_vtable_small_struct, opaque, slots, virtual_fns};
use crate::omp::*;

opaque! {
    /// Opaque handle for `IPlayerVehicleData*`.
    pub IPlayerVehicleData;
}

/// `SomePlayerData_UID` in `Server/Components/Vehicles/vehicles.hpp`.
pub const PLAYER_VEHICLES_UID: UID = 0xa960485be6c70fb2;

/// The player's `IPlayerVehicleData`, or null when the component providing it is not loaded.
///
/// Found by walking the player's extension map for `PLAYER_VEHICLES_UID` — the
/// virtual `getExtension` does not consult that map. `IExtension`
/// is `IPlayerVehicleData`'s first base, so the extension pointer is the interface pointer.
///
/// # Safety
/// `player` must be a live `IPlayer`.
#[must_use]
pub unsafe fn player_vehicles(player: *mut IPlayer) -> *mut IPlayerVehicleData {
    unsafe { extension(player.cast::<u8>(), PLAYER_VEHICLES_UID) }.cast::<IPlayerVehicleData>()
}

slots! {
    /// `IVehicle * IPlayerVehicleData::getVehicle()`
    SLOT_GET_VEHICLE: usize = 3, 3;
    /// `void IPlayerVehicleData::resetVehicle()`
    SLOT_RESET_VEHICLE: usize = 4, 4;
    /// `int IPlayerVehicleData::getSeat()`
    SLOT_GET_SEAT: usize = 5, 5;
    /// `bool IPlayerVehicleData::isInModShop()`
    SLOT_IS_IN_MOD_SHOP: usize = 6, 6;
    /// `bool IPlayerVehicleData::isInDriveByMode()`
    SLOT_IS_IN_DRIVE_BY_MODE: usize = 7, 7;
    /// `bool IPlayerVehicleData::isCuffed()`
    SLOT_IS_CUFFED: usize = 8, 8;
}

virtual_fns! {
    /// `IVehicle * IPlayerVehicleData::getVehicle()`.
    ///
    /// # Safety
    /// `data` must be a live `IPlayerVehicleData`.
    #[must_use]
    pub fn player_vehicles_vehicle(
        data: IPlayerVehicleData,
    ) -> *mut IVehicle = [0, SLOT_GET_VEHICLE] or std::ptr::null_mut();

    /// `void IPlayerVehicleData::resetVehicle()`.
    ///
    /// # Safety
    /// `data` must be a live `IPlayerVehicleData`.
    pub fn player_vehicles_reset_vehicle(data: IPlayerVehicleData) = [0, SLOT_RESET_VEHICLE];

    /// `int IPlayerVehicleData::getSeat()`.
    ///
    /// # Safety
    /// `data` must be a live `IPlayerVehicleData`.
    #[must_use]
    pub fn player_vehicles_seat(data: IPlayerVehicleData) -> i32 = [0, SLOT_GET_SEAT] or 0;

    /// `bool IPlayerVehicleData::isInModShop()`.
    ///
    /// # Safety
    /// `data` must be a live `IPlayerVehicleData`.
    #[must_use]
    pub fn player_vehicles_is_in_mod_shop(
        data: IPlayerVehicleData,
    ) -> bool = [0, SLOT_IS_IN_MOD_SHOP] or false;

    /// `bool IPlayerVehicleData::isInDriveByMode()`.
    ///
    /// # Safety
    /// `data` must be a live `IPlayerVehicleData`.
    #[must_use]
    pub fn player_vehicles_is_in_drive_by_mode(
        data: IPlayerVehicleData,
    ) -> bool = [0, SLOT_IS_IN_DRIVE_BY_MODE] or false;

    /// `bool IPlayerVehicleData::isCuffed()`.
    ///
    /// # Safety
    /// `data` must be a live `IPlayerVehicleData`.
    #[must_use]
    pub fn player_vehicles_is_cuffed(
        data: IPlayerVehicleData,
    ) -> bool = [0, SLOT_IS_CUFFED] or false;
}