mirror of
https://github.com/evennia/evennia.git
synced 2026-03-23 00:06:30 +01:00
1271 lines
No EOL
92 KiB
HTML
1271 lines
No EOL
92 KiB
HTML
|
||
<!DOCTYPE html>
|
||
|
||
<html>
|
||
<head>
|
||
<meta charset="utf-8" />
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||
|
||
<title>evennia.contrib.turnbattle.tb_range — Evennia 0.9.5 documentation</title>
|
||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||
<script src="../_static/jquery.js"></script>
|
||
<script src="../_static/underscore.js"></script>
|
||
<script src="../_static/doctools.js"></script>
|
||
<script src="../_static/language_data.js"></script>
|
||
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</script>
|
||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||
<link rel="index" title="Index" href="../genindex.html" />
|
||
<link rel="search" title="Search" href="../search.html" />
|
||
</head><body>
|
||
<div class="related" role="navigation" aria-label="related navigation">
|
||
<h3>Navigation</h3>
|
||
<ul>
|
||
<li class="right" style="margin-right: 10px">
|
||
<a href="../genindex.html" title="General Index"
|
||
accesskey="I">index</a></li>
|
||
<li class="right" >
|
||
<a href="../py-modindex.html" title="Python Module Index"
|
||
>modules</a> |</li>
|
||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 0.9.5</a> »</li>
|
||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.turnbattle.tb_range</a></li>
|
||
</ul>
|
||
</div>
|
||
|
||
<div class="document">
|
||
<div class="documentwrapper">
|
||
<div class="bodywrapper">
|
||
<div class="body" role="main">
|
||
|
||
<section id="module-evennia.contrib.turnbattle.tb_range">
|
||
<span id="evennia-contrib-turnbattle-tb-range"></span><h1>evennia.contrib.turnbattle.tb_range<a class="headerlink" href="#module-evennia.contrib.turnbattle.tb_range" title="Permalink to this headline">¶</a></h1>
|
||
<p>Simple turn-based combat system with range and movement</p>
|
||
<p>Contrib - Tim Ashley Jenkins 2017</p>
|
||
<p>This is a version of the ‘turnbattle’ contrib that includes a system
|
||
for abstract movement and positioning in combat, including distinction
|
||
between melee and ranged attacks. In this system, a fighter or object’s
|
||
exact position is not recorded - only their relative distance to other
|
||
actors in combat.</p>
|
||
<p>In this example, the distance between two objects in combat is expressed
|
||
as an integer value: 0 for “engaged” objects that are right next to each
|
||
other, 1 for “reach” which is for objects that are near each other but
|
||
not directly adjacent, and 2 for “range” for objects that are far apart.</p>
|
||
<p>When combat starts, all fighters are at reach with each other and other
|
||
objects, and at range from any exits. On a fighter’s turn, they can use
|
||
the “approach” command to move closer to an object, or the “withdraw”
|
||
command to move further away from an object, either of which takes an
|
||
action in combat. In this example, fighters are given two actions per
|
||
turn, allowing them to move and attack in the same round, or to attack
|
||
twice or move twice.</p>
|
||
<p>When you move toward an object, you will also move toward anything else
|
||
that’s close to your target - the same goes for moving away from a target,
|
||
which will also move you away from anything close to your target. Moving
|
||
toward one target may also move you away from anything you’re already
|
||
close to, but withdrawing from a target will never inadvertently bring
|
||
you closer to anything else.</p>
|
||
<p>In this example, there are two attack commands. ‘Attack’ can only hit
|
||
targets that are ‘engaged’ (range 0) with you. ‘Shoot’ can hit any target
|
||
on the field, but cannot be used if you are engaged with any other fighters.
|
||
In addition, strikes made with the ‘attack’ command are more accurate than
|
||
‘shoot’ attacks. This is only to provide an example of how melee and ranged
|
||
attacks can be made to work differently - you can, of course, modify this
|
||
to fit your rules system.</p>
|
||
<p>When in combat, the ranges of objects are also accounted for - you can’t
|
||
pick up an object unless you’re engaged with it, and can’t give an object
|
||
to another fighter without being engaged with them either. Dropped objects
|
||
are automatically assigned a range of ‘engaged’ with the fighter who dropped
|
||
them. Additionally, giving or getting an object will take an action in combat.
|
||
Dropping an object does not take an action, but can only be done on your turn.</p>
|
||
<p>When combat ends, all range values are erased and all restrictions on getting
|
||
or getting objects are lifted - distances are no longer tracked and objects in
|
||
the same room can be considered to be in the same space, as is the default
|
||
behavior of Evennia and most MUDs.</p>
|
||
<p>This system allows for strategies in combat involving movement and
|
||
positioning to be implemented in your battle system without the use of
|
||
a ‘grid’ of coordinates, which can be difficult and clunky to navigate
|
||
in text and disadvantageous to players who use screen readers. This loose,
|
||
narrative method of tracking position is based around how the matter is
|
||
handled in tabletop RPGs played without a grid - typically, a character’s
|
||
exact position in a room isn’t important, only their relative distance to
|
||
other actors.</p>
|
||
<p>You may wish to expand this system with a method of distinguishing allies
|
||
from enemies (to prevent allied characters from blocking your ranged attacks)
|
||
as well as some method by which melee-focused characters can prevent enemies
|
||
from withdrawing or punish them from doing so, such as by granting “attacks of
|
||
opportunity” or something similar. If you wish, you can also expand the breadth
|
||
of values allowed for range - rather than just 0, 1, and 2, you can allow ranges
|
||
to go up to much higher values, and give attacks and movements more varying
|
||
values for distance for a more granular system. You may also want to implement
|
||
a system for fleeing or changing rooms in combat by approaching exits, which
|
||
are objects placed in the range field like any other.</p>
|
||
<p>To install and test, import this module’s TBRangeCharacter object into
|
||
your game’s character.py module:</p>
|
||
<blockquote>
|
||
<div><p>from evennia.contrib.turnbattle.tb_range import TBRangeCharacter</p>
|
||
</div></blockquote>
|
||
<p>And change your game’s character typeclass to inherit from TBRangeCharacter
|
||
instead of the default:</p>
|
||
<blockquote>
|
||
<div><p>class Character(TBRangeCharacter):</p>
|
||
</div></blockquote>
|
||
<p>Do the same thing in your game’s objects.py module for TBRangeObject:</p>
|
||
<blockquote>
|
||
<div><p>from evennia.contrib.turnbattle.tb_range import TBRangeObject
|
||
class Object(TBRangeObject):</p>
|
||
</div></blockquote>
|
||
<p>Next, import this module into your default_cmdsets.py module:</p>
|
||
<blockquote>
|
||
<div><p>from evennia.contrib.turnbattle import tb_range</p>
|
||
</div></blockquote>
|
||
<p>And add the battle command set to your default command set:</p>
|
||
<blockquote>
|
||
<div><p>#
|
||
# any commands you add below will overload the default ones.
|
||
#
|
||
self.add(tb_range.BattleCmdSet())</p>
|
||
</div></blockquote>
|
||
<p>This module is meant to be heavily expanded on, so you may want to copy it
|
||
to your game’s ‘world’ folder and modify it there rather than importing it
|
||
in your game and using it as-is.</p>
|
||
<dl class="py data">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.ACTIONS_PER_TURN">
|
||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_range.</code><code class="sig-name descname">ACTIONS_PER_TURN</code><em class="property"> = 2</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.ACTIONS_PER_TURN" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.roll_init">
|
||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_range.</code><code class="sig-name descname">roll_init</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_range.html#roll_init"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.roll_init" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Rolls a number between 1-1000 to determine initiative.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>character</strong> (<em>obj</em>) – The character to determine initiative for</p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p><em>initiative (int)</em> – The character’s place in initiative - higher
|
||
numbers go first.</p>
|
||
</dd>
|
||
</dl>
|
||
<p class="rubric">Notes</p>
|
||
<p>By default, does not reference the character and simply returns
|
||
a random integer from 1 to 1000.</p>
|
||
<p>Since the character is passed to this function, you can easily reference
|
||
a character’s stats to determine an initiative roll - for example, if your
|
||
character has a ‘dexterity’ attribute, you can use it to give that character
|
||
an advantage in turn order, like so:</p>
|
||
<p>return (randint(1,20)) + character.db.dexterity</p>
|
||
<p>This way, characters with a higher dexterity will go first more often.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.get_attack">
|
||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_range.</code><code class="sig-name descname">get_attack</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">attacker</span></em>, <em class="sig-param"><span class="n">defender</span></em>, <em class="sig-param"><span class="n">attack_type</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_range.html#get_attack"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.get_attack" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns a value for an attack roll.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>attacker</strong> (<em>obj</em>) – Character doing the attacking</p></li>
|
||
<li><p><strong>defender</strong> (<em>obj</em>) – Character being attacked</p></li>
|
||
<li><p><strong>attack_type</strong> (<em>str</em>) – Type of attack (‘melee’ or ‘ranged’)</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p><p><em>attack_value (int)</em> –</p>
|
||
<dl class="simple">
|
||
<dt>Attack roll value, compared against a defense value</dt><dd><p>to determine whether an attack hits or misses.</p>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd>
|
||
</dl>
|
||
<p class="rubric">Notes</p>
|
||
<p>By default, generates a random integer from 1 to 100 without using any
|
||
properties from either the attacker or defender, and modifies the result
|
||
based on whether it’s for a melee or ranged attack.</p>
|
||
<p>This can easily be expanded to return a value based on characters stats,
|
||
equipment, and abilities. This is why the attacker and defender are passed
|
||
to this function, even though nothing from either one are used in this example.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.get_defense">
|
||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_range.</code><code class="sig-name descname">get_defense</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">attacker</span></em>, <em class="sig-param"><span class="n">defender</span></em>, <em class="sig-param"><span class="n">attack_type</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_range.html#get_defense"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.get_defense" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns a value for defense, which an attack roll must equal or exceed in order
|
||
for an attack to hit.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>attacker</strong> (<em>obj</em>) – Character doing the attacking</p></li>
|
||
<li><p><strong>defender</strong> (<em>obj</em>) – Character being attacked</p></li>
|
||
<li><p><strong>attack_type</strong> (<em>str</em>) – Type of attack (‘melee’ or ‘ranged’)</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p><p><em>defense_value (int)</em> –</p>
|
||
<dl class="simple">
|
||
<dt>Defense value, compared against an attack roll</dt><dd><p>to determine whether an attack hits or misses.</p>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd>
|
||
</dl>
|
||
<p class="rubric">Notes</p>
|
||
<p>By default, returns 50, not taking any properties of the defender or
|
||
attacker into account.</p>
|
||
<p>As above, this can be expanded upon based on character stats and equipment.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.get_damage">
|
||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_range.</code><code class="sig-name descname">get_damage</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">attacker</span></em>, <em class="sig-param"><span class="n">defender</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_range.html#get_damage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.get_damage" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns a value for damage to be deducted from the defender’s HP after abilities
|
||
successful hit.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>attacker</strong> (<em>obj</em>) – Character doing the attacking</p></li>
|
||
<li><p><strong>defender</strong> (<em>obj</em>) – Character being damaged</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p><p><em>damage_value (int)</em> –</p>
|
||
<dl class="simple">
|
||
<dt>Damage value, which is to be deducted from the defending</dt><dd><p>character’s HP.</p>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd>
|
||
</dl>
|
||
<p class="rubric">Notes</p>
|
||
<p>By default, returns a random integer from 15 to 25 without using any
|
||
properties from either the attacker or defender.</p>
|
||
<p>Again, this can be expanded upon.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.apply_damage">
|
||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_range.</code><code class="sig-name descname">apply_damage</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">defender</span></em>, <em class="sig-param"><span class="n">damage</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_range.html#apply_damage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.apply_damage" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Applies damage to a target, reducing their HP by the damage amount to a
|
||
minimum of 0.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>defender</strong> (<em>obj</em>) – Character taking damage</p></li>
|
||
<li><p><strong>damage</strong> (<em>int</em>) – Amount of damage being taken</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.at_defeat">
|
||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_range.</code><code class="sig-name descname">at_defeat</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">defeated</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_range.html#at_defeat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.at_defeat" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Announces the defeat of a fighter in combat.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>defeated</strong> (<em>obj</em>) – Fighter that’s been defeated.</p>
|
||
</dd>
|
||
</dl>
|
||
<p class="rubric">Notes</p>
|
||
<p>All this does is announce a defeat message by default, but if you
|
||
want anything else to happen to defeated fighters (like putting them
|
||
into a dying state or something similar) then this is the place to
|
||
do it.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.resolve_attack">
|
||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_range.</code><code class="sig-name descname">resolve_attack</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">attacker</span></em>, <em class="sig-param"><span class="n">defender</span></em>, <em class="sig-param"><span class="n">attack_type</span></em>, <em class="sig-param"><span class="n">attack_value</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">defense_value</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_range.html#resolve_attack"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.resolve_attack" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Resolves an attack and outputs the result.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>attacker</strong> (<em>obj</em>) – Character doing the attacking</p></li>
|
||
<li><p><strong>defender</strong> (<em>obj</em>) – Character being attacked</p></li>
|
||
<li><p><strong>attack_type</strong> (<em>str</em>) – Type of attack (melee or ranged)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<p class="rubric">Notes</p>
|
||
<p>Even though the attack and defense values are calculated
|
||
extremely simply, they are separated out into their own functions
|
||
so that they are easier to expand upon.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.get_range">
|
||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_range.</code><code class="sig-name descname">get_range</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj1</span></em>, <em class="sig-param"><span class="n">obj2</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_range.html#get_range"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.get_range" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Gets the combat range between two objects.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>obj1</strong> (<em>obj</em>) – First object</p></li>
|
||
<li><p><strong>obj2</strong> (<em>obj</em>) – Second object</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p><em>range (int or None)</em> – Distance between two objects or None if not applicable</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.distance_inc">
|
||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_range.</code><code class="sig-name descname">distance_inc</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">mover</span></em>, <em class="sig-param"><span class="n">target</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_range.html#distance_inc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.distance_inc" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Function that increases distance in range field between mover and target.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>mover</strong> (<em>obj</em>) – The object moving</p></li>
|
||
<li><p><strong>target</strong> (<em>obj</em>) – The object to be moved away from</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.approach">
|
||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_range.</code><code class="sig-name descname">approach</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">mover</span></em>, <em class="sig-param"><span class="n">target</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_range.html#approach"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.approach" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Manages a character’s whole approach, including changes in ranges to other characters.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>mover</strong> (<em>obj</em>) – The object moving</p></li>
|
||
<li><p><strong>target</strong> (<em>obj</em>) – The object to be moved toward</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<p class="rubric">Notes</p>
|
||
<p>The mover will also automatically move toward any objects that are closer to the
|
||
target than the mover is. The mover will also move away from anything they started
|
||
out close to.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.withdraw">
|
||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_range.</code><code class="sig-name descname">withdraw</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">mover</span></em>, <em class="sig-param"><span class="n">target</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_range.html#withdraw"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.withdraw" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Manages a character’s whole withdrawal, including changes in ranges to other characters.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>mover</strong> (<em>obj</em>) – The object moving</p></li>
|
||
<li><p><strong>target</strong> (<em>obj</em>) – The object to be moved away from</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<p class="rubric">Notes</p>
|
||
<p>The mover will also automatically move away from objects that are close to the target
|
||
of their withdrawl. The mover will never inadvertently move toward anything else while
|
||
withdrawing - they can be considered to be moving to open space.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.combat_cleanup">
|
||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_range.</code><code class="sig-name descname">combat_cleanup</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_range.html#combat_cleanup"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.combat_cleanup" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Cleans up all the temporary combat-related attributes on a character.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>character</strong> (<em>obj</em>) – Character to have their combat attributes removed</p>
|
||
</dd>
|
||
</dl>
|
||
<p class="rubric">Notes</p>
|
||
<p>Any attribute whose key begins with ‘<a href="#id1"><span class="problematic" id="id2">combat_</span></a>’ is temporary and no
|
||
longer needed once a fight ends.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.is_in_combat">
|
||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_range.</code><code class="sig-name descname">is_in_combat</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_range.html#is_in_combat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.is_in_combat" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns true if the given character is in combat.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>character</strong> (<em>obj</em>) – Character to determine if is in combat or not</p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p><em>(bool)</em> – True if in combat or False if not in combat</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.is_turn">
|
||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_range.</code><code class="sig-name descname">is_turn</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_range.html#is_turn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.is_turn" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns true if it’s currently the given character’s turn in combat.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>character</strong> (<em>obj</em>) – Character to determine if it is their turn or not</p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p><em>(bool)</em> – True if it is their turn or False otherwise</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.spend_action">
|
||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_range.</code><code class="sig-name descname">spend_action</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em>, <em class="sig-param"><span class="n">actions</span></em>, <em class="sig-param"><span class="n">action_name</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_range.html#spend_action"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.spend_action" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Spends a character’s available combat actions and checks for end of turn.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>character</strong> (<em>obj</em>) – Character spending the action</p></li>
|
||
<li><p><strong>actions</strong> (<em>int</em>) – Number of actions to spend, or ‘all’ to spend all actions</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Keyword Arguments</dt>
|
||
<dd class="field-even"><ul class="simple">
|
||
<li><p><strong>action_name</strong> (<em>str</em><em> or </em><em>None</em>) – If a string is given, sets character’s last action in</p></li>
|
||
<li><p><strong>to provided string</strong> (<em>combat</em>) – </p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.combat_status_message">
|
||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_range.</code><code class="sig-name descname">combat_status_message</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">fighter</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_range.html#combat_status_message"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.combat_status_message" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Sends a message to a player with their current HP and
|
||
distances to other fighters and objects. Called at turn
|
||
start and by the ‘status’ command.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.TBRangeTurnHandler">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_range.</code><code class="sig-name descname">TBRangeTurnHandler</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_range.html#TBRangeTurnHandler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.TBRangeTurnHandler" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.scripts.scripts.html#evennia.scripts.scripts.DefaultScript" title="evennia.scripts.scripts.DefaultScript"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.scripts.scripts.DefaultScript</span></code></a></p>
|
||
<p>This is the script that handles the progression of combat through turns.
|
||
On creation (when a fight is started) it adds all combat-ready characters
|
||
to its roster and then sorts them into a turn order. There can only be one
|
||
fight going on in a single room at a time, so the script is assigned to a
|
||
room as its object.</p>
|
||
<p>Fights persist until only one participant is left with any HP or all
|
||
remaining participants choose to end the combat with the ‘disengage’
|
||
command.</p>
|
||
<dl class="py method">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.TBRangeTurnHandler.at_script_creation">
|
||
<code class="sig-name descname">at_script_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_range.html#TBRangeTurnHandler.at_script_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.TBRangeTurnHandler.at_script_creation" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Called once, when the script is created.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.TBRangeTurnHandler.at_stop">
|
||
<code class="sig-name descname">at_stop</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_range.html#TBRangeTurnHandler.at_stop"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.TBRangeTurnHandler.at_stop" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Called at script termination.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.TBRangeTurnHandler.at_repeat">
|
||
<code class="sig-name descname">at_repeat</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_range.html#TBRangeTurnHandler.at_repeat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.TBRangeTurnHandler.at_repeat" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Called once every self.interval seconds.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.TBRangeTurnHandler.init_range">
|
||
<code class="sig-name descname">init_range</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">to_init</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_range.html#TBRangeTurnHandler.init_range"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.TBRangeTurnHandler.init_range" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Initializes range values for an object at the start of a fight.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>to_init</strong> (<em>object</em>) – Object to initialize range field for.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.TBRangeTurnHandler.join_rangefield">
|
||
<code class="sig-name descname">join_rangefield</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">to_init</span></em>, <em class="sig-param"><span class="n">anchor_obj</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">add_distance</span><span class="o">=</span><span class="default_value">0</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_range.html#TBRangeTurnHandler.join_rangefield"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.TBRangeTurnHandler.join_rangefield" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Adds a new object to the range field of a fight in progress.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>to_init</strong> (<em>object</em>) – Object to initialize range field for.</p>
|
||
</dd>
|
||
<dt class="field-even">Keyword Arguments</dt>
|
||
<dd class="field-even"><ul class="simple">
|
||
<li><p><strong>anchor_obj</strong> (<a class="reference internal" href="evennia.scripts.models.html#evennia.scripts.models.ScriptDB.object" title="evennia.scripts.models.ScriptDB.object"><em>object</em></a>) – Object to copy range values from, or None for a random object.</p></li>
|
||
<li><p><strong>add_distance</strong> (<em>int</em>) – Distance to put between to_init object and anchor object.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.TBRangeTurnHandler.initialize_for_combat">
|
||
<code class="sig-name descname">initialize_for_combat</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_range.html#TBRangeTurnHandler.initialize_for_combat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.TBRangeTurnHandler.initialize_for_combat" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Prepares a character for combat when starting or entering a fight.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>character</strong> (<em>obj</em>) – Character to initialize for combat.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.TBRangeTurnHandler.start_turn">
|
||
<code class="sig-name descname">start_turn</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_range.html#TBRangeTurnHandler.start_turn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.TBRangeTurnHandler.start_turn" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Readies a character for the start of their turn by replenishing their
|
||
available actions and notifying them that their turn has come up.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>character</strong> (<em>obj</em>) – Character to be readied.</p>
|
||
</dd>
|
||
</dl>
|
||
<p class="rubric">Notes</p>
|
||
<p>In this example, characters are given two actions per turn. This allows
|
||
characters to both move and attack in the same turn (or, alternately,
|
||
move twice or attack twice).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.TBRangeTurnHandler.next_turn">
|
||
<code class="sig-name descname">next_turn</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_range.html#TBRangeTurnHandler.next_turn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.TBRangeTurnHandler.next_turn" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Advances to the next character in the turn order.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.TBRangeTurnHandler.turn_end_check">
|
||
<code class="sig-name descname">turn_end_check</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_range.html#TBRangeTurnHandler.turn_end_check"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.TBRangeTurnHandler.turn_end_check" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Tests to see if a character’s turn is over, and cycles to the next turn if it is.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>character</strong> (<em>obj</em>) – Character to test for end of turn</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.TBRangeTurnHandler.join_fight">
|
||
<code class="sig-name descname">join_fight</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_range.html#TBRangeTurnHandler.join_fight"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.TBRangeTurnHandler.join_fight" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Adds a new character to a fight already in progress.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>character</strong> (<em>obj</em>) – Character to be added to the fight.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py exception">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.TBRangeTurnHandler.DoesNotExist">
|
||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.TBRangeTurnHandler.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.scripts.scripts.html#evennia.scripts.scripts.DefaultScript.DoesNotExist" title="evennia.scripts.scripts.DefaultScript.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.scripts.scripts.DefaultScript.DoesNotExist</span></code></a></p>
|
||
</dd></dl>
|
||
|
||
<dl class="py exception">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.TBRangeTurnHandler.MultipleObjectsReturned">
|
||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.TBRangeTurnHandler.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.scripts.scripts.html#evennia.scripts.scripts.DefaultScript.MultipleObjectsReturned" title="evennia.scripts.scripts.DefaultScript.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.scripts.scripts.DefaultScript.MultipleObjectsReturned</span></code></a></p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.TBRangeTurnHandler.path">
|
||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.turnbattle.tb_range.TBRangeTurnHandler'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.TBRangeTurnHandler.path" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.TBRangeTurnHandler.typename">
|
||
<code class="sig-name descname">typename</code><em class="property"> = 'TBRangeTurnHandler'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.TBRangeTurnHandler.typename" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.TBRangeCharacter">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_range.</code><code class="sig-name descname">TBRangeCharacter</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_range.html#TBRangeCharacter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.TBRangeCharacter" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultCharacter" title="evennia.objects.objects.DefaultCharacter"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultCharacter</span></code></a></p>
|
||
<p>A character able to participate in turn-based combat. Has attributes for current
|
||
and maximum HP, and access to combat commands.</p>
|
||
<dl class="py method">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.TBRangeCharacter.at_object_creation">
|
||
<code class="sig-name descname">at_object_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_range.html#TBRangeCharacter.at_object_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.TBRangeCharacter.at_object_creation" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Called once, when this object is first created. This is the
|
||
normal hook to overload for most object types.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.TBRangeCharacter.at_before_move">
|
||
<code class="sig-name descname">at_before_move</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">destination</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_range.html#TBRangeCharacter.at_before_move"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.TBRangeCharacter.at_before_move" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Called just before starting to move this object to
|
||
destination.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>destination</strong> (<em>Object</em>) – The object we are moving to</p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p><em>shouldmove (bool)</em> – If we should move or not.</p>
|
||
</dd>
|
||
</dl>
|
||
<p class="rubric">Notes</p>
|
||
<p>If this method returns False/None, the move is cancelled
|
||
before it is even started.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py exception">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.TBRangeCharacter.DoesNotExist">
|
||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.TBRangeCharacter.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultCharacter.DoesNotExist" title="evennia.objects.objects.DefaultCharacter.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultCharacter.DoesNotExist</span></code></a></p>
|
||
</dd></dl>
|
||
|
||
<dl class="py exception">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.TBRangeCharacter.MultipleObjectsReturned">
|
||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.TBRangeCharacter.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultCharacter.MultipleObjectsReturned" title="evennia.objects.objects.DefaultCharacter.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultCharacter.MultipleObjectsReturned</span></code></a></p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.TBRangeCharacter.path">
|
||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.turnbattle.tb_range.TBRangeCharacter'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.TBRangeCharacter.path" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.TBRangeCharacter.typename">
|
||
<code class="sig-name descname">typename</code><em class="property"> = 'TBRangeCharacter'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.TBRangeCharacter.typename" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.TBRangeObject">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_range.</code><code class="sig-name descname">TBRangeObject</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_range.html#TBRangeObject"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.TBRangeObject" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultObject" title="evennia.objects.objects.DefaultObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultObject</span></code></a></p>
|
||
<p>An object that is assigned range values in combat. Getting, giving, and dropping
|
||
the object has restrictions in combat - you must be next to an object to get it,
|
||
must be next to your target to give them something, and can only interact with
|
||
objects on your own turn.</p>
|
||
<dl class="py method">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.TBRangeObject.at_before_drop">
|
||
<code class="sig-name descname">at_before_drop</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">dropper</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_range.html#TBRangeObject.at_before_drop"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.TBRangeObject.at_before_drop" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Called by the default <strong>drop</strong> command before this object has been
|
||
dropped.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>dropper</strong> (<em>Object</em>) – The object which will drop this object.</p></li>
|
||
<li><p><strong>**kwargs</strong> (<em>dict</em>) – Arbitrary, optional arguments for users
|
||
overriding the call (unused by default).</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p><em>shoulddrop (bool)</em> – If the object should be dropped or not.</p>
|
||
</dd>
|
||
</dl>
|
||
<p class="rubric">Notes</p>
|
||
<p>If this method returns False/None, the dropping is cancelled
|
||
before it is even started.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.TBRangeObject.at_drop">
|
||
<code class="sig-name descname">at_drop</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">dropper</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_range.html#TBRangeObject.at_drop"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.TBRangeObject.at_drop" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Called by the default <strong>drop</strong> command when this object has been
|
||
dropped.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>dropper</strong> (<em>Object</em>) – The object which just dropped this object.</p></li>
|
||
<li><p><strong>**kwargs</strong> (<em>dict</em>) – Arbitrary, optional arguments for users
|
||
overriding the call (unused by default).</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<p class="rubric">Notes</p>
|
||
<p>This hook cannot stop the drop from happening. Use
|
||
permissions or the at_before_drop() hook for that.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.TBRangeObject.at_before_get">
|
||
<code class="sig-name descname">at_before_get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">getter</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_range.html#TBRangeObject.at_before_get"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.TBRangeObject.at_before_get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Called by the default <strong>get</strong> command before this object has been
|
||
picked up.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>getter</strong> (<em>Object</em>) – The object about to get this object.</p></li>
|
||
<li><p><strong>**kwargs</strong> (<em>dict</em>) – Arbitrary, optional arguments for users
|
||
overriding the call (unused by default).</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p><em>shouldget (bool)</em> – If the object should be gotten or not.</p>
|
||
</dd>
|
||
</dl>
|
||
<p class="rubric">Notes</p>
|
||
<p>If this method returns False/None, the getting is cancelled
|
||
before it is even started.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.TBRangeObject.at_get">
|
||
<code class="sig-name descname">at_get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">getter</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_range.html#TBRangeObject.at_get"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.TBRangeObject.at_get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Called by the default <strong>get</strong> command when this object has been
|
||
picked up.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>getter</strong> (<em>Object</em>) – The object getting this object.</p></li>
|
||
<li><p><strong>**kwargs</strong> (<em>dict</em>) – Arbitrary, optional arguments for users
|
||
overriding the call (unused by default).</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<p class="rubric">Notes</p>
|
||
<p>This hook cannot stop the pickup from happening. Use
|
||
permissions or the at_before_get() hook for that.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.TBRangeObject.at_before_give">
|
||
<code class="sig-name descname">at_before_give</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">giver</span></em>, <em class="sig-param"><span class="n">getter</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_range.html#TBRangeObject.at_before_give"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.TBRangeObject.at_before_give" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Called by the default <strong>give</strong> command before this object has been
|
||
given.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>giver</strong> (<em>Object</em>) – The object about to give this object.</p></li>
|
||
<li><p><strong>getter</strong> (<em>Object</em>) – The object about to get this object.</p></li>
|
||
<li><p><strong>**kwargs</strong> (<em>dict</em>) – Arbitrary, optional arguments for users
|
||
overriding the call (unused by default).</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p><em>shouldgive (bool)</em> – If the object should be given or not.</p>
|
||
</dd>
|
||
</dl>
|
||
<p class="rubric">Notes</p>
|
||
<p>If this method returns False/None, the giving is cancelled
|
||
before it is even started.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.TBRangeObject.at_give">
|
||
<code class="sig-name descname">at_give</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">giver</span></em>, <em class="sig-param"><span class="n">getter</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_range.html#TBRangeObject.at_give"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.TBRangeObject.at_give" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Called by the default <strong>give</strong> command when this object has been
|
||
given.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>giver</strong> (<em>Object</em>) – The object giving this object.</p></li>
|
||
<li><p><strong>getter</strong> (<em>Object</em>) – The object getting this object.</p></li>
|
||
<li><p><strong>**kwargs</strong> (<em>dict</em>) – Arbitrary, optional arguments for users
|
||
overriding the call (unused by default).</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<p class="rubric">Notes</p>
|
||
<p>This hook cannot stop the give from happening. Use
|
||
permissions or the at_before_give() hook for that.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py exception">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.TBRangeObject.DoesNotExist">
|
||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.TBRangeObject.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultObject.DoesNotExist" title="evennia.objects.objects.DefaultObject.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultObject.DoesNotExist</span></code></a></p>
|
||
</dd></dl>
|
||
|
||
<dl class="py exception">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.TBRangeObject.MultipleObjectsReturned">
|
||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.TBRangeObject.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultObject.MultipleObjectsReturned" title="evennia.objects.objects.DefaultObject.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultObject.MultipleObjectsReturned</span></code></a></p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.TBRangeObject.path">
|
||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.turnbattle.tb_range.TBRangeObject'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.TBRangeObject.path" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.TBRangeObject.typename">
|
||
<code class="sig-name descname">typename</code><em class="property"> = 'TBRangeObject'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.TBRangeObject.typename" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.CmdFight">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_range.</code><code class="sig-name descname">CmdFight</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_range.html#CmdFight"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdFight" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.command.html#evennia.commands.command.Command" title="evennia.commands.command.Command"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.command.Command</span></code></a></p>
|
||
<p>Starts a fight with everyone in the same room as you.</p>
|
||
<dl class="simple">
|
||
<dt>Usage:</dt><dd><p>fight</p>
|
||
</dd>
|
||
</dl>
|
||
<p>When you start a fight, everyone in the room who is able to
|
||
fight is added to combat, and a turn order is randomly rolled.
|
||
When it’s your turn, you can attack other characters.</p>
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.CmdFight.key">
|
||
<code class="sig-name descname">key</code><em class="property"> = 'fight'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdFight.key" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.CmdFight.help_category">
|
||
<code class="sig-name descname">help_category</code><em class="property"> = 'combat'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdFight.help_category" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.CmdFight.func">
|
||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_range.html#CmdFight.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdFight.func" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>This performs the actual command.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.CmdFight.aliases">
|
||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdFight.aliases" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.CmdFight.lock_storage">
|
||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdFight.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.CmdAttack">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_range.</code><code class="sig-name descname">CmdAttack</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_range.html#CmdAttack"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdAttack" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.command.html#evennia.commands.command.Command" title="evennia.commands.command.Command"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.command.Command</span></code></a></p>
|
||
<p>Attacks another character in melee.</p>
|
||
<dl class="simple">
|
||
<dt>Usage:</dt><dd><p>attack <target></p>
|
||
</dd>
|
||
</dl>
|
||
<p>When in a fight, you may attack another character. The attack has
|
||
a chance to hit, and if successful, will deal damage. You can only
|
||
attack engaged targets - that is, targets that are right next to
|
||
you. Use the ‘approach’ command to get closer to a target.</p>
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.CmdAttack.key">
|
||
<code class="sig-name descname">key</code><em class="property"> = 'attack'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdAttack.key" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.CmdAttack.help_category">
|
||
<code class="sig-name descname">help_category</code><em class="property"> = 'combat'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdAttack.help_category" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.CmdAttack.func">
|
||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_range.html#CmdAttack.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdAttack.func" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>This performs the actual command.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.CmdAttack.aliases">
|
||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdAttack.aliases" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.CmdAttack.lock_storage">
|
||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdAttack.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.CmdShoot">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_range.</code><code class="sig-name descname">CmdShoot</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_range.html#CmdShoot"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdShoot" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.command.html#evennia.commands.command.Command" title="evennia.commands.command.Command"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.command.Command</span></code></a></p>
|
||
<p>Attacks another character from range.</p>
|
||
<dl class="simple">
|
||
<dt>Usage:</dt><dd><p>shoot <target></p>
|
||
</dd>
|
||
</dl>
|
||
<p>When in a fight, you may shoot another character. The attack has
|
||
a chance to hit, and if successful, will deal damage. You can attack
|
||
any target in combat by shooting, but can’t shoot if there are any
|
||
targets engaged with you. Use the ‘withdraw’ command to retreat from
|
||
nearby enemies.</p>
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.CmdShoot.key">
|
||
<code class="sig-name descname">key</code><em class="property"> = 'shoot'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdShoot.key" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.CmdShoot.help_category">
|
||
<code class="sig-name descname">help_category</code><em class="property"> = 'combat'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdShoot.help_category" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.CmdShoot.func">
|
||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_range.html#CmdShoot.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdShoot.func" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>This performs the actual command.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.CmdShoot.aliases">
|
||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdShoot.aliases" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.CmdShoot.lock_storage">
|
||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdShoot.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.CmdApproach">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_range.</code><code class="sig-name descname">CmdApproach</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_range.html#CmdApproach"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdApproach" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.command.html#evennia.commands.command.Command" title="evennia.commands.command.Command"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.command.Command</span></code></a></p>
|
||
<p>Approaches an object.</p>
|
||
<dl class="simple">
|
||
<dt>Usage:</dt><dd><p>approach <target></p>
|
||
</dd>
|
||
</dl>
|
||
<p>Move one space toward a character or object. You can only attack
|
||
characters you are 0 spaces away from.</p>
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.CmdApproach.key">
|
||
<code class="sig-name descname">key</code><em class="property"> = 'approach'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdApproach.key" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.CmdApproach.help_category">
|
||
<code class="sig-name descname">help_category</code><em class="property"> = 'combat'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdApproach.help_category" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.CmdApproach.func">
|
||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_range.html#CmdApproach.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdApproach.func" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>This performs the actual command.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.CmdApproach.aliases">
|
||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdApproach.aliases" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.CmdApproach.lock_storage">
|
||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdApproach.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.CmdWithdraw">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_range.</code><code class="sig-name descname">CmdWithdraw</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_range.html#CmdWithdraw"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdWithdraw" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.command.html#evennia.commands.command.Command" title="evennia.commands.command.Command"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.command.Command</span></code></a></p>
|
||
<p>Moves away from an object.</p>
|
||
<dl class="simple">
|
||
<dt>Usage:</dt><dd><p>withdraw <target></p>
|
||
</dd>
|
||
</dl>
|
||
<p>Move one space away from a character or object.</p>
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.CmdWithdraw.key">
|
||
<code class="sig-name descname">key</code><em class="property"> = 'withdraw'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdWithdraw.key" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.CmdWithdraw.help_category">
|
||
<code class="sig-name descname">help_category</code><em class="property"> = 'combat'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdWithdraw.help_category" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.CmdWithdraw.func">
|
||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_range.html#CmdWithdraw.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdWithdraw.func" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>This performs the actual command.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.CmdWithdraw.aliases">
|
||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdWithdraw.aliases" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.CmdWithdraw.lock_storage">
|
||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdWithdraw.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.CmdPass">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_range.</code><code class="sig-name descname">CmdPass</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_range.html#CmdPass"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdPass" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.command.html#evennia.commands.command.Command" title="evennia.commands.command.Command"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.command.Command</span></code></a></p>
|
||
<p>Passes on your turn.</p>
|
||
<dl class="simple">
|
||
<dt>Usage:</dt><dd><p>pass</p>
|
||
</dd>
|
||
</dl>
|
||
<p>When in a fight, you can use this command to end your turn early, even
|
||
if there are still any actions you can take.</p>
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.CmdPass.key">
|
||
<code class="sig-name descname">key</code><em class="property"> = 'pass'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdPass.key" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.CmdPass.aliases">
|
||
<code class="sig-name descname">aliases</code><em class="property"> = ['hold', 'wait']</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdPass.aliases" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.CmdPass.help_category">
|
||
<code class="sig-name descname">help_category</code><em class="property"> = 'combat'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdPass.help_category" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.CmdPass.func">
|
||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_range.html#CmdPass.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdPass.func" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>This performs the actual command.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.CmdPass.lock_storage">
|
||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdPass.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.CmdDisengage">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_range.</code><code class="sig-name descname">CmdDisengage</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_range.html#CmdDisengage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdDisengage" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.command.html#evennia.commands.command.Command" title="evennia.commands.command.Command"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.command.Command</span></code></a></p>
|
||
<p>Passes your turn and attempts to end combat.</p>
|
||
<dl class="simple">
|
||
<dt>Usage:</dt><dd><p>disengage</p>
|
||
</dd>
|
||
</dl>
|
||
<p>Ends your turn early and signals that you’re trying to end
|
||
the fight. If all participants in a fight disengage, the
|
||
fight ends.</p>
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.CmdDisengage.key">
|
||
<code class="sig-name descname">key</code><em class="property"> = 'disengage'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdDisengage.key" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.CmdDisengage.aliases">
|
||
<code class="sig-name descname">aliases</code><em class="property"> = ['spare']</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdDisengage.aliases" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.CmdDisengage.help_category">
|
||
<code class="sig-name descname">help_category</code><em class="property"> = 'combat'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdDisengage.help_category" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.CmdDisengage.func">
|
||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_range.html#CmdDisengage.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdDisengage.func" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>This performs the actual command.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.CmdDisengage.lock_storage">
|
||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdDisengage.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.CmdRest">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_range.</code><code class="sig-name descname">CmdRest</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_range.html#CmdRest"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdRest" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.command.html#evennia.commands.command.Command" title="evennia.commands.command.Command"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.command.Command</span></code></a></p>
|
||
<p>Recovers damage.</p>
|
||
<dl class="simple">
|
||
<dt>Usage:</dt><dd><p>rest</p>
|
||
</dd>
|
||
</dl>
|
||
<p>Resting recovers your HP to its maximum, but you can only
|
||
rest if you’re not in a fight.</p>
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.CmdRest.key">
|
||
<code class="sig-name descname">key</code><em class="property"> = 'rest'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdRest.key" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.CmdRest.help_category">
|
||
<code class="sig-name descname">help_category</code><em class="property"> = 'combat'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdRest.help_category" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.CmdRest.func">
|
||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_range.html#CmdRest.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdRest.func" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>This performs the actual command.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.CmdRest.aliases">
|
||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdRest.aliases" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.CmdRest.lock_storage">
|
||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdRest.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.CmdStatus">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_range.</code><code class="sig-name descname">CmdStatus</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_range.html#CmdStatus"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdStatus" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.command.html#evennia.commands.command.Command" title="evennia.commands.command.Command"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.command.Command</span></code></a></p>
|
||
<p>Gives combat information.</p>
|
||
<dl class="simple">
|
||
<dt>Usage:</dt><dd><p>status</p>
|
||
</dd>
|
||
</dl>
|
||
<p>Shows your current and maximum HP and your distance from
|
||
other targets in combat.</p>
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.CmdStatus.key">
|
||
<code class="sig-name descname">key</code><em class="property"> = 'status'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdStatus.key" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.CmdStatus.help_category">
|
||
<code class="sig-name descname">help_category</code><em class="property"> = 'combat'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdStatus.help_category" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.CmdStatus.func">
|
||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_range.html#CmdStatus.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdStatus.func" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>This performs the actual command.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.CmdStatus.aliases">
|
||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdStatus.aliases" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.CmdStatus.lock_storage">
|
||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdStatus.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.CmdCombatHelp">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_range.</code><code class="sig-name descname">CmdCombatHelp</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_range.html#CmdCombatHelp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdCombatHelp" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.help.html#evennia.commands.default.help.CmdHelp" title="evennia.commands.default.help.CmdHelp"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.help.CmdHelp</span></code></a></p>
|
||
<p>View help or a list of topics</p>
|
||
<dl class="simple">
|
||
<dt>Usage:</dt><dd><p>help <topic or command>
|
||
help list
|
||
help all</p>
|
||
</dd>
|
||
</dl>
|
||
<p>This will search for help on commands and other
|
||
topics related to the game.</p>
|
||
<dl class="py method">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.CmdCombatHelp.func">
|
||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_range.html#CmdCombatHelp.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdCombatHelp.func" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Run the dynamic help entry creator.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.CmdCombatHelp.aliases">
|
||
<code class="sig-name descname">aliases</code><em class="property"> = ['?']</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdCombatHelp.aliases" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.CmdCombatHelp.help_category">
|
||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdCombatHelp.help_category" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.CmdCombatHelp.key">
|
||
<code class="sig-name descname">key</code><em class="property"> = 'help'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdCombatHelp.key" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.CmdCombatHelp.lock_storage">
|
||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdCombatHelp.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.BattleCmdSet">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_range.</code><code class="sig-name descname">BattleCmdSet</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cmdsetobj</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">key</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_range.html#BattleCmdSet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.BattleCmdSet" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.cmdset_character.html#evennia.commands.default.cmdset_character.CharacterCmdSet" title="evennia.commands.default.cmdset_character.CharacterCmdSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.cmdset_character.CharacterCmdSet</span></code></a></p>
|
||
<p>This command set includes all the commmands used in the battle system.</p>
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.BattleCmdSet.key">
|
||
<code class="sig-name descname">key</code><em class="property"> = 'DefaultCharacter'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.BattleCmdSet.key" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.BattleCmdSet.at_cmdset_creation">
|
||
<code class="sig-name descname">at_cmdset_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_range.html#BattleCmdSet.at_cmdset_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.BattleCmdSet.at_cmdset_creation" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Populates the cmdset</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.turnbattle.tb_range.BattleCmdSet.path">
|
||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.turnbattle.tb_range.BattleCmdSet'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.BattleCmdSet.path" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</section>
|
||
|
||
|
||
<div class="clearer"></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||
<div class="sphinxsidebarwrapper">
|
||
<p class="logo"><a href="../index.html">
|
||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||
</a></p>
|
||
<div id="searchbox" style="display: none" role="search">
|
||
<h3 id="searchlabel">Quick search</h3>
|
||
<div class="searchformwrapper">
|
||
<form class="search" action="../search.html" method="get">
|
||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||
<input type="submit" value="Go" />
|
||
</form>
|
||
</div>
|
||
</div>
|
||
<script>$('#searchbox').show(0);</script>
|
||
<div role="note" aria-label="source link">
|
||
<!--h3>This Page</h3-->
|
||
<ul class="this-page-menu">
|
||
<li><a href="../_sources/api/evennia.contrib.turnbattle.tb_range.md.txt"
|
||
rel="nofollow">Show Page Source</a></li>
|
||
</ul>
|
||
</div><h3>Links</h3>
|
||
<ul>
|
||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||
<li><a href="http://webchat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb">IRC</a> -
|
||
<a href="https://discord.gg/NecFePw">Discord</a> -
|
||
<a href="https://groups.google.com/forum/#%21forum/evennia">Forums</a>
|
||
</li>
|
||
<li><a href="http://evennia.blogspot.com/">Evennia Dev blog</a> </li>
|
||
</ul>
|
||
<h3>Versions</h3>
|
||
<ul>
|
||
<li><a href="../../1.0-dev/index.html">1.0-dev (develop branch)</a></li>
|
||
<li><a href="evennia.contrib.turnbattle.tb_range.html">0.9.5 (v0.9.5 branch)</a></li>
|
||
</ul>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<div class="clearer"></div>
|
||
</div>
|
||
<div class="related" role="navigation" aria-label="related navigation">
|
||
<h3>Navigation</h3>
|
||
<ul>
|
||
<li class="right" style="margin-right: 10px">
|
||
<a href="../genindex.html" title="General Index"
|
||
>index</a></li>
|
||
<li class="right" >
|
||
<a href="../py-modindex.html" title="Python Module Index"
|
||
>modules</a> |</li>
|
||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 0.9.5</a> »</li>
|
||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.turnbattle.tb_range</a></li>
|
||
</ul>
|
||
</div>
|
||
<div class="footer" role="contentinfo">
|
||
© Copyright 2020, The Evennia developer community.
|
||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||
</div>
|
||
</body>
|
||
</html> |