Deployed e53073f with MkDocs version: 1.5.3

objects/effects/Sound/index.html

@@ -1286,6 +1286,63 @@
     </label>
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 
+        <li class="md-nav__item">
+  <a href="#events" class="md-nav__link">
+    <span class="md-ellipsis">
+      Events
+    </span>
+  </a>
+
+    <nav class="md-nav" aria-label="Events">
+      <ul class="md-nav__list">
+
+          <li class="md-nav__item">
+  <a href="#Loaded" class="md-nav__link">
+    <span class="md-ellipsis">
+      Loaded
+    </span>
+  </a>
+
+</li>
+
+      </ul>
+    </nav>
+
+</li>
+
+        <li class="md-nav__item">
+  <a href="#methods" class="md-nav__link">
+    <span class="md-ellipsis">
+      Methods
+    </span>
+  </a>
+
+    <nav class="md-nav" aria-label="Methods">
+      <ul class="md-nav__list">
+
+          <li class="md-nav__item">
+  <a href="#Play" class="md-nav__link">
+    <span class="md-ellipsis">
+      Play
+    </span>
+  </a>
+
+</li>
+
+          <li class="md-nav__item">
+  <a href="#Stop" class="md-nav__link">
+    <span class="md-ellipsis">
+      Stop
+    </span>
+  </a>
+
+</li>
+
+      </ul>
+    </nav>
+
+</li>
+
         <li class="md-nav__item">
   <a href="#properties" class="md-nav__link">
     <span class="md-ellipsis">
@@ -3237,6 +3294,63 @@
     </label>
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 
+        <li class="md-nav__item">
+  <a href="#events" class="md-nav__link">
+    <span class="md-ellipsis">
+      Events
+    </span>
+  </a>
+
+    <nav class="md-nav" aria-label="Events">
+      <ul class="md-nav__list">
+
+          <li class="md-nav__item">
+  <a href="#Loaded" class="md-nav__link">
+    <span class="md-ellipsis">
+      Loaded
+    </span>
+  </a>
+
+</li>
+
+      </ul>
+    </nav>
+
+</li>
+
+        <li class="md-nav__item">
+  <a href="#methods" class="md-nav__link">
+    <span class="md-ellipsis">
+      Methods
+    </span>
+  </a>
+
+    <nav class="md-nav" aria-label="Methods">
+      <ul class="md-nav__list">
+
+          <li class="md-nav__item">
+  <a href="#Play" class="md-nav__link">
+    <span class="md-ellipsis">
+      Play
+    </span>
+  </a>
+
+</li>
+
+          <li class="md-nav__item">
+  <a href="#Stop" class="md-nav__link">
+    <span class="md-ellipsis">
+      Stop
+    </span>
+  </a>
+
+</li>
+
+      </ul>
+    </nav>
+
+</li>
+
         <li class="md-nav__item">
   <a href="#properties" class="md-nav__link">
     <span class="md-ellipsis">
@@ -3363,6 +3477,32 @@ <h1 id="sound">Sound<a class="headerlink" href="#sound" title="Permanent link">&
 <rect x="9" y="9" width="30" height="30" rx="2" stroke="#6AC2FF" stroke-width="4"/>
 </svg>
 </span> DynamicInstance</a></p>
