https://stompymux.com/docs/scripting/packages/mux/world/type-state/Recent content in State on StompyMUX DocumentationHugoen-ushttps://stompymux.com/docs/scripting/packages/mux/world/type-state/delete/Mon, 01 Jan 0001 00:00:00 +0000https://stompymux.com/docs/scripting/packages/mux/world/type-state/delete/<p>Deletes a persistent state value.</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>state:delete( key ) </span></span></code></pre></div><h3 id="arguments">Arguments</h3> <dl> <dt><code>string key</code></dt> <dd>A valid state key.</dd> </dl> <h3 id="returns">Returns</h3> <dl> <dt><code>boolean existed</code></dt> <dd>Whether the key existed before deletion.</dd> </dl> <h2 id="notes">Notes</h2> <p>The deletion belongs to the current callback transaction.</p> <h2 id="see-also">See Also</h2> <ul> <li><a href="../../../"><code>mux</code></a></li> <li><a href="../"><code>State</code></a></li> <li><a href="../set/"><code>State:set</code></a></li> </ul>https://stompymux.com/docs/scripting/packages/mux/world/type-state/entries/Mon, 01 Jan 0001 00:00:00 +0000https://stompymux.com/docs/scripting/packages/mux/world/type-state/entries/<p>Lists the entries in this state namespace.</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>state:entries( ) </span></span></code></pre></div><h3 id="arguments">Arguments</h3> <p>None.</p> <h3 id="returns">Returns</h3> <dl> <dt><code>table entries</code></dt> <dd>An array of <code>{ key = ..., value = ... }</code> records sorted by key.</dd> </dl> <h2 id="notes">Notes</h2> <p>Enumeration requires an active callback transaction and includes earlier writes from that transaction.</p> <h2 id="see-also">See Also</h2> <ul> <li><a href="../../../"><code>mux</code></a></li> <li><a href="../"><code>State</code></a></li> <li><a href="../keys/"><code>State:keys</code></a></li> <li><a href="../get-many/"><code>State:get_many</code></a></li> </ul>https://stompymux.com/docs/scripting/packages/mux/world/type-state/get/Mon, 01 Jan 0001 00:00:00 +0000https://stompymux.com/docs/scripting/packages/mux/world/type-state/get/<p>Gets a persistent state value.</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>state:get( key [, default] ) </span></span></code></pre></div><h3 id="arguments">Arguments</h3> <dl> <dt><code>string key</code></dt> <dd>A valid state key.</dd> <dt><code>any default</code></dt> <dd>Optional value returned when the key is absent.</dd> </dl> <h3 id="returns">Returns</h3> <dl> <dt><code>string, boolean, number, or any value</code></dt> <dd>The stored value, the supplied default, or <code>nil</code>.</dd> </dl> <h2 id="notes">Notes</h2> <p>Reads observe writes made earlier in the current callback transaction.</p> <h2 id="see-also">See Also</h2> <ul> <li><a href="../../../"><code>mux</code></a></li> <li><a href="../"><code>State</code></a></li> <li><a href="../has/"><code>State:has</code></a></li> <li><a href="../get-many/"><code>State:get_many</code></a></li> </ul>https://stompymux.com/docs/scripting/packages/mux/world/type-state/get-many/Mon, 01 Jan 0001 00:00:00 +0000https://stompymux.com/docs/scripting/packages/mux/world/type-state/get-many/<p>Gets every present value from a requested set of keys.</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>state:get_many( keys ) </span></span></code></pre></div><h3 id="arguments">Arguments</h3> <dl> <dt><code>table keys</code></dt> <dd>An array of valid state-key strings.</dd> </dl> <h3 id="returns">Returns</h3> <dl> <dt><code>table values</code></dt> <dd>A key-to-value table containing only keys that are present.</dd> </dl> <h2 id="notes">Notes</h2> <p>Duplicate requested keys do not change the result. Reads observe earlier writes from the current callback transaction.</p> <h2 id="see-also">See Also</h2> <ul> <li><a href="../../../"><code>mux</code></a></li> <li><a href="../"><code>State</code></a></li> <li><a href="../get/"><code>State:get</code></a></li> <li><a href="../entries/"><code>State:entries</code></a></li> </ul>https://stompymux.com/docs/scripting/packages/mux/world/type-state/has/Mon, 01 Jan 0001 00:00:00 +0000https://stompymux.com/docs/scripting/packages/mux/world/type-state/has/<p>Tests whether a persistent state key exists.</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>state:has( key ) </span></span></code></pre></div><h3 id="arguments">Arguments</h3> <dl> <dt><code>string key</code></dt> <dd>A valid state key.</dd> </dl> <h3 id="returns">Returns</h3> <dl> <dt><code>boolean exists</code></dt> <dd>Whether the key has a value.</dd> </dl> <h2 id="notes">Notes</h2> <p>An empty string is a present value. Reads observe writes made earlier in the current callback transaction.</p> <h2 id="see-also">See Also</h2> <ul> <li><a href="../../../"><code>mux</code></a></li> <li><a href="../"><code>State</code></a></li> <li><a href="../get/"><code>State:get</code></a></li> </ul>https://stompymux.com/docs/scripting/packages/mux/world/type-state/keys/Mon, 01 Jan 0001 00:00:00 +0000https://stompymux.com/docs/scripting/packages/mux/world/type-state/keys/<p>Lists the keys in this state namespace.</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>state:keys( ) </span></span></code></pre></div><h3 id="arguments">Arguments</h3> <p>None.</p> <h3 id="returns">Returns</h3> <dl> <dt><code>table keys</code></dt> <dd>An array of strings sorted by key.</dd> </dl> <h2 id="notes">Notes</h2> <p>Enumeration requires an active callback transaction.</p> <h2 id="see-also">See Also</h2> <ul> <li><a href="../../../"><code>mux</code></a></li> <li><a href="../"><code>State</code></a></li> <li><a href="../entries/"><code>State:entries</code></a></li> </ul>https://stompymux.com/docs/scripting/packages/mux/world/type-state/set/Mon, 01 Jan 0001 00:00:00 +0000https://stompymux.com/docs/scripting/packages/mux/world/type-state/set/<p>Sets or deletes a persistent state value.</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>state:set( key, value ) </span></span></code></pre></div><h3 id="arguments">Arguments</h3> <dl> <dt><code>string key</code></dt> <dd>A valid state key.</dd> <dt><code>string, boolean, finite number, or nil value</code></dt> <dd>The new value. This argument is required; pass <code>nil</code> explicitly to delete the key.</dd> </dl> <h3 id="returns">Returns</h3> <p>Nothing.</p> <h2 id="notes">Notes</h2> <p>The update belongs to the current callback transaction. Invalid types, non-finite numbers, and configured storage-limit violations raise an error. Omitting <code>value</code> raises <code>mux.state.invalid</code>; only an explicit <code>nil</code> deletes the key.</p>https://stompymux.com/docs/scripting/packages/mux/world/type-state/set-many/Mon, 01 Jan 0001 00:00:00 +0000https://stompymux.com/docs/scripting/packages/mux/world/type-state/set-many/<p>Applies several persistent state updates.</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>state:set_many( values ) </span></span></code></pre></div><h3 id="arguments">Arguments</h3> <dl> <dt><code>table values</code></dt> <dd>A string-keyed table of supported state values.</dd> </dl> <h3 id="returns">Returns</h3> <p>Nothing.</p> <h2 id="notes">Notes</h2> <p>All updates join the current callback transaction. Every key must be a valid string and every value must be a string, boolean, or finite number. Lua tables cannot carry a <code>nil</code> entry, so use <code>State:set</code> or <code>State:delete</code> to remove keys.</p> <h2 id="see-also">See Also</h2> <ul> <li><a href="../../../"><code>mux</code></a></li> <li><a href="../"><code>State</code></a></li> <li><a href="../set/"><code>State:set</code></a></li> <li><a href="../delete/"><code>State:delete</code></a></li> </ul>