# Match Runtime Reference
This page lists all functions exposed in the match handler Dispatcher type.
## Match runtime [#](/content/docs/nakama/server-framework/lua-runtime/function-reference/match-runtime/#Match%20runtime/index.html)
### broadcast_message [#](/content/docs/nakama/server-framework/lua-runtime/function-reference/match-runtime/#broadcast_message/index.html)
Send a message to one or more presences. This may be called at any point in the match loop to give match participants information about match state changes. May also be useful inside the match join callback to send initial state to the user on successful join. Note that when broadcasting to multiple presences, if any presence is invalid then the broadcast will not occur.
| Parameters |
| --- |
| Name | Default | Description |
| --- | --- | --- |
| op_code | number | REQUIRED | Numeric message op code. |
| data | string | REQUIRED | Data to be sent to the provided presences, or nil. |
| presences | table | REQUIRED | List of presences (a subset of match participants) to use as message targets, or 'nil' to send to the whole match. |
| sender | nkruntime.Presence | REQUIRED | A presence to tag on the message as the sender, or 'nil'. |
| Returns |
| --- |
| Name | Description |
| --- | --- |
| error | error | An optional error that may indicate a problem broadcasting data to match participants. |
| | |
| --- | --- |
| ```
1
2
3
4
5
6
7
8
9
10
11
12
``` | ```lua
local nk = require("nakama")
function match_loop(context, dispatcher, tick, state, messages)
local opcode = 1234
local message = { ["hello"] = "world" }
local encoded = nk.json_encode(message)
local presences = nil -- send to all.
local sender = nil -- used if a message should come from a specific user.
dispatcher.broadcast_message(opcode, encoded, presences, sender)
return state
end
``` |
### match_kick [#](/content/docs/nakama/server-framework/lua-runtime/function-reference/match-runtime/#match_kick/index.html)
Removes participants from the match. Call at any point during the match loop to remove participants based on misbehavior or other game-specific rules.
| Parameters |
| --- |
| Name | Default | Description |
| --- | --- | --- |
| presences | table | REQUIRED | A list of match participant presences to remove from the match. |
| Returns |
| --- |
| Name | Description |
| --- | --- |
| error | error | An optional error that may indicate a problem kicking the selected match participants. |
| | |
| --- | --- |
| ```
1
2
3
4
5
6
7
``` | ```lua
local nk = require("nakama")
function match_loop(context, dispatcher, tick, state, messages)
-- Assume we store presences in state
dispatcher.match_kick(state.presences)
return state
end
``` |
### match_label_update [#](/content/docs/nakama/server-framework/lua-runtime/function-reference/match-runtime/#match_label_update/index.html)
Sets a new label for the match.
| Parameters |
| --- |
| Name | Default | Description |
| --- | --- | --- |
| label | string | REQUIRED | New label to set for the match. |
| Returns |
| --- |
| Name | Description |
| --- | --- |
| error | error | An optional error that may indicate a problem applying the new match label. |
| | |
| --- | --- |
| ```
1
2
3
4
5
6
``` | ```lua
local nk = require("nakama")
function match_loop(context, dispatcher, tick, state, messages)
dispatcher.match_label_update("updatedlabel")
return state
end
``` |