aboutsummaryrefslogtreecommitdiff
path: root/src/chatmsg.h
blob: b5f63bb38a9b671c6b0290edb93b4fb8e4182536 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
/*
 * Copyright © Michael Smith <mikesmiffy128@gmail.com>
 * Copyright © Hayden K <imaciidz@gmail.com>
 *
 * Permission to use, copy, modify, and/or distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED “AS IS” AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
 * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
 * AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
 * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
 * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
 * OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 * PERFORMANCE OF THIS SOFTWARE.
 */

#ifndef INC_CHATMSG_H
#define INC_CHATMSG_H

/*
 * Sends a message to the in-game chat for all players. Strings can have control
 * characters embedded to set colors. A control character must be at the start
 * of the string to use any subsequent ones. \x02 (STX) only works at the start
 * of the string, and precludes using the other control characters.
 *
 * The list of possible control characters is as follows:
 * - \x02 (STX) - Use team color up to the end of the player name
 * - \x03 (ETX) - Use team color from this point forward
 * - \x04 (EOT) - Use location color from this point forward
 * - \x05 (ENQ) - Use achievement color from this point forward
 * - \x01 (SOH) - Use normal color from this point forward
 */
void chatmsg_broadcast(const char *msg);

#endif

// vi: sw=4 ts=4 noet tw=80 cc=80