Graphics::createCheckpoint

From RAGE Multiplayer Wiki

Client-Side
Function

 JavaScript



JavaScript Syntax


Creates a checkpoint in the game world, returning a handle to reference it. Checkpoints are customizable markers often used for navigation, objectives, or area marking.

Checkpoint Types

Each `type` value corresponds to different checkpoint styles: - **0-4, 5-9, 20-24, 25-29, 30-34**: Cylinder types with 1 to 3 arrows, CycleArrow, Checker. - **10-14, 15-19**: Ring styles with various arrow options. - **35-38**: Airplane Ring types for specific directions. - **40**: Simple ring. - **42-44**: Numbered cylinders using the `reserved` parameter for customization.

Reserved Parameter

For `type` values 42-44, `reserved` controls the displayed number and style, allowing further customization: - **0-99**: Number display. - **100-179**: Arrow or CycleArrow display. - **180-189**: Sphere.

Syntax

mp.game.graphics.createCheckpoint(type, posX1, posY1, posZ1, posX2, posY2, posZ2, radius, colorR, colorG, colorB, alpha, reserved);

Required Arguments

  • type: int - Type of checkpoint to create.
  • posX1, posY1, posZ1: float - Coordinates of the checkpoint position.
  • posX2, posY2, posZ2: float - Coordinates pointing to the next checkpoint.
  • radius: float - Radius of the checkpoint.
  • colorR, colorG, colorB: int - RGB color values.
  • alpha: int - Transparency level (0-255).
  • reserved: int - Used for numbered checkpoints (42-44).

Return value

  • int - Handle to the created checkpoint.

Example

This example creates a white ring checkpoint for an airplane marker at a specified position. 

const type = 35; // Airplane ring
const position1 = { x: -115, y: -848, z: 36 };
const position2 = { x: -115, y: -848, z: 39 };
const radius = 1.0;
const color = { r: 255, g: 255, b: 255, a: 150 };
const reserved = 0;

mp.game.graphics.createCheckpoint(type, position1.x, position1.y, position1.z, position2.x, position2.y, position2.z, radius, color.r, color.g, color.b, color.a, reserved);


See also

Retrieved from "https://wiki.rage.mp/w/index.php?title=Graphics::createCheckpoint&oldid=26820"