Skip to content

Commit

Permalink
Minor documentation update (tgstation#75884)
Browse files Browse the repository at this point in the history
I debated adding @Watermelon914's suggestion about a special value for
broadcasting on 4+, but then I realized that's not backwards compatible
at all.

Hmmm...
  • Loading branch information
Cyberboss authored Jun 9, 2023
1 parent 70602af commit 0f5d631
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions code/__HELPERS/chat.dm
Original file line number Diff line number Diff line change
@@ -1,13 +1,17 @@
/*
Here's how to use the chat system with configs
Here's how to use the TGS chat system with configs
send2adminchat is a simple function that broadcasts to admin channels
send2adminchat is a simple function that broadcasts to all admin channels that are designated in TGS
send2chat is a bit verbose but can be very specific
In TGS3 it will always be sent to all connected designated game chats.
In TGS4+ they use the new tagging system
The second parameter is a string, this string should be read from a config.
What this does is dictacte which TGS4 channels can be sent to.
What this does is dictate which TGS channels can be sent to.
For example if you have the following channels in tgs4 set up
- Channel 1, Tag: asdf
Expand All @@ -31,8 +35,6 @@ Alternatively if you set the config option to just:
WHERE_TO_SEND_SNIFF_BUTTS
it will be sent to all connected chats.
In TGS3 it will always be sent to all connected designated game chats.
*/

/**
Expand Down

0 comments on commit 0f5d631

Please sign in to comment.