<spanid="evennia-contrib-game-systems-turnbattle-tb-magic"></span><h1>evennia.contrib.game_systems.turnbattle.tb_magic<aclass="headerlink"href="#module-evennia.contrib.game_systems.turnbattle.tb_magic"title="Permalink to this headline">¶</a></h1>
<p>Simple turn-based combat system with spell casting</p>
<p>Contrib - Tim Ashley Jenkins 2017, Refactor by Griatch, 2022</p>
<p>This is a version of the ‘turnbattle’ contrib that includes a basic,
expandable framework for a ‘magic system’, whereby players can spend
a limited resource (MP) to achieve a wide variety of effects, both in
and out of combat. This does not have to strictly be a system for
magic - it can easily be re-flavored to any other sort of resource
based mechanic, like psionic powers, special moves and stamina, and
so forth.</p>
<p>In this system, spells are learned by name with the ‘learnspell’
command, and then used with the ‘cast’ command. Spells can be cast in or
out of combat - some spells can only be cast in combat, some can only be
cast outside of combat, and some can be cast any time. However, if you
are in combat, you can only cast a spell on your turn, and doing so will
typically use an action (as specified in the spell’s funciton).</p>
<p>Spells are defined at the end of the module in a database that’s a
dictionary of dictionaries - each spell is matched by name to a function,
along with various parameters that restrict when the spell can be used and
what the spell can be cast on. Included is a small variety of spells that
damage opponents and heal HP, as well as one that creates an object.</p>
<p>Because a spell can call any function, a spell can be made to do just
about anything at all. The SPELLS dictionary at the bottom of the module
even allows kwargs to be passed to the spell function, so that the same
function can be re-used for multiple similar spells.</p>
<p>Spells in this system work on a very basic resource: MP, which is spent
when casting spells and restored by resting. It shouldn’t be too difficult
to modify this system to use spell slots, some physical fuel or resource,
or whatever else your game requires.</p>
<p>To install and test, import this module’s TBMagicCharacter object into
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_magic.</code><codeclass="sig-name descname">MagicCombatRules</code><aclass="reference internal"href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#MagicCombatRules"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.MagicCombatRules"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">spell_healing</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">caster</span></em>, <emclass="sig-param"><spanclass="n">spell_name</span></em>, <emclass="sig-param"><spanclass="n">targets</span></em>, <emclass="sig-param"><spanclass="n">cost</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#MagicCombatRules.spell_healing"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.MagicCombatRules.spell_healing"title="Permalink to this definition">¶</a></dt>
<dd><p>Spell that restores HP to a target or targets.</p>
<dlclass="simple">
<dt>kwargs:</dt><dd><dlclass="simple">
<dt>healing_range (tuple): Minimum and maximum amount healed to</dt><dd><p>each target. (20, 40) by default.</p>
<codeclass="sig-name descname">spell_attack</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">caster</span></em>, <emclass="sig-param"><spanclass="n">spell_name</span></em>, <emclass="sig-param"><spanclass="n">targets</span></em>, <emclass="sig-param"><spanclass="n">cost</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#MagicCombatRules.spell_attack"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.MagicCombatRules.spell_attack"title="Permalink to this definition">¶</a></dt>
<dd><p>Spell that deals damage in combat. Similar to resolve_attack.</p>
<dlclass="simple">
<dt>kwargs:</dt><dd><dlclass="simple">
<dt>attack_name (tuple): Single and plural describing the sort of</dt><dd><p>attack or projectile that strikes each enemy.</p>
</dd>
<dt>damage_range (tuple): Minimum and maximum damage dealt by the</dt><dd><p>spell. (10, 20) by default.</p>
</dd>
<dt>accuracy (int): Modifier to the spell’s attack roll, determining</dt><dd><p>an increased or decreased chance to hit. 0 by default.</p>
</dd>
<dt>attack_count (int): How many individual attacks are made as part</dt><dd><p>of the spell. If the number of attacks exceeds the number of
targets, the first target specified will be attacked more
than once. Just 1 by default - if the attack_count is less
than the number targets given, each target will only be
<codeclass="sig-name descname">spell_conjure</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">caster</span></em>, <emclass="sig-param"><spanclass="n">spell_name</span></em>, <emclass="sig-param"><spanclass="n">targets</span></em>, <emclass="sig-param"><spanclass="n">cost</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#MagicCombatRules.spell_conjure"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.MagicCombatRules.spell_conjure"title="Permalink to this definition">¶</a></dt>
<dd><p>Spell that creates an object.</p>
<dlclass="simple">
<dt>kwargs:</dt><dd><p>obj_key (str): Key of the created object.
obj_desc (str): Desc of the created object.
obj_typeclass (str): Typeclass path of the object.</p>
</dd>
</dl>
<p>If you want to make more use of this particular spell funciton,
you may want to modify it to use the spawner (in evennia.utils.spawner)
<codeclass="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_magic.</code><codeclass="sig-name descname">COMBAT_RULES</code><emclass="property"> = <evennia.contrib.game_systems.turnbattle.tb_magic.MagicCombatRules object></em><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.COMBAT_RULES"title="Permalink to this definition">¶</a></dt>
<dd><p>In this section, each spell is matched to a function, and given parameters
that determine its MP cost, valid type and number of targets, and what
function casting the spell executes.</p>
<p>This data is given as a dictionary of dictionaries - the key of each entry
is the spell’s name, and the value is a dictionary of various options and
parameters, some of which are required and others which are optional.</p>
<p>Required values for spells:</p>
<blockquote>
<div><p>cost (int): MP cost of casting the spell
target (str): Valid targets for the spell. Can be any of:</p>
<blockquote>
<div><p>“none” - No target needed
“self” - Self only
“any” - Any object
“anyobj” - Any object that isn’t a character
“anychar” - Any character
“other” - Any object excluding the caster
“otherchar” - Any character excluding the caster</p>
</div></blockquote>
<dlclass="simple">
<dt>spellfunc (callable): Function that performs the action of the spell.</dt><dd><p>Must take the following arguments: caster (obj), spell_name (str),
targets (list), and cost (int), as well as <ahref="#id1"><spanclass="problematic"id="id2">**</span></a>kwargs.</p>
</dd>
</dl>
</div></blockquote>
<p>Optional values for spells:</p>
<blockquote>
<div><p>combat_spell (bool): If the spell can be cast in combat. True by default.
noncombat_spell (bool): If the spell can be cast out of combat. True by default.
max_targets (int): Maximum number of objects that can be targeted by the spell.</p>
<blockquote>
<div><p>1 by default - unused if target is “none” or “self”</p>
</div></blockquote>
</div></blockquote>
<p>Any other values specified besides the above will be passed as kwargs to ‘spellfunc’.
You can use kwargs to effectively re-use the same function for different but similar
spells - for example, ‘magic missile’ and ‘flame shot’ use the same function, but
behave differently, as they have different damage ranges, accuracy, amount of attacks
made as part of the spell, and so forth. If you make your spell functions flexible
enough, you can make a wide variety of spells just by adding more entries to this
<codeclass="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_magic.</code><codeclass="sig-name descname">ACTIONS_PER_TURN</code><emclass="property"> = 1</em><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.ACTIONS_PER_TURN"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_magic.</code><codeclass="sig-name descname">TBMagicCharacter</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">*</span><spanclass="n">args</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#TBMagicCharacter"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.TBMagicCharacter"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">rules</code><emclass="property"> = <evennia.contrib.game_systems.turnbattle.tb_magic.MagicCombatRules object></em><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.TBMagicCharacter.rules"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">at_object_creation</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#TBMagicCharacter.at_object_creation"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.TBMagicCharacter.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>
<p>Adds attributes for a character’s current and maximum HP.
We’re just going to set this value at ‘100’ by default.</p>
<p>You may want to expand this to include various ‘stats’ that
can be changed at creation and factor into combat calculations.</p>
<emclass="property">exception </em><codeclass="sig-name descname">DoesNotExist</code><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.TBMagicCharacter.DoesNotExist"title="Permalink to this definition">¶</a></dt>
<emclass="property">exception </em><codeclass="sig-name descname">MultipleObjectsReturned</code><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.TBMagicCharacter.MultipleObjectsReturned"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">path</code><emclass="property"> = 'evennia.contrib.game_systems.turnbattle.tb_magic.TBMagicCharacter'</em><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.TBMagicCharacter.path"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">typename</code><emclass="property"> = 'TBMagicCharacter'</em><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.TBMagicCharacter.typename"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_magic.</code><codeclass="sig-name descname">TBMagicTurnHandler</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">*</span><spanclass="n">args</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#TBMagicTurnHandler"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.TBMagicTurnHandler"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">rules</code><emclass="property"> = <evennia.contrib.game_systems.turnbattle.tb_magic.MagicCombatRules object></em><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.TBMagicTurnHandler.rules"title="Permalink to this definition">¶</a></dt>
<emclass="property">exception </em><codeclass="sig-name descname">DoesNotExist</code><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.TBMagicTurnHandler.DoesNotExist"title="Permalink to this definition">¶</a></dt>
<emclass="property">exception </em><codeclass="sig-name descname">MultipleObjectsReturned</code><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.TBMagicTurnHandler.MultipleObjectsReturned"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">path</code><emclass="property"> = 'evennia.contrib.game_systems.turnbattle.tb_magic.TBMagicTurnHandler'</em><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.TBMagicTurnHandler.path"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">typename</code><emclass="property"> = 'TBMagicTurnHandler'</em><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.TBMagicTurnHandler.typename"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_magic.</code><codeclass="sig-name descname">CmdFight</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#CmdFight"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdFight"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'fight'</em><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdFight.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'combat'</em><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdFight.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">rules</code><emclass="property"> = <evennia.contrib.game_systems.turnbattle.tb_magic.MagicCombatRules object></em><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdFight.rules"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">combat_handler_class</code><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdFight.combat_handler_class"title="Permalink to this definition">¶</a></dt>
<dd><p>alias of <aclass="reference internal"href="#evennia.contrib.game_systems.turnbattle.tb_magic.TBMagicTurnHandler"title="evennia.contrib.game_systems.turnbattle.tb_magic.TBMagicTurnHandler"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">TBMagicTurnHandler</span></code></a></p>
<codeclass="sig-name descname">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdFight.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all();'</em><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdFight.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'combat', 'key': 'fight', 'no_prefix': ' ', 'tags': '', 'text': "\n Starts a fight with everyone in the same room as you.\n\n Usage:\n fight\n\n When you start a fight, everyone in the room who is able to\n fight is added to combat, and a turn order is randomly rolled.\n When it's your turn, you can attack other characters.\n "}</em><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdFight.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_magic.</code><codeclass="sig-name descname">CmdAttack</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#CmdAttack"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdAttack"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'attack'</em><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdAttack.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'combat'</em><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdAttack.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">rules</code><emclass="property"> = <evennia.contrib.game_systems.turnbattle.tb_magic.MagicCombatRules object></em><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdAttack.rules"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdAttack.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all();'</em><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdAttack.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'combat', 'key': 'attack', 'no_prefix': ' ', 'tags': '', 'text': '\n Attacks another character.\n\n Usage:\n attack <target>\n\n When in a fight, you may attack another character. The attack has\n a chance to hit, and if successful, will deal damage.\n '}</em><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdAttack.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_magic.</code><codeclass="sig-name descname">CmdPass</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#CmdPass"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdPass"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'pass'</em><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdPass.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['wait', 'hold']</em><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdPass.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'combat'</em><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdPass.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">rules</code><emclass="property"> = <evennia.contrib.game_systems.turnbattle.tb_magic.MagicCombatRules object></em><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdPass.rules"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all();'</em><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdPass.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': 'wait hold', 'category': 'combat', 'key': 'pass', 'no_prefix': ' wait hold', 'tags': '', 'text': '\n Passes on your turn.\n\n Usage:\n pass\n\n When in a fight, you can use this command to end your turn early, even\n if there are still any actions you can take.\n '}</em><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdPass.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_magic.</code><codeclass="sig-name descname">CmdDisengage</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#CmdDisengage"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdDisengage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'disengage'</em><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdDisengage.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['spare']</em><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdDisengage.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'combat'</em><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdDisengage.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">rules</code><emclass="property"> = <evennia.contrib.game_systems.turnbattle.tb_magic.MagicCombatRules object></em><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdDisengage.rules"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all();'</em><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdDisengage.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': 'spare', 'category': 'combat', 'key': 'disengage', 'no_prefix': ' spare', 'tags': '', 'text': "\n Passes your turn and attempts to end combat.\n\n Usage:\n disengage\n\n Ends your turn early and signals that you're trying to end\n the fight. If all participants in a fight disengage, the\n fight ends.\n "}</em><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdDisengage.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_magic.</code><codeclass="sig-name descname">CmdLearnSpell</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#CmdLearnSpell"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdLearnSpell"title="Permalink to this definition">¶</a></dt>
<p>Adds a spell by name to your list of spells known.</p>
<p>The following spells are provided as examples:</p>
<blockquote>
<div><dlclass="simple">
<dt><ahref="#id3"><spanclass="problematic"id="id4">|</span></a>wmagic missile|n (3 MP): Fires three missiles that never miss. Can target</dt><dd><p>up to three different enemies.</p>
</dd>
</dl>
<p><ahref="#id5"><spanclass="problematic"id="id6">|</span></a>wflame shot|n (3 MP): Shoots a high-damage jet of flame at one target.</p>
<p><ahref="#id7"><spanclass="problematic"id="id8">|</span></a>wcure wounds|n (5 MP): Heals damage on one target.</p>
<dlclass="simple">
<dt><ahref="#id9"><spanclass="problematic"id="id10">|</span></a>wmass cure wounds|n (10 MP): Like ‘cure wounds’, but can heal up to 5</dt><dd><p>targets at once.</p>
</dd>
</dl>
<p><ahref="#id11"><spanclass="problematic"id="id12">|</span></a>wfull heal|n (12 MP): Heals one target back to full HP.</p>
<p><ahref="#id13"><spanclass="problematic"id="id14">|</span></a>wcactus conjuration|n (2 MP): Creates a cactus.</p>
<codeclass="sig-name descname">key</code><emclass="property"> = 'learnspell'</em><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdLearnSpell.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'magic'</em><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdLearnSpell.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#CmdLearnSpell.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdLearnSpell.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdLearnSpell.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all();'</em><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdLearnSpell.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'magic', 'key': 'learnspell', 'no_prefix': ' ', 'tags': '', 'text': "\n Learn a magic spell.\n\n Usage:\n learnspell <spell name>\n\n Adds a spell by name to your list of spells known.\n\n The following spells are provided as examples:\n\n |wmagic missile|n (3 MP): Fires three missiles that never miss. Can target\n up to three different enemies.\n\n |wflame shot|n (3 MP): Shoots a high-damage jet of flame at one target.\n\n |wcure wounds|n (5 MP): Heals damage on one target.\n\n |wmass cure wounds|n (10 MP): Like 'cure wounds', but can heal up to 5\n targets at once.\n\n |wfull heal|n (12 MP): Heals one target back to full HP.\n\n |wcactus conjuration|n (2 MP): Creates a cactus.\n "}</em><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdLearnSpell.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_magic.</code><codeclass="sig-name descname">CmdCast</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#CmdCast"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdCast"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'cast'</em><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdCast.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'magic'</em><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdCast.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">rules</code><emclass="property"> = <evennia.contrib.game_systems.turnbattle.tb_magic.MagicCombatRules object></em><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdCast.rules"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#CmdCast.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdCast.func"title="Permalink to this definition">¶</a></dt>
<dd><p>This performs the actual command.</p>
<p>Note: This is a quite long command, since it has to cope with all
the different circumstances in which you may or may not be able
to cast a spell. None of the spell’s effects are handled by the
command - all the command does is verify that the player’s input
is valid for the spell being cast and then call the spell’s
<codeclass="sig-name descname">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdCast.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all();'</em><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdCast.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'magic', 'key': 'cast', 'no_prefix': ' ', 'tags': '', 'text': "\n Cast a magic spell that you know, provided you have the MP\n to spend on its casting.\n\n Usage:\n cast <spellname> [= <target1>, <target2>, etc...]\n\n Some spells can be cast on multiple targets, some can be cast\n on only yourself, and some don't need a target specified at all.\n Typing 'cast' by itself will give you a list of spells you know.\n "}</em><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdCast.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_magic.</code><codeclass="sig-name descname">CmdRest</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#CmdRest"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdRest"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'rest'</em><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdRest.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'combat'</em><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdRest.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">rules</code><emclass="property"> = <evennia.contrib.game_systems.turnbattle.tb_magic.MagicCombatRules object></em><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdRest.rules"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#CmdRest.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdRest.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdRest.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all();'</em><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdRest.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'combat', 'key': 'rest', 'no_prefix': ' ', 'tags': '', 'text': "\n Recovers damage and restores MP.\n\n Usage:\n rest\n\n Resting recovers your HP and MP to their maximum, but you can\n only rest if you're not in a fight.\n "}</em><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdRest.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_magic.</code><codeclass="sig-name descname">CmdStatus</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#CmdStatus"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdStatus"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'status'</em><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdStatus.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'combat'</em><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdStatus.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#CmdStatus.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdStatus.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdStatus.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all();'</em><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdStatus.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'combat', 'key': 'status', 'no_prefix': ' ', 'tags': '', 'text': '\n Gives combat information.\n\n Usage:\n status\n\n Shows your current and maximum HP and your distance from\n other targets in combat.\n '}</em><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdStatus.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_magic.</code><codeclass="sig-name descname">CmdCombatHelp</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#CmdCombatHelp"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdCombatHelp"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['?']</em><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdCombatHelp.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'general'</em><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdCombatHelp.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'help'</em><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdCombatHelp.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdCombatHelp.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '?', 'category': 'general', 'key': 'help', 'no_prefix': ' ?', 'tags': '', 'text': '\n View help or a list of topics\n\n Usage:\n help <topic or command>\n help list\n help all\n\n This will search for help on commands and other\n topics related to the game.\n '}</em><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdCombatHelp.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_magic.</code><codeclass="sig-name descname">BattleCmdSet</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">cmdsetobj</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">key</span><spanclass="o">=</span><spanclass="default_value">None</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#BattleCmdSet"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.BattleCmdSet"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">path</code><emclass="property"> = 'evennia.contrib.game_systems.turnbattle.tb_magic.BattleCmdSet'</em><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.BattleCmdSet.path"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'DefaultCharacter'</em><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.BattleCmdSet.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">at_cmdset_creation</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#BattleCmdSet.at_cmdset_creation"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.game_systems.turnbattle.tb_magic.BattleCmdSet.at_cmdset_creation"title="Permalink to this definition">¶</a></dt>
