Ragemp-essentials NPM

Документация: RAGE:MP Essentials

Описание

Утилиты для упрощения работы с API RAGE:MP.

Разделы документации

Управление метками (Blip) – создание и настройка меток на карте.

Установка

Установите пакет с помощью npm:

npm i ragemp-essentials

Использование

Импортируйте essentials в ваш проект:

import { essentials } from 'ragemp-essentials';

Возможности

Удобные вспомогательные функции для работы с API RAGE:MP
Оптимизированная обработка серверных событий
Улучшенная структура кода

Готово к использованию прямо из коробки!

Управление Blip

Описание

Класс Blip предназначен для управления метками (Blip) на карте в RAGE:MP. Он позволяет создавать одну или несколько меток с различными параметрами настройки.

Подключение библиотеки

Перед использованием необходимо импортировать библиотеку:

import { essentials } from 'ragemp-essentials';

Использование

Создание одной метки

Для создания одной метки используется метод essentials.blip.create().

Пример:

essentials.blip.create(1, new mp.Vector3(427.95, -981.05, 0), {
    name: "Los Santos Police Station",
    scale: 1.2,
    color: 3,
    shortRange: true
});

Создание нескольких меток

Если необходимо создать несколько меток, передайте массив координат в essentials.blip.create().

Пример:

const Coords = [
    new mp.Vector3(427.95, -981.05, 0),
    new mp.Vector3(460.12, -991.67, 0),
    new mp.Vector3(489.56, -1023.29, 0),
    new mp.Vector3(500.00, -1050.00, 0)
];

essentials.blip.create(1, Coords, {
    name: "Los Santos Police Station",
    scale: 1.2,
    color: 3,
    shortRange: true
});

Интерфейс `BlipOptions`

Определяет настройки, которые могут быть применены к создаваемым меткам.

Поля:

name (string, необязательное) — Название метки.
scale (number, необязательное) — Масштаб метки (по умолчанию 1).
color (number, необязательное) — Цвет метки (по умолчанию 0).
alpha (number, необязательное) — Прозрачность метки (по умолчанию 255).
drawDistance (number, необязательное) — Дистанция прорисовки (по умолчанию 100).
shortRange (boolean, необязательное) — Будет ли метка видна только вблизи (по умолчанию false).
rotation (number, необязательное) — Угол поворота метки (по умолчанию 0).
radius (number, необязательное) — Радиус метки.
dimension (number, необязательное) — Измерение, в котором будет находиться метка (по умолчанию 0).