From 96ad35ed1d4d85be81e7daf1809fa1a51b67c735 Mon Sep 17 00:00:00 2001
From: Zughy <4279489-marco_a@users.noreply.gitlab.com>
Date: Mon, 30 May 2022 12:23:24 +0000
Subject: [PATCH] DOCS: document `winners` parameter for `on_celebration` and
 `on_end` callbacks

Fixes #151
---
 DOCS.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/DOCS.md b/DOCS.md
index 23c4f58..38f79ff 100644
--- a/DOCS.md
+++ b/DOCS.md
@@ -118,8 +118,8 @@ To customise your mod even more, there are a few empty callbacks you can use. Th
 * `arena_lib.on_disable(mod, function(arena, p_name)`: use it to run more checks before disabling an arena. Must return true if all conditions are met
 * `arena_lib.on_load(mod, function(arena)`: see [2.3 Arena phases](#23-arena-phases)
 * `arena_lib.on_start(mod, function(arena))`: same as above
-* `arena_lib.on_celebration(mod, function(arena, winners)`: same as above
-* `arena_lib.on_end(mod, function(arena, players, winners, spectators, is_forced))`: same as above. Players and spectators are given here because `end_arena` deleted them already - hence these are a copy. `is_forced` returns `true` when the match has been forcibly terminated (via `force_arena_ending`)
+* `arena_lib.on_celebration(mod, function(arena, winners)`: same as above. `winners` can be either a string, an integer or a table of string/integers. If you want to have a single winner, return their name (string). If you want to have a whole team, return the team ID (integer). If you want to have more single winners, a table of strings, and more teams, a table of integers.
+* `arena_lib.on_end(mod, function(arena, players, winners, spectators, is_forced))`: same as above. Players and spectators are given here because `end_arena` has already deleted them - hence these are a copy. `is_forced` returns `true` when the match has been forcibly terminated (via `force_arena_ending`)
 * `arena_lib.on_join(mod, function(p_name, arena, as_spectator))`: called when a player joins an ongoing match. If `as_spectator` is true, they'll be added as such
 * `arena_lib.on_death(mod, function(arena, p_name, reason))`: called when a player dies
 * `arena_lib.on_change_spectated_target(mod, function(arena, sp_name, t_type, t_name, prev_type, prev_spectated))`: called when a spectator (`sp_name`) changes who or what they're spectating, including when they get assigned someone to spectate at entering the arena.