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

slots! {
    /// `void ITextLabelBase::setText(StringView)`
    SLOT_SET_TEXT: usize = 6, 5;
    /// `StringView ITextLabelBase::getText()`
    SLOT_GET_TEXT: usize = 7, 6;
    /// `void ITextLabelBase::setColour(Colour)`
    SLOT_SET_COLOUR: usize = 8, 7;
    /// `Colour ITextLabelBase::getColour()`
    SLOT_GET_COLOUR: usize = 9, 8;
    /// `void ITextLabelBase::setDrawDistance(float)`
    SLOT_SET_DRAW_DISTANCE: usize = 10, 9;
    /// `float ITextLabelBase::getDrawDistance()`
    SLOT_GET_DRAW_DISTANCE: usize = 11, 10;
    /// `void ITextLabelBase::attachToPlayer(IPlayer &, Vector3)`
    SLOT_ATTACH_TO_PLAYER: usize = 12, 11;
    /// `void ITextLabelBase::attachToVehicle(IVehicle &, Vector3)`
    SLOT_ATTACH_TO_VEHICLE: usize = 13, 12;
    /// `const TextLabelAttachmentData & ITextLabelBase::getAttachmentData()`
    SLOT_GET_ATTACHMENT_DATA: usize = 14, 13;
    /// `void ITextLabelBase::detachFromPlayer(Vector3)`
    SLOT_DETACH_FROM_PLAYER: usize = 15, 14;
    /// `void ITextLabelBase::detachFromVehicle(Vector3)`
    SLOT_DETACH_FROM_VEHICLE: usize = 16, 15;
    /// `void ITextLabelBase::setTestLOS(bool)`
    SLOT_SET_TEST_LOS: usize = 17, 16;
    /// `bool ITextLabelBase::getTestLOS()`
    SLOT_GET_TEST_LOS: usize = 18, 17;
    /// `void ITextLabelBase::setColourAndText(Colour, StringView)`
    SLOT_SET_COLOUR_AND_TEXT: usize = 19, 18;
}

virtual_fns! {
    /// `void ITextLabelBase::setText(StringView)`.
    ///
    /// # Safety
    /// `player_textlabel` must be a live `IPlayerTextLabel`.
    pub fn player_textlabel_set_text(
        player_textlabel: IPlayerTextLabel,
        text: StringView,
    ) = [0, SLOT_SET_TEXT];

    /// `void ITextLabelBase::setColour(Colour)`.
    ///
    /// # Safety
    /// `player_textlabel` must be a live `IPlayerTextLabel`.
    pub fn player_textlabel_set_colour(
        player_textlabel: IPlayerTextLabel,
        colour: Colour,
    ) = [0, SLOT_SET_COLOUR];

    /// `void ITextLabelBase::setDrawDistance(float)`.
    ///
    /// # Safety
    /// `player_textlabel` must be a live `IPlayerTextLabel`.
    pub fn player_textlabel_set_draw_distance(
        player_textlabel: IPlayerTextLabel,
        dist: f32,
    ) = [0, SLOT_SET_DRAW_DISTANCE];

    /// `float ITextLabelBase::getDrawDistance()`.
    ///
    /// # Safety
    /// `player_textlabel` must be a live `IPlayerTextLabel`.
    #[must_use]
    pub fn player_textlabel_draw_distance(
        player_textlabel: IPlayerTextLabel,
    ) -> f32 = [0, SLOT_GET_DRAW_DISTANCE] or 0.0;

    /// `void ITextLabelBase::attachToPlayer(IPlayer &, Vector3)`.
    ///
    /// # Safety
    /// `player_textlabel` must be a live `IPlayerTextLabel`.
    pub fn player_textlabel_attach_to_player(
        player_textlabel: IPlayerTextLabel,
        player: *mut IPlayer,
        offset: Vector3,
    ) = [0, SLOT_ATTACH_TO_PLAYER];

    /// `void ITextLabelBase::attachToVehicle(IVehicle &, Vector3)`.
    ///
    /// # Safety
    /// `player_textlabel` must be a live `IPlayerTextLabel`.
    pub fn player_textlabel_attach_to_vehicle(
        player_textlabel: IPlayerTextLabel,
        vehicle: *mut IVehicle,
        offset: Vector3,
    ) = [0, SLOT_ATTACH_TO_VEHICLE];

    /// `const TextLabelAttachmentData & ITextLabelBase::getAttachmentData()`.
    ///
    /// # Safety
    /// `player_textlabel` must be a live `IPlayerTextLabel`.
    #[must_use]
    pub fn player_textlabel_attachment_data(
        player_textlabel: IPlayerTextLabel,
    ) -> *const TextLabelAttachmentData = [0, SLOT_GET_ATTACHMENT_DATA] or std::ptr::null();

    /// `void ITextLabelBase::detachFromPlayer(Vector3)`.
    ///
    /// # Safety
    /// `player_textlabel` must be a live `IPlayerTextLabel`.
    pub fn player_textlabel_detach_from_player(
        player_textlabel: IPlayerTextLabel,
        position: Vector3,
    ) = [0, SLOT_DETACH_FROM_PLAYER];

    /// `void ITextLabelBase::detachFromVehicle(Vector3)`.
    ///
    /// # Safety
    /// `player_textlabel` must be a live `IPlayerTextLabel`.
    pub fn player_textlabel_detach_from_vehicle(
        player_textlabel: IPlayerTextLabel,
        position: Vector3,
    ) = [0, SLOT_DETACH_FROM_VEHICLE];

    /// `void ITextLabelBase::setTestLOS(bool)`.
    ///
    /// # Safety
    /// `player_textlabel` must be a live `IPlayerTextLabel`.
    pub fn player_textlabel_set_test_los(
        player_textlabel: IPlayerTextLabel,
        status: bool,
    ) = [0, SLOT_SET_TEST_LOS];

    /// `bool ITextLabelBase::getTestLOS()`.
    ///
    /// # Safety
    /// `player_textlabel` must be a live `IPlayerTextLabel`.
    #[must_use]
    pub fn player_textlabel_test_los(
        player_textlabel: IPlayerTextLabel,
    ) -> bool = [0, SLOT_GET_TEST_LOS] or false;

    /// `void ITextLabelBase::setColourAndText(Colour, StringView)`.
    ///
    /// # Safety
    /// `player_textlabel` must be a live `IPlayerTextLabel`.
    pub fn player_textlabel_set_colour_and_text(
        player_textlabel: IPlayerTextLabel,
        colour: Colour,
        text: StringView,
    ) = [0, SLOT_SET_COLOUR_AND_TEXT];
}

/// `StringView ITextLabelBase::getText()`.
///
/// # Safety
/// `player_textlabel` must be a live `IPlayerTextLabel`.
#[must_use]
pub unsafe fn player_textlabel_text(player_textlabel: *mut IPlayerTextLabel) -> Option<String> {
    let view = call_vtable_small_struct!(
        player_textlabel.cast::<u8>(),
        0,
        SLOT_GET_TEXT,
        StringView,
        StringView::EMPTY
    )?;
    unsafe { view.to_owned_string() }
}

/// `Colour ITextLabelBase::getColour()`.
///
/// # Safety
/// `player_textlabel` must be a live `IPlayerTextLabel`.
#[must_use]
pub unsafe fn player_textlabel_colour(player_textlabel: *mut IPlayerTextLabel) -> Option<Colour> {
    call_vtable_small_struct!(
        player_textlabel.cast::<u8>(),
        0,
        SLOT_GET_COLOUR,
        Colour,
        Colour::default()
    )
}