+<h2 id="events">Events<a class="headerlink" href="#events" title="Permanent link">&para;</a></h2>
+<h3 id="Loaded"><span class="twemoji"><svg width="48" height="48" viewBox="0 0 48 48" fill="none" xmlns="http://www.w3.org/2000/svg">
+<path d="M25.2088 10.3157C25.357 9.17258 23.9302 8.53405 23.1765 9.40618L9.28518 25.4805C8.63435 26.2335 9.16934 27.403 10.1647 27.403H22.5751C23.2764 27.403 23.818 28.0193 23.7279 28.7149L22.587 37.5156C22.4389 38.6587 23.8657 39.2972 24.6194 38.4251L38.5107 22.3508C39.1615 21.5977 38.6265 20.4283 37.6312 20.4283H25.2208C24.5195 20.4283 23.9778 19.8119 24.068 19.1164L25.2088 10.3157Z" fill="#FFBC58"/>
+</svg>
+</span> Loaded<a class="headerlink" href="#Loaded" title="Permanent link">&para;</a></h3>
+<p>The event that is fired when the sound is loaded from the server.</p>
+<p><strong>Example</strong>
+<div class="highlight"><pre><span></span><code><span class="n">sound</span><span class="p">.</span><span class="n">Loaded</span><span class="p">:</span><span class="n">Connect</span><span class="p">(</span><span class="kr">function</span><span class="p">()</span>
+    <span class="n">sound</span><span class="p">.</span><span class="n">Play</span><span class="p">()</span>
+<span class="kr">end</span><span class="p">)</span>
+</code></pre></div></p>
+<h2 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent link">&para;</a></h2>
+<h3 id="Play"><span class="twemoji"><svg width="48" height="48" viewBox="0 0 48 48" fill="none" xmlns="http://www.w3.org/2000/svg">
+<path d="M18.6395 14.1286C19.0233 12.8643 20.189 12 21.5102 12H40.8123C42.8673 12 44.3139 14.0194 43.6528 15.9651L37.5372 33.9651C37.1239 35.1817 35.9816 36 34.6967 36H16.0459C14.0322 36 12.5903 34.0554 13.1753 32.1286L18.6395 14.1286Z" fill="#0097FF"/>
+<path d="M5 20H13" stroke="#0097FF" stroke-width="3" stroke-linecap="round"/>
+<path d="M7 25H11" stroke="#0097FF" stroke-width="3" stroke-linecap="round"/>
+</svg>
+</span> Play → <code>void</code><a class="headerlink" href="#Play" title="Permanent link">&para;</a></h3>
+<p>Plays the sound.</p>
+<h3 id="Stop"><span class="twemoji"><svg width="48" height="48" viewBox="0 0 48 48" fill="none" xmlns="http://www.w3.org/2000/svg">
+<path d="M18.6395 14.1286C19.0233 12.8643 20.189 12 21.5102 12H40.8123C42.8673 12 44.3139 14.0194 43.6528 15.9651L37.5372 33.9651C37.1239 35.1817 35.9816 36 34.6967 36H16.0459C14.0322 36 12.5903 34.0554 13.1753 32.1286L18.6395 14.1286Z" fill="#0097FF"/>
+<path d="M5 20H13" stroke="#0097FF" stroke-width="3" stroke-linecap="round"/>
+<path d="M7 25H11" stroke="#0097FF" stroke-width="3" stroke-linecap="round"/>
+</svg>
+</span> Stop → <code>void</code><a class="headerlink" href="#Stop" title="Permanent link">&para;</a></h3>
+<p>Stops playing the sound.</p>
 <h2 id="properties">Properties<a class="headerlink" href="#properties" title="Permanent link">&para;</a></h2>
 <h3 id="Autoplay"><span class="twemoji"><svg width="48" height="48" viewBox="0 0 48 48" fill="none" xmlns="http://www.w3.org/2000/svg">
 <path fill-rule="evenodd" clip-rule="evenodd" d="M13.8524 38C12.2369 38 10.9115 36.7207 10.8543 35.1063L10.5266 25.8588C12.7343 25.7805 14.5875 27.5068 14.6657 29.7146L14.8176 34H19.3738C21.583 34 23.3738 35.7909 23.3738 38H13.8524ZM10.4378 23.3537C12.6455 23.2755 14.3719 21.4223 14.2936 19.2146L14.1443 15H18.8198C21.0289 15 22.8198 13.2091 22.8198 11H13.1082C11.4097 11 10.0499 12.4088 10.1101 14.1062L10.4378 23.3537ZM26.2429 11C26.2429 13.2091 28.0338 15 30.2429 15H34.9537L34.9504 19.2492C34.9487 21.4584 36.7381 23.2506 38.9473 23.2523L38.9545 14.0023C38.9558 12.3446 37.6123 11 35.9545 11H26.2429ZM38.9453 25.7523C36.7362 25.7506 34.9439 27.5401 34.9422 29.7492L34.9389 34H30.4167C28.2075 34 26.4167 35.7909 26.4167 38H35.9381C37.594 38 38.9368 36.6583 38.9381 35.0023L38.9453 25.7523Z" fill="#8B8B8B"/>

objects/game/Environment/index.html

@@ -501,6 +501,48 @@
     </label>
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 
+        <li class="md-nav__item">
+  <a href="#methods" class="md-nav__link">
+    <span class="md-ellipsis">
+      Methods
+    </span>
+  </a>
+
+    <nav class="md-nav" aria-label="Methods">
+      <ul class="md-nav__list">
+
+          <li class="md-nav__item">
+  <a href="#CreateExplosion" class="md-nav__link">
+    <span class="md-ellipsis">
+      CreateExplosion
+    </span>
+  </a>
+
+</li>
+
+          <li class="md-nav__item">
+  <a href="#Raycast" class="md-nav__link">
+    <span class="md-ellipsis">
+      Raycast
+    </span>
+  </a>
+
+</li>
+
+          <li class="md-nav__item">
+  <a href="#RaycastAll" class="md-nav__link">
+    <span class="md-ellipsis">
+      RaycastAll
+    </span>
+  </a>
+
+</li>
+
+      </ul>
+    </nav>
+
+</li>
+
         <li class="md-nav__item">
   <a href="#properties" class="md-nav__link">
     <span class="md-ellipsis">
