Hooks

The resource code is encrypted, but your server often needs its own logic at a specific moment: starting items, a phone number, a jail spawn, or pausing the anticheat while loading.

Two open files are for that:

Implement a hook by filling the function already in the file:

function SC.Editable.GiveStartingItems(src, citizenid)    exports.ox_inventory:AddItem(src, 'phone', 1)end

Your code cannot break loadingLink copied

• Every hook has a safe default in the encrypted part, so a deleted function still exists.
• Every call is wrapped in pcall. An error is printed with the hook name, and the character still spawns.

[sc_multicharacter] error in editable hook "GiveStartingItems": ...

Hooks or exportsLink copied

Call orderLink copied

Player creates a character  OnCharacterCreated(src, character, isFirst)  OnStartingItemsPicked(src, citizenid, lines, total)Player selects a character  CanSelectCharacter(src, character)  ResolveSpawn(src, character, spawnKey)  OnCharacterLoaded(src, character)  ResolveBucket(src, character)  GiveStartingItems(src, citizenid)  OnStartingItemsGranted(src, citizenid, lines, total)Player gets control  OnPlayerSpawned(character)                clientRelog or disconnect  OnCharacterLogout(src, citizenid)Character deleted  OnCharacterDeleted(src, citizenid)Stage changes, all the time  OnStateChanged(state)                     client  OnSelectOpened()                          client

Server hooksLink copied

File: bridge/server/editable.lua.

OnCharacterCreated

function SC.Editable.OnCharacterCreated(src, character, isFirst)end

The new character row exists, but the character has nothing yet: no items, phone number, or licenses.

• character has citizenid, firstname, lastname, gender, dateofbirth, nationality, and height.
• isFirst is true only for the player's first character.

GiveStartingItems

function SC.Editable.GiveStartingItems(src, citizenid)end

Runs when the selected character's inventory exists, on every login, not only the first. To grant items once, track it yourself. See Examples.

OnStartingItemsPicked

function SC.Editable.OnStartingItemsPicked(src, citizenid, lines, total)end

The basket at payment time, before the appearance editor and arrival. The character has no session or inventory yet. Use it for logs, webhooks, or saving the choice in your own table.

OnStartingItemsGranted

function SC.Editable.OnStartingItemsGranted(src, citizenid, lines, total)end

The basket at grant time. Normal items are already in the inventory. Anything with a kind other than 'item', such as 'vehicle', was not granted and waits here for your code. Runs once per basket, a relog does not run it again.

lines is a list of:

{ key = 'car', item = 'blista', kind = 'vehicle', count = 1, price = 2000 }

total is the total cost from the budget.

OnCharacterDeleted

function SC.Editable.OnCharacterDeleted(src, citizenid)end

The character was deleted. The only moment to clean up records in your tables, such as phone, vehicles, or properties.

OnCharacterLoaded

function SC.Editable.OnCharacterLoaded(src, character)end

The character was selected and handed to the framework. The player is still watching the camera flight.

OnCharacterLogout

function SC.Editable.OnCharacterLogout(src, citizenid)end

The character was released by a relog or disconnect.

ResolveSpawn

function SC.Editable.ResolveSpawn(src, character, spawnKey)    return nilend

You decide where the character spawns. Runs before all resource rules, and what you return wins:

• vector4(x, y, z, heading)
• a table { x, y, z, heading }, or w instead of heading
• nil for the normal rules: player choice, last position, Config.Spawn.default

spawnKey is the key of the location the player picked, or nil.

Use it when jail or hospital must override the player's choice. Only your jail resource knows who is jailed.

ResolveBucket

function SC.Editable.ResolveBucket(src, character)    return nilend

The routing bucket the character joins after leaving the private world. nil means the main world (0). Use it for instanced apartments, a jail bucket, or a running event.

Runs only while the player is still in the bucket this resource put them in. If something else already moved them, they stay there.

CanSelectCharacter

function SC.Editable.CanSelectCharacter(src, character)    return trueend

Veto on character selection. Return false and a reason, and the player sees the reason as an error on the select screen. Use it for suspended characters, a whitelist, or a full gang.

Client hooksLink copied

File: bridge/client/editable.lua.

OnStateChanged

function SC.Editable.OnStateChanged(state)end

Runs only on a real change, so you do not need to filter it.

OnPlayerSpawned

function SC.Editable.OnPlayerSpawned(character)end

The camera is back on the player and they have control. Turn your HUD or phone back on here.

OnSelectOpened

function SC.Editable.OnSelectOpened()end

Character select just opened, on join and on every /relog. A good place to hide the HUD.