https://stompymux.com/docs/scripting/packages/btech/parts/Recent content in btech.parts on StompyMUX DocumentationHugoen-ushttps://stompymux.com/docs/scripting/packages/btech/parts/adjust-stores/Mon, 01 Jan 0001 00:00:00 +0000https://stompymux.com/docs/scripting/packages/btech/parts/adjust-stores/<p>Adjusts a stored part quantity.</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>btech.parts.adjust_stores( target, part, delta ) </span></span></code></pre></div><h3 id="arguments">Arguments</h3> <dl> <dt><code>DbRef|Object target</code></dt> <dd>The stores-bearing object.</dd> <dt><code>BtechPartRef part</code></dt> <dd>A part record, packed ID, or unique name.</dd> <dt><code>integer delta</code></dt> <dd>A nonzero signed quantity adjustment from -2,147,483,648 through 2,147,483,647.</dd> </dl> <h3 id="returns">Returns</h3> <p>None.</p> <h2 id="notes">Notes</h2> <p>The resulting stored quantity must be from 0 through 2,147,483,647. Exceeding that range raises <code>btech.operation.failed</code> with a <code>detail.reason</code> of <code>store_capacity_exceeded</code>.</p> <h2 id="see-also">See Also</h2> <ul> <li><a href="../../"><code>btech</code></a></li> <li><a href="../"><code>btech.parts</code></a></li> </ul>https://stompymux.com/docs/scripting/packages/btech/parts/categories/Mon, 01 Jan 0001 00:00:00 +0000https://stompymux.com/docs/scripting/packages/btech/parts/categories/<p>Lists the canonical part categories.</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>btech.parts.categories( ) </span></span></code></pre></div><h3 id="arguments">Arguments</h3> <p>None.</p> <h3 id="returns">Returns</h3> <dl> <dt><code>BtechPartCategory[] categories</code></dt> <dd>The category codes and display names.</dd> </dl> <h2 id="see-also">See Also</h2> <ul> <li><a href="../../"><code>btech</code></a></li> <li><a href="../"><code>btech.parts</code></a></li> </ul>https://stompymux.com/docs/scripting/packages/btech/parts/list/Mon, 01 Jan 0001 00:00:00 +0000https://stompymux.com/docs/scripting/packages/btech/parts/list/<p>Lists parts, optionally restricted to one category.</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>btech.parts.list( category ) </span></span></code></pre></div><h3 id="arguments">Arguments</h3> <dl> <dt><code>string|nil category</code></dt> <dd>An optional canonical category code.</dd> </dl> <h3 id="returns">Returns</h3> <dl> <dt><code>BtechPart[] parts</code></dt> <dd>The matching part records.</dd> </dl> <h2 id="see-also">See Also</h2> <ul> <li><a href="../../"><code>btech</code></a></li> <li><a href="../"><code>btech.parts</code></a></li> </ul>https://stompymux.com/docs/scripting/packages/btech/parts/resolve/Mon, 01 Jan 0001 00:00:00 +0000https://stompymux.com/docs/scripting/packages/btech/parts/resolve/<p>Resolves a part reference to its canonical record.</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>btech.parts.resolve( part ) </span></span></code></pre></div><h3 id="arguments">Arguments</h3> <dl> <dt><code>BtechPartRef part</code></dt> <dd>A part record, packed ID from 0 through 2,147,483,647, or unique name.</dd> </dl> <h3 id="returns">Returns</h3> <dl> <dt><code>BtechPart|nil part</code></dt> <dd>The canonical part, or <code>nil</code> when the reference is not found.</dd> </dl> <h2 id="see-also">See Also</h2> <ul> <li><a href="../../"><code>btech</code></a></li> <li><a href="../"><code>btech.parts</code></a></li> </ul>https://stompymux.com/docs/scripting/packages/btech/parts/search/Mon, 01 Jan 0001 00:00:00 +0000https://stompymux.com/docs/scripting/packages/btech/parts/search/<p>Searches the part catalogue by name.</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>btech.parts.search( query ) </span></span></code></pre></div><h3 id="arguments">Arguments</h3> <dl> <dt><code>string query</code></dt> <dd>A non-empty, case-insensitive wildcard pattern matched against each complete part name.</dd> </dl> <p>Use <code>*</code> to match any sequence of characters, <code>?</code> to match one character, and <code>\</code> to escape the following wildcard character. For example, <code>*laser*</code> finds part names containing &ldquo;laser&rdquo;.</p> <h3 id="returns">Returns</h3> <dl> <dt><code>BtechPart[] parts</code></dt> <dd>The matching part records.</dd> </dl> <h2 id="see-also">See Also</h2> <ul> <li><a href="../../"><code>btech</code></a></li> <li><a href="../"><code>btech.parts</code></a></li> </ul>https://stompymux.com/docs/scripting/packages/btech/parts/set-cost/Mon, 01 Jan 0001 00:00:00 +0000https://stompymux.com/docs/scripting/packages/btech/parts/set-cost/<p>Sets a part&rsquo;s configured cost.</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>btech.parts.set_cost( part, cost ) </span></span></code></pre></div><h3 id="arguments">Arguments</h3> <dl> <dt><code>BtechPartRef part</code></dt> <dd>A part record, packed ID, or unique name. Cost is stored by base part ID, so changing one branded part changes the reported cost for every brand of that equipment.</dd> <dt><code>integer cost</code></dt> <dd>The new cost, from 0 through Lua&rsquo;s safe-integer maximum of <code>2^53 - 1</code>.</dd> </dl> <h3 id="returns">Returns</h3> <p>None.</p> <h2 id="see-also">See Also</h2> <ul> <li><a href="../../"><code>btech</code></a></li> <li><a href="../"><code>btech.parts</code></a></li> </ul>https://stompymux.com/docs/scripting/packages/btech/parts/store-quantity/Mon, 01 Jan 0001 00:00:00 +0000https://stompymux.com/docs/scripting/packages/btech/parts/store-quantity/<p>Returns one stored part quantity.</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>btech.parts.store_quantity( target, part ) </span></span></code></pre></div><h3 id="arguments">Arguments</h3> <dl> <dt><code>DbRef|Object target</code></dt> <dd>The stores-bearing object.</dd> <dt><code>BtechPartRef part</code></dt> <dd>A part record, packed ID, or unique name.</dd> </dl> <h3 id="returns">Returns</h3> <dl> <dt><code>integer quantity</code></dt> <dd>The stored quantity.</dd> </dl> <h2 id="see-also">See Also</h2> <ul> <li><a href="../../"><code>btech</code></a></li> <li><a href="../"><code>btech.parts</code></a></li> </ul>https://stompymux.com/docs/scripting/packages/btech/parts/stores/Mon, 01 Jan 0001 00:00:00 +0000https://stompymux.com/docs/scripting/packages/btech/parts/stores/<p>Lists every stored part with a nonzero quantity.</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>btech.parts.stores( target ) </span></span></code></pre></div><h3 id="arguments">Arguments</h3> <dl> <dt><code>DbRef|Object target</code></dt> <dd>The stores-bearing object.</dd> </dl> <h3 id="returns">Returns</h3> <dl> <dt><code>BtechPartStack[] stores</code></dt> <dd>The stored part records and quantities.</dd> </dl> <h2 id="see-also">See Also</h2> <ul> <li><a href="../../"><code>btech</code></a></li> <li><a href="../"><code>btech.parts</code></a></li> </ul>