All resources

rsg-roulette — Developer Docs#

Dependencies#

rsg-core, oxmysql, rsg-target. No ox_lib — locales, notify, callbacks, model loading and commands all come from rsg-core.

Locales#

  • fxmanifest loads @rsg-core/shared/locale.lua; Lua uses locale('key', ...).
  • Language: setr rsg:locale "de" (falls back to ox:locale, then en).
  • The NUI receives a flat locale table from GetLocaleTable() (client/nui.lua): English merged with the selected language, so missing keys fall back to English.
  • Supported: en, de, el, es, fr, ja, nl, pl, pt-br, ro, ru.

Commands (admin)#

CommandDescription
/placerouletteStart placement mode (arrows rotate/height, Enter confirm, Backspace cancel)
/removerouletteRemove the nearest table within 3 m (refunds open bets)

Registered via RSGCore.Commands.Add(..., 'admin'). Placement is re-validated server-side (RSGCore.Functions.HasPermission(src, 'admin')).

Callbacks#

NameSideReturns
rsg-roulette:server:getTablesserver (RSGCore.Functions.CreateCallback)list of { id, coords, heading, room }

Events#

EventDirectionPurpose
rsg-roulette:server:join / :leaveC→Sopen/close a table view
rsg-roulette:server:placeTableC→Sadmin places a table (validated)
rsg-roulette:client:addTable / :removeTableS→Csync tables
rsg-roulette:client:startPlacementS→Cbegin placement mode
rsg-roulette:client:forceCloseS→Cclose UI (too far, table removed)

Notifications: client RSGCore.Functions.Notify, server RSGCore:Client:Notify.

Props#

Table props are local (non-networked) and spawned by a 1 s proximity thread within Config.SpawnDistance (replaces lib.points). Interaction is an exports['rsg-target']:addSphereZone.

Database#

rsg_roulette_tables (see installation/installation.sql).

<!-- BEGIN AUTO-REFERENCE (generated from the code; re-run the generator instead of editing by hand) -->

Technical reference#

Generated from the source of rsg-roulette 3.0.1. Names, arguments and defaults below are read straight from the code.

Dependencies#

rsg-core, oxmysql, rsg-target

Database#

Tables: rsg_roulette_tables.

Tables are created automatically on start while Config.AutoDatabase = true (default). Nothing is ever dropped or overwritten. For a manual install set Config.AutoDatabase = false and import installation/installation.sql once.

-- shared/config.lua
Config.AutoDatabase = true -- false = import the SQL file yourself

Configuration#

OptionDefaultNotes
Config.AutoDatabasetruebuild the database tables automatically on start (set false and import the SQL file for a manual install)
Config.MinBet1smallest single chip accepted
Config.MaxBet500max TOTAL stake per player per spin
Config.BettingTime30seconds
Config.SpinTime5seconds
Config.ResultDisplayTime8seconds
Config.InteractDistance3.0max distance from a table to bet (checked server side)
Config.SpawnDistance80.0table prop spawns / despawns locally within this range
Config.Bliptable
Config.Enabledtrue
Config.Sprite'blip_mg_poker'
Config.Scale0.2
Config.Placementtableremove the nearest one with /removeroulette
Config.MaxDistance10.0
Config.RotateStep1.5
Config.HeightStep0.01
Config.MaxHeight2.0
Config.MinSpacing2.5
Config.DiscordWebhooktable
Config.Url''
Config.MinWinAmount100
Config.LogJackpottrue
Config.LogAllSpinsfalse
Config.BotName'Roulette Table'
Config.AvatarUrl''

Exports#

Client

ExportArgumentsFile
openRoulette``client/roulette.lua
-- example
local result = exports['rsg-roulette']:openRoulette()

Callbacks#

CallbackSideArgumentsFile
rsg-roulette:server:getTablesserver_, cbserver/roulette.lua
-- client side
RSGCore.Functions.TriggerCallback('rsg-roulette:server:getTables', function(result)
    -- use result
end)

Events#

Server events can be fired by any client, so every handler re-validates the player, the arguments and any permission, distance or cooldown on the server. Never add a reward to a handler without those checks.

EventSideArgumentsFile
rsg-roulette:client:startPlacementclient``client/placement.lua
rsg-roulette:client:syncStateclientdataclient/roulette.lua
rsg-roulette:client:forceCloseclient``client/roulette.lua
rsg-roulette:client:addTableclient``client/tables.lua
rsg-roulette:client:removeTableclient``client/tables.lua
rsg-roulette:server:joinservertableIdserver/roulette.lua
rsg-roulette:server:leaveservertableIdserver/roulette.lua
rsg-roulette:server:placeBetservertableId, betserver/roulette.lua
rsg-roulette:server:removeBetservertableId, betserver/roulette.lua
rsg-roulette:server:clearBetsservertableIdserver/roulette.lua
rsg-roulette:server:placeTableservercoords, heading, roomserver/roulette.lua
-- from a client script
TriggerServerEvent('rsg-roulette:server:join', tableId)
-- from a server script
TriggerClientEvent('rsg-roulette:client:startPlacement', source)

Commands#

CommandNotesFile
/placeroulettelocale('cmd_place_help')server/roulette.lua
/removeroulettelocale('cmd_remove_help')server/roulette.lua

Locales#

Language files in locales/: de, el, en, es, fr, ja, nl, pl, pt-br, ro, ru. Set the language with setr rsg:locale "en".

<!-- END AUTO-REFERENCE -->