https://stompymux.com/docs/scripting/packages/mux/comsys/type-channel-flags/Recent content in ChannelFlags on StompyMUX DocumentationHugoen-ushttps://stompymux.com/docs/scripting/packages/mux/comsys/type-channel-flags/add/Mon, 01 Jan 0001 00:00:00 +0000https://stompymux.com/docs/scripting/packages/mux/comsys/type-channel-flags/add/<p>Sets a typed channel flag.</p> <h2 id="function">Function</h2> <h3 id="synopsis">Synopsis</h3> <div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-lua" data-lang="lua"><span style="display:flex;"><span>channel_flags:add( flag ) </span></span></code></pre></div><h3 id="arguments">Arguments</h3> <dl> <dt><code>ChannelFlag flag</code></dt> <dd>A constant from <a href="../../flags/"><code>mux.comsys.flags</code></a>.</dd> </dl> <h3 id="returns">Returns</h3> <dl> <dt><code>boolean changed</code></dt> <dd><code>true</code> when the flag was newly set and <code>false</code> when it was already set.</dd> </dl> <h3 id="raises">Raises</h3> <ul> <li><code>mux.unavailable.checking</code> during <code>@lua/check</code>.</li> <li><code>mux.channel.invalid</code> if the originating channel was destroyed.</li> <li><code>mux.channel_flag.invalid</code> if <code>flag</code> is not a typed constant from this Lua runtime.</li> </ul> <h2 id="notes">Notes</h2> <p>Flag changes take effect immediately and are not part of the Lua State transaction.</p>https://stompymux.com/docs/scripting/packages/mux/comsys/type-channel-flags/has/Mon, 01 Jan 0001 00:00:00 +0000https://stompymux.com/docs/scripting/packages/mux/comsys/type-channel-flags/has/<p>Tests whether the channel has a typed flag.</p> <h2 id="function">Function</h2> <h3 id="synopsis">Synopsis</h3> <div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-lua" data-lang="lua"><span style="display:flex;"><span>channel_flags:has( flag ) </span></span></code></pre></div><h3 id="arguments">Arguments</h3> <dl> <dt><code>ChannelFlag flag</code></dt> <dd>A constant from <a href="../../flags/"><code>mux.comsys.flags</code></a>.</dd> </dl> <h3 id="returns">Returns</h3> <dl> <dt><code>boolean present</code></dt> <dd><code>true</code> when the flag is set, otherwise <code>false</code>.</dd> </dl> <h3 id="raises">Raises</h3> <ul> <li><code>mux.unavailable.checking</code> during <code>@lua/check</code>.</li> <li><code>mux.channel.invalid</code> if the originating channel was destroyed.</li> <li><code>mux.channel_flag.invalid</code> if <code>flag</code> is not a typed constant from this Lua runtime.</li> </ul> <h2 id="see-also">See Also</h2> <ul> <li><a href="../../../"><code>mux</code></a></li> <li><a href="../"><code>ChannelFlags</code></a></li> <li><a href="../add/"><code>ChannelFlags:add</code></a></li> </ul>https://stompymux.com/docs/scripting/packages/mux/comsys/type-channel-flags/list/Mon, 01 Jan 0001 00:00:00 +0000https://stompymux.com/docs/scripting/packages/mux/comsys/type-channel-flags/list/<p>Lists the flags currently set on the channel.</p> <h2 id="function">Function</h2> <h3 id="synopsis">Synopsis</h3> <div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-lua" data-lang="lua"><span style="display:flex;"><span>channel_flags:list( ) </span></span></code></pre></div><h3 id="arguments">Arguments</h3> <p>None.</p> <h3 id="returns">Returns</h3> <dl> <dt><code>ChannelFlag[] flags</code></dt> <dd>A dense array of set constants in <code>PUBLIC</code>, <code>LOUD</code>, <code>TRANSPARENT</code> order.</dd> </dl> <h3 id="raises">Raises</h3> <ul> <li><code>mux.unavailable.checking</code> during <code>@lua/check</code>.</li> <li><code>mux.channel.invalid</code> if the originating channel was destroyed.</li> </ul> <h2 id="see-also">See Also</h2> <ul> <li><a href="../../../"><code>mux</code></a></li> <li><a href="../"><code>ChannelFlags</code></a></li> <li><a href="../../flags/"><code>mux.comsys.flags</code></a></li> </ul>https://stompymux.com/docs/scripting/packages/mux/comsys/type-channel-flags/remove/Mon, 01 Jan 0001 00:00:00 +0000https://stompymux.com/docs/scripting/packages/mux/comsys/type-channel-flags/remove/<p>Clears a typed channel flag.</p> <h2 id="function">Function</h2> <h3 id="synopsis">Synopsis</h3> <div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-lua" data-lang="lua"><span style="display:flex;"><span>channel_flags:remove( flag ) </span></span></code></pre></div><h3 id="arguments">Arguments</h3> <dl> <dt><code>ChannelFlag flag</code></dt> <dd>A constant from <a href="../../flags/"><code>mux.comsys.flags</code></a>.</dd> </dl> <h3 id="returns">Returns</h3> <dl> <dt><code>boolean changed</code></dt> <dd><code>true</code> when the flag was cleared and <code>false</code> when it was already clear.</dd> </dl> <h3 id="raises">Raises</h3> <ul> <li><code>mux.unavailable.checking</code> during <code>@lua/check</code>.</li> <li><code>mux.channel.invalid</code> if the originating channel was destroyed.</li> <li><code>mux.channel_flag.invalid</code> if <code>flag</code> is not a typed constant from this Lua runtime.</li> </ul> <h2 id="notes">Notes</h2> <p>Flag changes take effect immediately and are not part of the Lua State transaction.</p>