samp_sdk/omp/generated/
player_checkpoints.rs

1//! `IPlayerCheckpointData` — generated by `cargo xtask gen-omp` from `Server/Components/Checkpoints/checkpoints.hpp`.
2//! Implemented by `PlayerCheckpointData` in the server's `Checkpoints`.
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 `IPlayerCheckpointData*`.
20    pub IPlayerCheckpointData;
21}
22
23/// `PlayerCheckpointData_UID` in `Server/Components/Checkpoints/checkpoints.hpp`.
24pub const PLAYER_CHECKPOINTS_UID: UID = 0xbc07576aa3591a66;
25
26/// The player's `IPlayerCheckpointData`, or null when the component providing it is not loaded.
27///
28/// Found by walking the player's extension map for `PLAYER_CHECKPOINTS_UID` — the
29/// virtual `getExtension` does not consult that map. `IExtension`
30/// is `IPlayerCheckpointData`'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_checkpoints(player: *mut IPlayer) -> *mut IPlayerCheckpointData {
36    unsafe { extension(player.cast::<u8>(), PLAYER_CHECKPOINTS_UID) }
37        .cast::<IPlayerCheckpointData>()
38}
39
40slots! {
41    /// `IRaceCheckpointData & IPlayerCheckpointData::getRaceCheckpoint()`
42    SLOT_GET_RACE_CHECKPOINT: usize = 3, 3;
43    /// `ICheckpointData & IPlayerCheckpointData::getCheckpoint()`
44    SLOT_GET_CHECKPOINT: usize = 4, 4;
45}
46
47virtual_fns! {
48    /// `IRaceCheckpointData & IPlayerCheckpointData::getRaceCheckpoint()`.
49    ///
50    /// # Safety
51    /// `data` must be a live `IPlayerCheckpointData`.
52    #[must_use]
53    pub fn player_checkpoints_race_checkpoint(
54        data: IPlayerCheckpointData,
55    ) -> *mut IRaceCheckpointData = [0, SLOT_GET_RACE_CHECKPOINT] or std::ptr::null_mut();
56
57    /// `ICheckpointData & IPlayerCheckpointData::getCheckpoint()`.
58    ///
59    /// # Safety
60    /// `data` must be a live `IPlayerCheckpointData`.
61    #[must_use]
62    pub fn player_checkpoints_checkpoint(
63        data: IPlayerCheckpointData,
64    ) -> *mut ICheckpointData = [0, SLOT_GET_CHECKPOINT] or std::ptr::null_mut();
65}
samp_sdk/omp/generated/player_checkpoints.rs

samp_sdk/omp/generated/
player_checkpoints.rs
