For the complete documentation index, see llms.txt. This page is also available as Markdown.

Server Side

There’s no matching export for you? Contact us through our Discord server, and we will do our best to assist you!

addMapBlip

Add blip to all gang members into Crime Tablet

exports['op-crime']:addMapBlip(blipUniqueName, data)

Parameters

  • blipUniqueName: string

  • data: table

Example usage:

local ok, err = exports['op-crime']:addMapBlip("my_blip", {
    label       = "Drug Dealer",
    description = "Sells everything from coke to fentanyl",
    coords      = vec3(123.4, 567.8, 30.0),
    icon        = "skull",          -- Google Icons
    color       = "#ff4b3a",        -- Blip Color
})

removeMapBlip

Removes blip from Crime Tablet by unique id

Parameters

  • blipUniqueName: string

Example usage:

CreateGang

Create new organisation/gang and return created organisation index.

Parameters

  • data: table

  • cb: function


Data Object

  • orgLabel: string

  • rankName: string

  • color: string

  • graffitiUrl: string

  • shellValue: string|number

  • isInteriorMode: shell | ipl | mlo

  • garageCoords: table

    • x: number

    • y: number

    • z: number

    • w: number

  • entranceCoords: table

    • x: number

    • y: number

    • z: number

    • w: number

  • bossmenuCoords: table

    • x: number

    • y: number

    • z: number

  • stashCoords: table

    • x: number

    • y: number

    • z: number

  • cloakRoomCoords: table

    • x: number

    • y: number

    • z: number

  • newOwner: table

    • identificator: string


Callback Response

  • status: boolean

  • jobIndex: number

  • message: string?


Example Usage


Notes

  • Export returns jobIndex immediately after organisation creation.

  • Owner assignment and additional sync actions are processed in background.

  • This export can be safely used by external resources.

EditGang


Edit existing organisation/gang and return edited organisation index.

  • data: table

  • cb: function

Data Object:

  • editOrgIndex: number|string

  • orgLabel: string

  • rankName: string

  • color: string

  • graffitiUrl: string

  • shellValue: string|number

  • isInteriorMode: string — shell / ipl / mlo

  • garageCoords: table

  • entranceCoords: table

  • bossmenuCoords: table

  • stashCoords: table

  • cloakRoomCoords: table

  • oldOwner: table optional

  • newOwner: table optional

Callback Response:

  • status: boolean

  • jobIndex: number

  • message: string optional

Example usage:

Notes:

  • If oldOwner and newOwner are provided and their identifiers are different, the owner will be changed automatically.

  • If oldOwner or newOwner is not provided, owner change will be skipped.

  • Online members of the edited organisation will be synced automatically.

  • This export can be safely used by external resources.

getOrganisationsList


Return object

  • identifier: number

  • label: string

isTurfZoneInRivalry


Return false or true.

isPlayerTurfOwner


Return false or true.

getPlayerTurfZone


Return index of player turf zone or nil. Useful for drugs selling script integrations.

getPlayerOrganisation


Return player organisation data object.

  • identifier: string

Data Object:

  • orgIndex: number

  • player: table

    • identifier: string

    • totalTime: string

    • rank: string

    • status: string

  • orgData: table

getOrganisation


Return organisation object.

  • id: number


Server Side Events:

Add Organisation EXP

Data:

  • orgId: number;

  • amount: number;

Example usage:


Add Organisation Money

Data:

  • orgId: number;

  • amount: number;

  • account: string; (balance/dirtymoney)

Example usage:


Remove Organisation Money

Data:

  • orgId: number;

  • amount: number;

  • account: string; (balance/dirtymoney)

Example usage:


Add Organisation Missions Done

Data:

  • orgId: number;

  • amount: number;

Example usage:


Add Organisation Zones Captured

Data:

  • orgId: number;

  • amount: number;

Example usage:


Zone Captured Event

AddEventHandler('op-crime:zoneCaptured', newOrgId, oldOrgId, ZoneConfig)

This is server-side event which is called when PVP zone is properly captured.

decreaseSelected


Decrease Selected gang loyality in selected turf zone

  • jobId: string

  • decreaseAmount: number

  • turfIndex: string

increaseSelected


Increase Selected gang loyality in selected turf zone

  • jobId: string

  • amount: number

  • turfIndex: string

increaseZoneLoyality


Increase Selected gang loyality in selected turf zone and decrease every other gang loyality in this zone

  • jobId: string

  • amount: number

  • turfIndex: string

  • decreaseAmount: number

Last updated