Exports

Call the exports on exports.road_pausemenu.

Native blips

GTA icon blips from every resource appear on the map and minimap automatically. To also carry their names, descriptions, radius areas and route flags across, add this line to the other resource’s fxmanifest.lua, before its other client scripts:

fxmanifest.lua

client_script '@road_pausemenu/integrations/blips.lua'

Restart that resource once after adding the line. The integration keeps the return values of the GTA blip natives, so the resource works as before.

RegisterBlip

Client-side. Registers name, description and area of a blip you created.

table

required

Show properties

number

required

Blip handle

string

required

Owning resource, GetCurrentResourceName(). The registration is removed when it stops

string

Name shown on the map and in the search, up to 100 characters

string

Text shown when the blip is selected, up to 400 characters

number

Icon scale

boolean

The blip has a GPS route, like SetBlipRoute

number

Radius of a circle area in metres

number

Width of a rectangle area

number

Height of a rectangle area

number

Rotation of a rectangle area in degrees

boolean

false if the blip does not exist.

local blip = AddBlipForCoord(-340.0, -1000.0, 30.0)
SetBlipSprite(blip, 267)

exports.road_pausemenu:RegisterBlip({
    handle = blip,
    owner = GetCurrentResourceName(),
    name = 'Public parking',
    description = 'Open to all drivers',
    scale = 0.8,
    route = false
})

Sprite, color, alpha, display mode, coordinates and deletion keep using the normal GTA natives.

DescribeBlip

Client-side. Sets only name and description.

number

required

Blip handle

string

required

Name

string

Description

exports.road_pausemenu:DescribeBlip(blip, 'Public parking', 'Open to all drivers')

Territories

AddZone and RemoveZone exist on the server and on the client with the same arguments. Server territories are sent to all players; client territories stay on that one client.

AddZone

string

required

Letters, numbers, _ and -, up to 80 characters. Unique across all resources.

table

required

Show properties

string

Name, up to 80 characters

string

Description, up to 400 characters

string

Hex color like #5da9ff (default)

number

0 to 1, default 0.25

table

required

3 to 256 world points { x, y } in drawing order, no crossing edges

boolean

false if the id or polygon is invalid.

exports.road_pausemenu:AddZone('business_district', {
    name = 'Business district',
    description = 'Downtown commercial area',
    color = '#5da9ff',
    opacity = 0.25,
    points = {
        { x = 100.0, y = -1100.0 },
        { x = 400.0, y = -1100.0 },
        { x = 350.0, y = -800.0 },
        { x = 120.0, y = -850.0 }
    }
})

RemoveZone

string

required

Territory id

boolean

false if the territory does not exist or belongs to another resource.

exports.road_pausemenu:RemoveZone('business_district')

Only the resource that added a territory can remove it. Its territories are removed when it stops. Client-side.

exports.road_pausemenu:OpenMap() -- returns whether opening started
exports.road_pausemenu:CloseMenu()
exports.road_pausemenu:SetMinimapVisible(false) -- hide, e.g. during a cutscene
exports.road_pausemenu:SetMinimapVisible(true)

SetMinimapVisible(false) hides the minimap until you call it with true. It does not change the player’s own Show minimap setting.

API documentation

RoadVR

RoadPhone Pro

RoadPhone

RoadPad

RoadCarRadio

Road Minigolf

RoadPark

RoadBanking

Road Pause Menu

RoadGarage

Exports

Exports

Native blips

RegisterBlip

DescribeBlip

Territories

AddZone

RemoveZone

Menu and minimap

​Exports

​Native blips

​RegisterBlip

​DescribeBlip

​Territories

​AddZone

​RemoveZone

​Menu and minimap

Exports

Native blips

RegisterBlip

DescribeBlip

Territories

AddZone

RemoveZone

Menu and minimap