@@ -3200,6 +3242,48 @@
     </label>
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 
+        <li class="md-nav__item">
+  <a href="#methods" class="md-nav__link">
+    <span class="md-ellipsis">
+      Methods
+    </span>
+  </a>
+
+    <nav class="md-nav" aria-label="Methods">
+      <ul class="md-nav__list">
+
+          <li class="md-nav__item">
+  <a href="#CreateExplosion" class="md-nav__link">
+    <span class="md-ellipsis">
+      CreateExplosion
+    </span>
+  </a>
+
+</li>
+
+          <li class="md-nav__item">
+  <a href="#Raycast" class="md-nav__link">
+    <span class="md-ellipsis">
+      Raycast
+    </span>
+  </a>
+
+</li>
+
+          <li class="md-nav__item">
+  <a href="#RaycastAll" class="md-nav__link">
+    <span class="md-ellipsis">
+      RaycastAll
+    </span>
+  </a>
+
+</li>
+
+      </ul>
+    </nav>
+
+</li>
+
         <li class="md-nav__item">
   <a href="#properties" class="md-nav__link">
     <span class="md-ellipsis">
@@ -3307,6 +3391,55 @@ <h1 id="environment">Environment<a class="headerlink" href="#environment" title=
 <rect x="9" y="9" width="30" height="30" rx="2" stroke="#7F7F7F" stroke-width="4"/>
 </svg>
 </span> Instance</a></p>
