Ludo: exports, events & commands
Generated from the Lua in the release. Descriptions are the comments above each definition. Event names and export names are public contracts: they do not change between versions.
Events
- Client events are triggered on the player:
TriggerClientEvent(name, src, ...)from the server, orTriggerEvent(name, ...)on the client. - Server events are triggered with
TriggerServerEvent(name, ...). The server checks the player, distance and amounts itself; never rely on a client to do it.
Client
| Event | Arguments | Description |
|---|---|---|
lumo-ludo:client:challengeReceived | fromSrc, fromName, _, label | |
lumo-ludo:client:challengeTarget | data | ── Invite a nearby player ────────────────────────────────────────────────── |
lumo-ludo:client:close | reason | |
lumo-ludo:client:seatSync | seats | |
lumo-ludo:client:state | state | |
lumo-ludo:client:tableGames | map | |
lumo-ludo:client:tables | list |
Server
| Event | Arguments | Description |
|---|---|---|
lumo-ludo:server:challenge | targetSrc, game | |
lumo-ludo:server:challengeRespond | accepted, expectedChallenger | |
lumo-ludo:server:create | players, tableIndex, game | |
lumo-ludo:server:createSolo | bots, tableIndex, game | |
lumo-ludo:server:deleteTable | id | |
lumo-ludo:server:join | id | |
lumo-ludo:server:leave | ||
lumo-ludo:server:move | token | |
lumo-ludo:server:requestSeatSync | ||
lumo-ludo:server:requestTables | ── Client sync ────────────────────────────────────────────────────────────── | |
lumo-ludo:server:roll | throw | |
lumo-ludo:server:saveTable | raw, id | ── Admin edits ────────────────────────────────────────────────────────────── |
lumo-ludo:server:spectate | id | ── Spectate ──────────────────────────────────────────────────────────────── |
lumo-ludo:server:start |
Commands
| Command | Side | Description |
|---|---|---|
/ludofacegrid | client | Dev: draw grid coordinates on the face (checks the orientation in game). |
/ludoprop | client | /ludoprop: the board 1 m in front of you with a token of each colour on its start square and the die showing 1 in red's yard, and the Snakes & Ladders board beside it with red on square 1 and blue on 100. Again to remove. |
/ludoseatz | client | /ludoseatz 0.05 (or -0.05): nudge the seated height for this table's chair model live and show the value to paste into Config.Admin.chairModels (sitZ). |