GetChatMessage: Difference between revisions
GetChatMessage now has an optional parameter that keeps colour codes in chat message in 3.2.
DrinkyBird (talk | contribs) (Move to Category: ACS functions (caps)) Tag: Source edit |
(GetChatMessage now has an optional parameter that keeps colour codes in chat message in 3.2.) Tag: Source edit |
||
| Line 2: | Line 2: | ||
str '''GetChatMessage''' (int ''player'', int ''offset'') | str '''GetChatMessage''' (int ''player'', int ''offset'') | ||
== Usage == | str '''GetChatMessage''' (int ''player'', int ''offset'' [, bool ''keepcolorcodes'']) {{Devfeature|3.2|alpha}} | ||
==Usage== | |||
Returns the last chat message from a player, or the server via RCON. Up to 5 chat messages are stored into memory for each player, in order from last message to oldest message sent. Every time a player sends a new message, all stored messages are shifted by one, and any messages older than the last 5 messages sent are overwritten and deleted. You may use this in conjunction with the <tt>GAMEVENT_CHAT</tt> event script type to get a player's messages as soon as they're received. | Returns the last chat message from a player, or the server via RCON. Up to 5 chat messages are stored into memory for each player, in order from last message to oldest message sent. Every time a player sends a new message, all stored messages are shifted by one, and any messages older than the last 5 messages sent are overwritten and deleted. You may use this in conjunction with the <tt>GAMEVENT_CHAT</tt> event script type to get a player's messages as soon as they're received. | ||
NOTE: Private chat messages (i.e. those sent using <tt>sayto</tt> or <tt>sayto_idx</tt>) are not accounted for and will not be stored into memory, nor are they retrievable. | NOTE: Private chat messages (i.e. those sent using <tt>sayto</tt> or <tt>sayto_idx</tt>) are not accounted for and will not be stored into memory, nor are they retrievable. | ||
=== Parameters === | ===Parameters=== | ||
* ''player'': The number of the player whose chat message you want to retrieve. If you want to retrieve any messages from the server, set this to -1 instead. | *''player'': The number of the player whose chat message you want to retrieve. If you want to retrieve any messages from the server, set this to -1 instead. | ||
* ''offset'': Which chat message you want to retrieve. If you want the last message sent, set to to 0. If you want the oldest message still stored in memory, set this to 4. | *''offset'': Which chat message you want to retrieve. If you want the last message sent, set to to 0. If you want the oldest message still stored in memory, set this to 4. | ||
* ''keepcolorcodes'': If true, then any colour codes in the message are preserved instead of removed completely. {{Devfeature|3.2|alpha}} | |||
=== Return value === | ===Return value === | ||
Returns the chat message as a string, | Returns the chat message as a string, with or without colour codes. If the player doesn't exist or if that player hadn't sent more messages than <tt>offset</tt>, it returns an empty string instead. | ||
== Examples == | ==Examples== | ||
{{noexamples}} | {{noexamples}} | ||
== See also == | ==See also== | ||
* [[EVENT scripts]] (<tt>GAMEEVENT_CHAT</tt>) | *[[EVENT scripts]] (<tt>GAMEEVENT_CHAT</tt>) | ||
[[category:ACS functions]] | [[category:ACS functions]] | ||