1 line
4.9 KiB
HTML
1 line
4.9 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><base href="../"><link rel="stylesheet" href="dmdoc.css"><title>/datum/tgs_chat_channel - /tg/ Station 13</title></head><body><header><a href="index.html">/tg/ Station 13</a> - <a href="index.html#modules">Modules</a> - <a href="index.html#types">Types</a> — <a href="datum/tgs_chat_channel.html#var">Var Details</a></header><main><h1>tgs_chat_channel <aside>/<a href="datum.html">datum</a>/<a href="datum/tgs_chat_channel.html">tgs_chat_channel</a></aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/__DEFINES/tgs.dm#L245"><img src="git.png" width="16" height="16" title="code/__DEFINES/tgs.dm 245"></a></h1><p>Represents a connected chat channel.</p><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="datum/tgs_chat_channel.html#var/connection_name">connection_name</a></th><td>Name of the chat connection. This is the IRC server address or the Discord guild.</td></tr><tr><th><a href="datum/tgs_chat_channel.html#var/custom_tag">custom_tag</a></th><td>Tag string associated with the channel in TGS.</td></tr><tr><th><a href="datum/tgs_chat_channel.html#var/embeds_supported">embeds_supported</a></th><td>[TRUE]/[FALSE] if the channel supports embeds.</td></tr><tr><th><a href="datum/tgs_chat_channel.html#var/friendly_name">friendly_name</a></th><td>User friendly name of the channel.</td></tr><tr><th><a href="datum/tgs_chat_channel.html#var/id">id</a></th><td>TGS internal channel ID.</td></tr><tr><th><a href="datum/tgs_chat_channel.html#var/is_admin_channel">is_admin_channel</a></th><td>[TRUE]/[FALSE] based on if the server operator has marked this channel for game admins only.</td></tr><tr><th><a href="datum/tgs_chat_channel.html#var/is_private_channel">is_private_channel</a></th><td>[TRUE]/[FALSE] if the channel is a private message channel for a <a href="datum/tgs_chat_user.html" title="/datum/tgs_chat_user">/datum/tgs_chat_user</a>.</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/connection_name"><aside class="declaration">var </aside>connection_name <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/__DEFINES/tgs.dm#L251"><img src="git.png" width="16" height="16" title="code/__DEFINES/tgs.dm 251"></a></h3><p>Name of the chat connection. This is the IRC server address or the Discord guild.</p><h3 id="var/custom_tag"><aside class="declaration">var </aside>custom_tag <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/__DEFINES/tgs.dm#L257"><img src="git.png" width="16" height="16" title="code/__DEFINES/tgs.dm 257"></a></h3><p>Tag string associated with the channel in TGS.</p><h3 id="var/embeds_supported"><aside class="declaration">var </aside>embeds_supported <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/__DEFINES/tgs.dm#L262"><img src="git.png" width="16" height="16" title="code/__DEFINES/tgs.dm 262"></a></h3><p>[TRUE]/[FALSE] if the channel supports embeds.</p><h3 id="var/friendly_name"><aside class="declaration">var </aside>friendly_name <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/__DEFINES/tgs.dm#L249"><img src="git.png" width="16" height="16" title="code/__DEFINES/tgs.dm 249"></a></h3><p>User friendly name of the channel.</p><h3 id="var/id"><aside class="declaration">var </aside>id <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/__DEFINES/tgs.dm#L247"><img src="git.png" width="16" height="16" title="code/__DEFINES/tgs.dm 247"></a></h3><p>TGS internal channel ID.</p><h3 id="var/is_admin_channel"><aside class="declaration">var </aside>is_admin_channel <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/__DEFINES/tgs.dm#L253"><img src="git.png" width="16" height="16" title="code/__DEFINES/tgs.dm 253"></a></h3><p>[TRUE]/[FALSE] based on if the server operator has marked this channel for game admins only.</p><h3 id="var/is_private_channel"><aside class="declaration">var </aside>is_private_channel <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/__DEFINES/tgs.dm#L255"><img src="git.png" width="16" height="16" title="code/__DEFINES/tgs.dm 255"></a></h3><p>[TRUE]/[FALSE] if the channel is a private message channel for a <a href="datum/tgs_chat_user.html" title="/datum/tgs_chat_user">/datum/tgs_chat_user</a>.</p></main><footer>tgstation.dme <a href="https://github.com/evilew/GS13-Citadel/tree/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e">e8e0068</a> (master) — <a href="https://github.com/SpaceManiac/SpacemanDMM/blob/master/crates/dmdoc/README.md">dmdoc 1.9.0</a></footer></body></html> |