wasvendel_robbery

Installation

Unzip wasvendel_robbery
Drag the wasvendel_robbery folder into your server's resources directory
Ensure dependencies are started before this resource
Add the resource to server.cfg after your framework core

editorconfig

ensure oxmysql
ensure your_core
ensure wasvendel_minigame
ensure wasvendel_dispatch
ensure wasvendel_robbery

Dependencies

Resource	Required	Description
`oxmysql`	Yes	Database connection
`wasvendel_minigame`	Yes	Lockpick, safe, timing minigames
`wasvendel_dispatch`	No	Enables dispatch step in the robbery creator

Database

The schema is created automatically on first start via server/schema.lua. No manual SQL import is required.

Configuration

Edit config.lua for creator permissions, step types, minigames, and custom event whitelist.

Key settings:

Setting	Default	Description
`Config.Command`	`robberycreator`	Creator command name
`Config.CreatorGroups`	`admin`, `superadmin`, `god`	Groups allowed to use the creator
`Config.CustomEvents.allowAny`	`true`	Allow any custom server event from creator steps
`Config.Dispatch.enabled`	`true`	Show dispatch step when `wasvendel_dispatch` is present

Commands

Command	Usage	Description
`robberycreator`	`robberycreator`	Opens the in-game robbery creator (configurable via `Config.Command`)

Permissions

Access is controlled by Config.CreatorGroups, Config.SteamPermission, or Config.VorpGroupSource in config.lua.

Setting	Description
`Config.CreatorGroups`	Framework groups allowed to open the creator
`Config.SteamPermission.enabled`	When `true`, uses Steam ID whitelist instead of groups
`Config.PlayGroups`	Groups allowed to start robberies (empty = everyone)

Events

This page lists events useful for integration from other resources.

Server Hooks (AddEventHandler)

Event	Payload	Description
`wasvendel_robbery:bridge:ready`	`fw`	Framework bridge is ready

Custom Server Events (Creator Steps)

When a robbery step of type server_event runs, the script calls:

lua

TriggerEvent(eventName, payload)

Default payload fields:

Field	Type	Description
`robberyId`	string/number	Robbery ID
`robberyName`	string	Robbery display name
`stepId`	string/number	Step ID
`playerSource`	number	Player who triggered the step

Whitelist is controlled by Config.CustomEvents and Config.ServerEventPresets in config.lua.

Client Events (Trigger from server)

Lifecycle

Event	Payload	Description
`wasvendel_robbery:stepCompleted`	table	A step was completed (see payload below)
`wasvendel_robbery:robberyCompleted`	`idStr`	Entire robbery finished
`wasvendel_robbery:robberyExpired`	`idStr`	Robbery timer expired
`wasvendel_robbery:locationReset`	`idStr`	Robbery location was reset

stepCompleted Payload

Field	Type	Description
`robberyId`	string	Robbery ID
`stepId`	string	Completed step ID
`doorOpen`	boolean	Door was opened
`npcDown`	boolean	NPC was threatened down
`explosion`	boolean	Explosion occurred
`dynamite`	boolean	Dynamite step
`spawnPedAttack`	boolean	Ped attack spawned

Custom Client Events (Creator Steps)

Event	Payload	Description
`wasvendel_robbery:customClientEvent`	`eventName, payload`	Relay — triggers `TriggerEvent(eventName, payload)` on the client

Creator client event steps add robberyId, robberyName, and stepId to the payload. Target modes: self, all, radius.

Notifications

Event	Payload	Description
`wasvendel_robbery:notify`	`msg, ms, ntype`	Standard notification
`wasvendel_robbery:styledNotify`	`msg, ms, styleDef`	Styled notification
`wasvendel_robbery:centerTip`	`msg, ms`	Center screen tip

Sync

Event	Payload	Description
`wasvendel_robbery:sync`	`robberies, runtimes, fixedDoors`	Full state sync
`wasvendel_robbery:syncRuntime`	`idStr, rt`	Single robbery runtime update
`wasvendel_robbery:syncFixedOpenDoors`	`doors`	Fixed door states

Client Hooks (AddEventHandler)

Event	Payload	Description
`wasvendel_robbery:editorRobberyId`	`editId`	Creator is editing a robbery (placement mode)

Server Events (Trigger from client)

These are used internally. External scripts should not trigger them unless you know the expected arguments.

Event	Description
`wasvendel_robbery:requestSync`	Request full sync
`wasvendel_robbery:attemptStep`	Attempt to start a step
`wasvendel_robbery:finishStep`	Report step completion
`wasvendel_robbery:requestPartyStart`	Start party robbery

Exports

All exports are safe to call from other resources.

Client Exports

Export	Signature	Description
`RefreshSync`	`()`	Requests a full robbery sync from the server

Client Example

lua

exports['wasvendel_robbery']:RefreshSync()

Server Exports

Export	Signature	Description
`IsSchemaReady`	`() -> boolean`	Returns whether the database schema has finished initializing

Server Example

lua

local ready = exports['wasvendel_robbery']:IsSchemaReady()
if ready then
    -- safe to interact with robbery data
end

Integration

wasvendel_dispatch

When wasvendel_dispatch is started, the robbery creator exposes a Dispatch step type. Completing that step triggers:

lua

TriggerEvent("wasvendel_dispatch:senddispatch", header, message, coords, job, alertSource)

Configure dispatch jobs and message in the robbery creator UI. Set Config.Dispatch.autoDetect = true to hide the step when dispatch is not installed.

wasvendel_minigame

Required dependency. Minigame types are mapped in config.lua:

Key	Export
`Timing`	`exports["wasvendel_minigame"]:Timing()`
`Circle`	`exports["wasvendel_minigame"]:Circle(a, b)`
`Strip`	`exports["wasvendel_minigame"]:Strip(a, b)`
`Sequence`	`exports["wasvendel_minigame"]:Sequence(a, b)`
`Arrows`	`exports["wasvendel_minigame"]:Arrows(a, b)`
`Safe`	`exports["wasvendel_minigame"]:Safe(a, b)`
`Random`	`exports["wasvendel_minigame"]:Random()`

Custom Events from Other Resources

Listen for robbery completion

lua

RegisterNetEvent("wasvendel_robbery:robberyCompleted", function(robberyId)
    print("Robbery completed:", robberyId)
end)

Trigger a custom server event from a robbery step

Add your event name to Config.ServerEventPresets or Config.CustomEvents.allowed
Create a server_event step in the robbery creator
Handle it in your resource:

lua

AddEventHandler("my_resource:robberyReward", function(payload)
    local src = payload.playerSource
    local robberyId = payload.robberyId
    -- give reward
end)

Trigger a custom client event from a robbery step

Create a client_event step. The robbery script relays it via wasvendel_robbery:customClientEvent, which calls TriggerEvent(eventName, payload) on the target client(s).

lua

AddEventHandler("my_resource:openVault", function(payload)
    print(payload.robberyId, payload.stepId)
end)

Framework

Supports VORP and RSG. Player load hooks:

Framework	Event
VORP	`vorp:SelectedCharacter`, `vorp:initCharacter`
RSG	`RSGCore:Client:OnPlayerLoaded`