+<h2 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent link">&para;</a></h2>
+<h3 id="CreateExplosion"><span class="twemoji"><svg width="48" height="48" viewBox="0 0 48 48" fill="none" xmlns="http://www.w3.org/2000/svg">
+<path d="M18.6395 14.1286C19.0233 12.8643 20.189 12 21.5102 12H40.8123C42.8673 12 44.3139 14.0194 43.6528 15.9651L37.5372 33.9651C37.1239 35.1817 35.9816 36 34.6967 36H16.0459C14.0322 36 12.5903 34.0554 13.1753 32.1286L18.6395 14.1286Z" fill="#0097FF"/>
+<path d="M5 20H13" stroke="#0097FF" stroke-width="3" stroke-linecap="round"/>
+<path d="M7 25H11" stroke="#0097FF" stroke-width="3" stroke-linecap="round"/>
+</svg>
+</span> CreateExplosion → <code>void</code><a class="headerlink" href="#CreateExplosion" title="Permanent link">&para;</a></h3>
+<p>Creates a deadly explosion killing players and applying force to parts at the given position.</p>
+<p><strong>Example</strong>
+<div class="highlight"><pre><span></span><code><span class="n">game</span><span class="p">[</span><span class="s2">&quot;Environment&quot;</span><span class="p">]:</span><span class="n">CreateExplosion</span><span class="p">(</span><span class="n">Vector3</span><span class="p">.</span><span class="n">New</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span> <span class="mi">30</span><span class="p">,</span> <span class="mi">5000</span><span class="p">,</span> <span class="kc">false</span><span class="p">)</span>
+</code></pre></div></p>
+<div>
+<div class="admonition note">
+<p class="admonition-title">When set to true, AffectAnchored will unanchor parts within the explosion radius.</p>
+</div>
+</div>
+<div>
+<div class="admonition note">
+<p class="admonition-title">Callback gets called for each part within explosion radius.</p>
+</div>
+</div>
+<h3 id="Raycast"><span class="twemoji"><svg width="48" height="48" viewBox="0 0 48 48" fill="none" xmlns="http://www.w3.org/2000/svg">
+<path d="M18.6395 14.1286C19.0233 12.8643 20.189 12 21.5102 12H40.8123C42.8673 12 44.3139 14.0194 43.6528 15.9651L37.5372 33.9651C37.1239 35.1817 35.9816 36 34.6967 36H16.0459C14.0322 36 12.5903 34.0554 13.1753 32.1286L18.6395 14.1286Z" fill="#0097FF"/>
+<path d="M5 20H13" stroke="#0097FF" stroke-width="3" stroke-linecap="round"/>
+<path d="M7 25H11" stroke="#0097FF" stroke-width="3" stroke-linecap="round"/>
+</svg>
+</span> Raycast → <code>RayResult</code><a class="headerlink" href="#Raycast" title="Permanent link">&para;</a></h3>
+<p>Casts a ray from origin with a specified direction and returns a RayResult for the first hit object.</p>
+<p><strong>Example</strong>
+<div class="highlight"><pre><span></span><code><span class="kd">local</span> <span class="n">hit</span> <span class="o">=</span> <span class="n">game</span><span class="p">[</span><span class="s2">&quot;Environment&quot;</span><span class="p">]:</span><span class="n">Raycast</span><span class="p">(</span><span class="n">barrel</span><span class="p">.</span><span class="n">Position</span><span class="p">,</span> <span class="n">barrel</span><span class="p">.</span><span class="n">Forward</span><span class="p">)</span>
+
+<span class="kr">if</span> <span class="n">hit</span> <span class="ow">and</span> <span class="n">hit</span><span class="p">.</span><span class="n">Instance</span><span class="p">:</span><span class="n">IsA</span><span class="p">(</span><span class="s2">&quot;Player&quot;</span><span class="p">)</span> <span class="kr">then</span>
+    <span class="n">hit</span><span class="p">.</span><span class="n">Instance</span><span class="p">.</span><span class="n">Health</span> <span class="o">=</span> <span class="mi">0</span>
+<span class="kr">end</span>
+</code></pre></div></p>
+<h3 id="RaycastAll"><span class="twemoji"><svg width="48" height="48" viewBox="0 0 48 48" fill="none" xmlns="http://www.w3.org/2000/svg">
+<path d="M18.6395 14.1286C19.0233 12.8643 20.189 12 21.5102 12H40.8123C42.8673 12 44.3139 14.0194 43.6528 15.9651L37.5372 33.9651C37.1239 35.1817 35.9816 36 34.6967 36H16.0459C14.0322 36 12.5903 34.0554 13.1753 32.1286L18.6395 14.1286Z" fill="#0097FF"/>
+<path d="M5 20H13" stroke="#0097FF" stroke-width="3" stroke-linecap="round"/>
+<path d="M7 25H11" stroke="#0097FF" stroke-width="3" stroke-linecap="round"/>
+</svg>
+</span> RaycastAll → <code>RayResult[]</code><a class="headerlink" href="#RaycastAll" title="Permanent link">&para;</a></h3>
+<p>Casts a ray from origin with a specified direction and returns a RayResult array for all hit objects.</p>
+<p><strong>Example</strong>
+<div class="highlight"><pre><span></span><code><span class="kd">local</span> <span class="n">hits</span> <span class="o">=</span> <span class="n">game</span><span class="p">[</span><span class="s2">&quot;Environment&quot;</span><span class="p">]:</span><span class="n">RaycastAll</span><span class="p">(</span><span class="n">Vector3</span><span class="p">.</span><span class="n">New</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">10</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span> <span class="n">Vector3</span><span class="p">.</span><span class="n">New</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="o">-</span><span class="mi">1</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span> <span class="mi">100</span><span class="p">)</span>
+
+<span class="kr">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">hit</span> <span class="kr">in</span> <span class="nb">pairs</span><span class="p">(</span><span class="n">hits</span><span class="p">)</span> <span class="kr">do</span>
+    <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;Hit at &quot;</span> <span class="o">..</span> <span class="n">hit</span><span class="p">.</span><span class="n">Position</span> <span class="o">..</span> <span class="s2">&quot;!&quot;</span><span class="p">)</span>
+<span class="kr">end</span>
+</code></pre></div></p>
 <h2 id="properties">Properties<a class="headerlink" href="#properties" title="Permanent link">&para;</a></h2>
 <h3 id="FogColor"><span class="twemoji"><svg width="48" height="48" viewBox="0 0 48 48" fill="none" xmlns="http://www.w3.org/2000/svg">
 <path fill-rule="evenodd" clip-rule="evenodd" d="M13.8524 38C12.2369 38 10.9115 36.7207 10.8543 35.1063L10.5266 25.8588C12.7343 25.7805 14.5875 27.5068 14.6657 29.7146L14.8176 34H19.3738C21.583 34 23.3738 35.7909 23.3738 38H13.8524ZM10.4378 23.3537C12.6455 23.2755 14.3719 21.4223 14.2936 19.2146L14.1443 15H18.8198C21.0289 15 22.8198 13.2091 22.8198 11H13.1082C11.4097 11 10.0499 12.4088 10.1101 14.1062L10.4378 23.3537ZM26.2429 11C26.2429 13.2091 28.0338 15 30.2429 15H34.9537L34.9504 19.2492C34.9487 21.4584 36.7381 23.2506 38.9473 23.2523L38.9545 14.0023C38.9558 12.3446 37.6123 11 35.9545 11H26.2429ZM38.9453 25.7523C36.7362 25.7506 34.9439 27.5401 34.9422 29.7492L34.9389 34H30.4167C28.2075 34 26.4167 35.7909 26.4167 38H35.9381C37.594 38 38.9368 36.6583 38.9381 35.0023L38.9453 25.7523Z" fill="#8B8B8B"/>