Skip to content

jovanivanovic/altv-os-global-marker-manager

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Open Source - Global Marker Manager for alt:V

Created by Dzeknjak (Jovan Ivanovic)

❤️ Please support my open source work by donating. I'm here to provide general context for complicated procedures for you new developers. ❤️

https://www.buymeacoffee.com/dzeknjak

⭐ This repository if you found it useful!


Description

This is a basic global marker manager resource. It allows you to create/destroy markers from the server-side for all players.

Installing Dependencies / Installation

I cannot stress this enough. Ensure you have NodeJS 13+ or you will have problems.

  • NodeJS 13+
  • An Existing or New Gamemode
  • General Scripting Knowledge

Afterwards, simply add the name of this resource to your server.cfg resource section.

altv-os-global-marker-manager

Then simply clone this repository into your main server resources folder.

cd resources
git clone https://github.com/jovanivanovic/altv-os-global-marker-manager

Ensure your package.json includes this property:

"type": "module"

Example

import alt from 'alt-server';

// Create a simple red marker
alt.emit(
    'markers:Create',
    0, // unique identifier
    1, // type of the marker
    new alt.Vector3(0, 0, 72), // position of the marker
    new alt.Vector3(0, 0, 0), // direction of the marker
    new alt.Vector3(0, 0, 0), // rotation of the marker
    new alt.Vector3(1, 1, 1), // scale of the marker
    { // color of the marker
        red: 255, 
        green: 0, 
        blue: 0, 
        alpha: 100 
    } 
);

// Sync all of the created markers with the newly connected player
alt.on('playerConnect', player => {
    alt.emit('markers:Sync', player);
});

Usage

There's couple of events to get you started with this resource:

// Notice: these events are serverside only.

Creating a marker

alt.emit('markers:Create', identifier, type, position, direction, rotation, scale, color);
Argument Description
identifier Unique identifier for the marker, can be anything as long as it is unique.
type Type of the marker to show.
position { x, y, z } Location of the marker.
direction { x, y, z } Direction of the marker.
rotation { x, y, z } Rotation of the marker.
scale { x, y, z } Scale of the marker.
color { red, green, blue, alpha } Color of the marker.

For marker types take a look here: alt:V Wiki - Markers


Deleting a marker

alt.emit('markers:Delete', identifier);
Argument Description
identifier Previously set unique identifier of the marker you wish to delete.

Changing the draw distance

// Notice: default draw distance is set to 150.
alt.emit('markers:SetDrawDistance', distance);
Argument Description
distance Sets the draw distance at which the markers appear.

Syncing the markers with a player

// Notice: you should probably call this event on player connect.

alt.emit('markers:Sync', player);
Argument Description
player Player handle you wish to sync the markers with.

Other alt:V Open Source Resources

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published