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
//! `IPlayerObjectData` — generated by `cargo xtask gen-omp` from `Server/Components/Objects/objects.hpp`.
//! Implemented by `PlayerObjectData` in the server's `Objects`.
//!
//! 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 `IPlayerObjectData*`.
    pub IPlayerObjectData;
}

/// `PlayerObjectData_UID` in `Server/Components/Objects/objects.hpp`.
pub const PLAYER_OBJECTS_UID: UID = 0x93d4ed2344b07456;

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

slots! {
    /// `IPlayerObject * IPlayerObjectData::create(int, Vector3, Vector3, float)`
    SLOT_CREATE: usize = 3, 3;
    /// `void IPlayerObjectData::setAttachedObject(int, const ObjectAttachmentSlotData &)`
    SLOT_SET_ATTACHED_OBJECT: usize = 4, 4;
    /// `void IPlayerObjectData::removeAttachedObject(int)`
    SLOT_REMOVE_ATTACHED_OBJECT: usize = 5, 5;
    /// `bool IPlayerObjectData::hasAttachedObject(int)`
    SLOT_HAS_ATTACHED_OBJECT: usize = 6, 6;
    /// `const ObjectAttachmentSlotData & IPlayerObjectData::getAttachedObject(int)`
    SLOT_GET_ATTACHED_OBJECT: usize = 7, 7;
    /// `void IPlayerObjectData::beginSelecting()`
    SLOT_BEGIN_SELECTING: usize = 8, 8;
    /// `bool IPlayerObjectData::selectingObject()`
    SLOT_SELECTING_OBJECT: usize = 9, 9;
    /// `void IPlayerObjectData::endEditing()`
    SLOT_END_EDITING: usize = 10, 10;
    /// `void IPlayerObjectData::beginEditing(IObject &)`
    SLOT_BEGIN_EDITING: usize = 11, 12;
    /// `void IPlayerObjectData::beginEditing(IPlayerObject &)`
    SLOT_BEGIN_EDITING_PLAYER_OBJECT: usize = 12, 11;
    /// `bool IPlayerObjectData::editingObject()`
    SLOT_EDITING_OBJECT: usize = 13, 13;
    /// `void IPlayerObjectData::editAttachedObject(int)`
    SLOT_EDIT_ATTACHED_OBJECT: usize = 14, 14;
}

virtual_fns! {
    /// `IPlayerObject * IPlayerObjectData::create(int, Vector3, Vector3, float)`.
    ///
    /// # Safety
    /// `data` must be a live `IPlayerObjectData`.
    #[must_use]
    pub fn player_objects_create(
        data: IPlayerObjectData,
        model_id: i32,
        position: Vector3,
        rotation: Vector3,
        draw_dist: f32,
    ) -> *mut IPlayerObject = [0, SLOT_CREATE] or std::ptr::null_mut();

    /// `void IPlayerObjectData::setAttachedObject(int, const ObjectAttachmentSlotData &)`.
    ///
    /// # Safety
    /// `data` must be a live `IPlayerObjectData`.
    pub fn player_objects_set_attached_object(
        data: IPlayerObjectData,
        index: i32,
        other_data: &ObjectAttachmentSlotData,
    ) = [0, SLOT_SET_ATTACHED_OBJECT];

    /// `void IPlayerObjectData::removeAttachedObject(int)`.
    ///
    /// # Safety
    /// `data` must be a live `IPlayerObjectData`.
    pub fn player_objects_remove_attached_object(
        data: IPlayerObjectData,
        index: i32,
    ) = [0, SLOT_REMOVE_ATTACHED_OBJECT];

    /// `bool IPlayerObjectData::hasAttachedObject(int)`.
    ///
    /// # Safety
    /// `data` must be a live `IPlayerObjectData`.
    #[must_use]
    pub fn player_objects_has_attached_object(
        data: IPlayerObjectData,
        index: i32,
    ) -> bool = [0, SLOT_HAS_ATTACHED_OBJECT] or false;

    /// `const ObjectAttachmentSlotData & IPlayerObjectData::getAttachedObject(int)`.
    ///
    /// # Safety
    /// `data` must be a live `IPlayerObjectData`.
    #[must_use]
    pub fn player_objects_attached_object(
        data: IPlayerObjectData,
        index: i32,
    ) -> *const ObjectAttachmentSlotData = [0, SLOT_GET_ATTACHED_OBJECT] or std::ptr::null();

    /// `void IPlayerObjectData::beginSelecting()`.
    ///
    /// # Safety
    /// `data` must be a live `IPlayerObjectData`.
    pub fn player_objects_begin_selecting(data: IPlayerObjectData) = [0, SLOT_BEGIN_SELECTING];

    /// `bool IPlayerObjectData::selectingObject()`.
    ///
    /// # Safety
    /// `data` must be a live `IPlayerObjectData`.
    #[must_use]
    pub fn player_objects_selecting_object(
        data: IPlayerObjectData,
    ) -> bool = [0, SLOT_SELECTING_OBJECT] or false;

    /// `void IPlayerObjectData::endEditing()`.
    ///
    /// # Safety
    /// `data` must be a live `IPlayerObjectData`.
    pub fn player_objects_end_editing(data: IPlayerObjectData) = [0, SLOT_END_EDITING];

    /// `void IPlayerObjectData::beginEditing(IObject &)`.
    ///
    /// # Safety
    /// `data` must be a live `IPlayerObjectData`.
    pub fn player_objects_begin_editing(
        data: IPlayerObjectData,
        object: *mut IObject,
    ) = [0, SLOT_BEGIN_EDITING];

    /// `void IPlayerObjectData::beginEditing(IPlayerObject &)`.
    ///
    /// # Safety
    /// `data` must be a live `IPlayerObjectData`.
    pub fn player_objects_begin_editing_player_object(
        data: IPlayerObjectData,
        object: *mut IPlayerObject,
    ) = [0, SLOT_BEGIN_EDITING_PLAYER_OBJECT];

    /// `bool IPlayerObjectData::editingObject()`.
    ///
    /// # Safety
    /// `data` must be a live `IPlayerObjectData`.
    #[must_use]
    pub fn player_objects_editing_object(
        data: IPlayerObjectData,
    ) -> bool = [0, SLOT_EDITING_OBJECT] or false;

    /// `void IPlayerObjectData::editAttachedObject(int)`.
    ///
    /// # Safety
    /// `data` must be a live `IPlayerObjectData`.
    pub fn player_objects_edit_attached_object(
        data: IPlayerObjectData,
        index: i32,
    ) = [0, SLOT_EDIT_ATTACHED_OBJECT];
}