Server Side

Exports & Events

If you're looking for other data than listed here - feel free to contact us on our Discord Server!

StartMission

Starts a mission for a player. Soft gates (cooldown / requirements) are skipped via forced = true, but exclusive / maxPlayers are still enforced.

Returns: ok, reason

local ok, reason = exports['op-missioncreator']:StartMission(src, missionId, opts)

-- Example
local ok, err = exports['op-missioncreator']:StartMission(source, 'my_heist', {
    startStepId = 'step_1', -- optional
})

---

StartMissionWithLobby

Creates a co-op lobby with a fixed host + member roster and starts the mission immediately (no invite UI). The host is always included - members is a list of additional player server ids.

Returns: ok, lobbyId on success, false, reason on failure.

opts.forced defaults to true. opts.startStepId is optional.

local ok, lobbyId = exports['op-missioncreator']:StartMissionWithLobby(host, missionId, members, opts)

-- Example
local ok, result = exports['op-missioncreator']:StartMissionWithLobby(
    1,                -- host server id
    'my_heist',
    { 2, 3 },         -- additional members
    { startStepId = 'step_1' }
)

---

StopMission

Stops the player's current mission and clears the server registry slot.

exports['op-missioncreator']:StopMission(src, reason)

-- Example
exports['op-missioncreator']:StopMission(source, 'admin')

---

CanStartMission

Dry-run of the start gate. Checks requirements / cooldown / exclusive / queue / etc. without consuming items or starting anything.

Returns: ok, reason

local ok, reason = exports['op-missioncreator']:CanStartMission(src, missionId)

---

GetMissionRegistry

Returns all registered mission definitions ({ [missionId] = def, ... }).

local missions = exports['op-missioncreator']:GetMissionRegistry()

---

BroadcastMissionEvent

Sends a named event into the player's running mission runtime (received as a mission event on the client).

exports['op-missioncreator']:BroadcastMissionEvent(src, name, data)

-- Example
exports['op-missioncreator']:BroadcastMissionEvent(source, 'policeAlert', {
    zone = 'docks',
})

---

OpCrimeStart

op-crime tablet entry point. Routes by mission settings:

• queue enabled -> queue join

• coop allowed -> client invite / lobby flow

• otherwise -> direct start (requirements consumed)

Returns: ok, 'started'|'queued'|'invite_pending' or false, reason

local ok, status = exports['op-missioncreator']:OpCrimeStart(src, missionId)

---

GetOpCrimeMissions

Returns missions marked as exposed to op-crime, shaped for op-crime Config.Missions.

local missions = exports['op-missioncreator']:GetOpCrimeMissions()

---

IsOpCrimeIntegrationActive

Returns a boolean - whether the op-crime integration is currently active.

local active = exports['op-missioncreator']:IsOpCrimeIntegrationActive()

Server Events

op-missioncreator:server:missionStarted

Fired after a mission successfully starts for a player.

AddEventHandler('op-missioncreator:server:missionStarted', function(src, missionId, runId, opts)
    -- opts may include: lobbyHost, lobbyMember, lobbyId, forced, startStepId, runId, …
end)

---

op-missioncreator:server:missionEnded

Fired when a mission ends for a player.

status is one of: 'completed' | 'failed' | 'aborted' | 'queue_left' | 'lobby_closed'

AddEventHandler('op-missioncreator:server:missionEnded', function(src, missionId, status, payload)
    -- Your Code
end)