Events

-- 3 code blocks · 1 min read

get var-chess try it on the test server

All three are server-side, server-to-server events. Integrators react with AddEventHandler in a server script.

var_chess:server:matchStarted

Fires when a match starts (status becomes playing).

lua

-- payload: { id, white, black, bet = { white, black }, ai }
-- white / black: seat server id (number), or nil when that seat is the AI.  ai: boolean.
AddEventHandler('var_chess:server:matchStarted', function(data)
    print(('chess started at table %s, ai=%s'):format(data.id, tostring(data.ai)))
end)

var_chess:server:matchEnded

Fires when a match ends (checkmate, resign, draw or forced).

lua

-- payload: { id, winner = 'white' | 'black' | nil, reason, white, black, pot }
-- reason: 'checkmate' | 'resign' | 'stalemate' | 'fifty' | 'forced'.  pot: total staked.
AddEventHandler('var_chess:server:matchEnded', function(data)
    print(('chess ended at table %s, winner=%s pot=%s'):format(data.id, tostring(data.winner), data.pot))
end)

var_chess:server:move

Fires after each validated move is applied.

lua

-- payload: { id, color = 'white' | 'black', from, to, capture }
-- from / to: algebraic squares ('e2', 'e4').  capture: captured piece code ('bp') or nil.
AddEventHandler('var_chess:server:move', function(data)
    print(('table %s: %s %s-%s'):format(data.id, data.color, data.from, data.to))
end)

~/docs/chess/configuration/events

chess docs›

Chess