<emclass="property"><spanclass="k"><spanclass="pre">class</span></span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">effects.</span></span><spanclass="sig-name descname"><spanclass="pre">BloodColor</span></span><aclass="headerlink" href="#effects.BloodColor" title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">DONT_BLEED</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">_effects.BloodColor.DONT_BLEED</span></em><aclass="headerlink" href="#effects.BloodColor.DONT_BLEED" title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">GREEN</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">_effects.BloodColor.GREEN</span></em><aclass="headerlink" href="#effects.BloodColor.GREEN" title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">MECH</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">_effects.BloodColor.MECH</span></em><aclass="headerlink" href="#effects.BloodColor.MECH" title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">RED</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">_effects.BloodColor.RED</span></em><aclass="headerlink" href="#effects.BloodColor.RED" title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">YELLOW</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">_effects.BloodColor.YELLOW</span></em><aclass="headerlink" href="#effects.BloodColor.YELLOW" title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">names</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">{'DONT_BLEED':</span><spanclass="pre">_effects.BloodColor.DONT_BLEED,</span><spanclass="pre">'GREEN':</span><spanclass="pre">_effects.BloodColor.GREEN,</span><spanclass="pre">'MECH':</span><spanclass="pre">_effects.BloodColor.MECH,</span><spanclass="pre">'RED':</span><spanclass="pre">_effects.BloodColor.RED,</span><spanclass="pre">'YELLOW':</span><spanclass="pre">_effects.BloodColor.YELLOW}</span></em><aclass="headerlink" href="#effects.BloodColor.names" title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">values</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">{-1:</span><spanclass="pre">_effects.BloodColor.DONT_BLEED,</span><spanclass="pre">0:</span><spanclass="pre">_effects.BloodColor.RED,</span><spanclass="pre">1:</span><spanclass="pre">_effects.BloodColor.YELLOW,</span><spanclass="pre">2:</span><spanclass="pre">_effects.BloodColor.GREEN,</span><spanclass="pre">3:</span><spanclass="pre">_effects.BloodColor.MECH}</span></em><aclass="headerlink" href="#effects.BloodColor.values" title="Link to this definition">¶</a></dt>
<emclass="property"><spanclass="k"><spanclass="pre">class</span></span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">effects.</span></span><spanclass="sig-name descname"><spanclass="pre">ShatterSurface</span></span><aclass="headerlink" href="#effects.ShatterSurface" title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">GLASS</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">_effects.ShatterSurface.GLASS</span></em><aclass="headerlink" href="#effects.ShatterSurface.GLASS" title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">TILE</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">_effects.ShatterSurface.TILE</span></em><aclass="headerlink" href="#effects.ShatterSurface.TILE" title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">names</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">{'GLASS':</span><spanclass="pre">_effects.ShatterSurface.GLASS,</span><spanclass="pre">'TILE':</span><spanclass="pre">_effects.ShatterSurface.TILE}</span></em><aclass="headerlink" href="#effects.ShatterSurface.names" title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">values</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">{0:</span><spanclass="pre">_effects.ShatterSurface.GLASS,</span><spanclass="pre">1:</span><spanclass="pre">_effects.ShatterSurface.TILE}</span></em><aclass="headerlink" href="#effects.ShatterSurface.values" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="py function">
<dtclass="sig sig-object py" id="effects.ball">
<spanclass="sig-prename descclassname"><spanclass="pre">effects.</span></span><spanclass="sig-name descname"><spanclass="pre">ball</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">recipients</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">center</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">radius</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">steps</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">15</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">upper_half</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">True</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">lower_half</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">True</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../../_modules/effects.html#ball"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#effects.ball" title="Link to this definition">¶</a></dt>
<dd><p>Create a ball by using the remporary effect <codeclass="docutils literal notranslate"><spanclass="pre">BeamRingPoint</span></code>.</p>
<li><p><strong>recipients</strong> (<aclass="reference internal" href="filters.recipients.html#filters.recipients.RecipientFilter" title="filters.recipients.RecipientFilter"><em>RecipientFilter</em></a>) – Players that should see the beam.</p></li>
<li><p><strong>center</strong> (<aclass="reference internal" href="mathlib.html#mathlib.Vector" title="mathlib.Vector"><em>Vector</em></a>) – The center location of the ball.</p></li>
<li><p><strong>radius</strong> (<aclass="reference external" href="https://docs.python.org/3.13/library/functions.html#float" title="(in Python v3.13)"><em>float</em></a>) – The radius of the ball.</p></li>
<li><p><strong>steps</strong> (<aclass="reference external" href="https://docs.python.org/3.13/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a>) – Number of rings that should be used to create the ball.</p></li>
<li><p><strong>upper_half</strong> (<aclass="reference external" href="https://docs.python.org/3.13/library/functions.html#bool" title="(in Python v3.13)"><em>bool</em></a>) – If False, the upper half of the ball isn’t created.</p></li>
<li><p><strong>lower_half</strong> (<aclass="reference external" href="https://docs.python.org/3.13/library/functions.html#bool" title="(in Python v3.13)"><em>bool</em></a>) – If False, the lower half of the ball isn’t created.</p></li>
</ul>
</dd>
</dl>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>The number of steps is used for the lower and upper half. So, if you
define 15 steps, 29 rings are created (the center ring is shared by
both halves).</p>
</div>
</dd></dl>
<dlclass="py function">
<dtclass="sig sig-object py" id="effects.beam">
<spanclass="sig-prename descclassname"><spanclass="pre">effects.</span></span><spanclass="sig-name descname"><spanclass="pre">beam</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">recipients</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">start</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">end</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">parent</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">False</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../../_modules/effects.html#beam"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#effects.beam" title="Link to this definition">¶</a></dt>
<dd><p>A simple wrapper for the temporary effect <codeclass="docutils literal notranslate"><spanclass="pre">BeamEntPoint</span></code>.</p>
<li><p><strong>recipients</strong> (<aclass="reference internal" href="filters.recipients.html#filters.recipients.RecipientFilter" title="filters.recipients.RecipientFilter"><em>RecipientFilter</em></a>) – Players that should see the beam.</p></li>
<li><p><strong>start</strong> (<em>int/BaseEntity/Vector</em>) – The start location of the beam.</p></li>
<li><p><strong>end</strong> (<em>int/BaseEntity/Vector</em>) – The end location of the beam.</p></li>
<li><p><strong>parent</strong> (<aclass="reference external" href="https://docs.python.org/3.13/library/functions.html#bool" title="(in Python v3.13)"><em>bool</em></a>) – If True, the beam will be parented to the given entities.</p></li>
<li><p><strong>kwargs</strong> – Additional attributes that will be send to the effect.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dlclass="py function">
<dtclass="sig sig-object py" id="effects.box">
<spanclass="sig-prename descclassname"><spanclass="pre">effects.</span></span><spanclass="sig-name descname"><spanclass="pre">box</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">recipients</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">start</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">end</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../../_modules/effects.html#box"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#effects.box" title="Link to this definition">¶</a></dt>
<dd><p>Create a box using the temporary effect <codeclass="docutils literal notranslate"><spanclass="pre">BeamPoints</span></code>.</p>
<li><p><strong>recipients</strong> (<aclass="reference internal" href="filters.recipients.html#filters.recipients.RecipientFilter" title="filters.recipients.RecipientFilter"><em>RecipientFilter</em></a>) – Players that should see the beam.</p></li>
<li><p><strong>start</strong> (<aclass="reference internal" href="mathlib.html#mathlib.Vector" title="mathlib.Vector"><em>Vector</em></a>) – Upper left corner of the box.</p></li>
<li><p><strong>end</strong> (<aclass="reference internal" href="mathlib.html#mathlib.Vector" title="mathlib.Vector"><em>Vector</em></a>) – Lower right corner of the box.</p></li>
<li><p><strong>kwargs</strong> – Additional attributes that will be send to the effect.</p></li>
<li><p><strong>recipients</strong> (<aclass="reference internal" href="filters.recipients.html#filters.recipients.RecipientFilter" title="filters.recipients.RecipientFilter"><em>RecipientFilter</em></a>) – Players that should see the beam.</p></li>
<li><p><strong>points</strong> (<em>iterable</em>) – An iterable that contains at least 3 <aclass="reference internal" href="mathlib.html#mathlib.Vector" title="mathlib.Vector"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">mathlib.Vector</span></code></a> instances.</p></li>
<li><p><strong>parent</strong> (<aclass="reference external" href="https://docs.python.org/3.13/library/functions.html#bool" title="(in Python v3.13)"><em>bool</em></a>) – If True, the beam will be parented to the given entities.</p></li>
<li><p><strong>kwargs</strong> – Additional attributes that will be send to the effect.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dlclass="py function">
<dtclass="sig sig-object py" id="effects.square">
<spanclass="sig-prename descclassname"><spanclass="pre">effects.</span></span><spanclass="sig-name descname"><spanclass="pre">square</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">recipients</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">start</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">end</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../../_modules/effects.html#square"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#effects.square" title="Link to this definition">¶</a></dt>
<dd><p>Create a square using the temporary effect <codeclass="docutils literal notranslate"><spanclass="pre">BeamPoints</span></code>.</p>
<li><p><strong>recipients</strong> (<aclass="reference internal" href="filters.recipients.html#filters.recipients.RecipientFilter" title="filters.recipients.RecipientFilter"><em>RecipientFilter</em></a>) – Players that should see the beam.</p></li>
<li><p><strong>start</strong> (<aclass="reference internal" href="mathlib.html#mathlib.Vector" title="mathlib.Vector"><em>Vector</em></a>) – Upper left corner of the square.</p></li>
<li><p><strong>end</strong> (<aclass="reference internal" href="mathlib.html#mathlib.Vector" title="mathlib.Vector"><em>Vector</em></a>) – Lower right corner of the square.</p></li>
<li><p><strong>kwargs</strong> – Additional attributes that will be send to the effect.</p></li>