Home

Documentation

Welcome to the full documentation! Here, you'll find how to correctly use this resource and I think we can now call it a library.

Like it said in the README, to use it, you can call some exported functions or use map directive. But to start, let's talk about all features.

3D Text

Draw a 3D text.

Parameters:

• Identifier (string): need to be unique
• Text (string): the text to display
• Font (int): Same as GTAV fonts
• Color (object {R, G, B}): RGB color
• Scale (Vector2): 2D scale
• Pos (Vector3): Position
• MaxDistance (float): Max distance to see the text

Marker

Draw a marker.

Parameters:

• Identifier (string): need to be unique
• Type (int): Marker type, you can find them here
• Pos (Vector3): Position
• Color (object {R, G, B}): RGB color
• Scale (Vector3): 3D scale
• MaxDistance (float): Max distance to see the marker
• Action (EventAction): event or callback object

Area

Invisible Area in the world that detect when player enter or exit

Parameters:

• Identifier (string): need to be unique
• Type (int): Marker type (Sphere, Circle, Box, Custom)
• Data (object): Shape data
• OnEnter (string / function): On enter event or callback
• OnExit (string / function): On exit event or callback
• Params (dynamic): parameter to send to the event or callback
• Debug (bool): Display the area to debug

Pickup

Prop sync over the network

Parameters:

• Pos (Vector3): Position
• Model (string): prop model
• Dynamic (bool): is dynamic
• OnGround (bool): Spawn on ground when spawn
• DeleteOnAction (bool): delete when triggered
• Action (EventAction): event object

EventAction

Action triggered by Marker action or pickup action

Parameters:

• Action (int) : Trigger type (0: Auto / 1: Control Pressed)
• Control (int): Control index, list here
• HelpText (string): Help text display when can be triggered
• Callback (string / function): event or callback to trigger
• Params (dynamic): parameter to send to the event or callback