<spanid="evennia-contrib-tutorials-evadventure-combat-turnbased"></span><h1>evennia.contrib.tutorials.evadventure.combat_turnbased<aclass="headerlink"href="#module-evennia.contrib.tutorials.evadventure.combat_turnbased"title="Link to this heading">¶</a></h1>
<p>EvAdventure Turn-based combat</p>
<p>This implements a turn-based (Final Fantasy, etc) style of MUD combat.</p>
<p>In this variation, all combatants are sharing the same combat handler, sitting on the current room.
The user will receive a menu of combat options and each combatat has a certain time time (e.g. 30s)
to select their next action or do nothing. To speed up play, as soon as everyone in combat selected
their next action, the next turn runs immediately, regardless of the timeout.</p>
<p>With this example, all chosen combat actions are considered to happen at the same time (so you are
able to kill and be killed in the same turn).</p>
<p>Unlike in twitch-like combat, there is no movement while in turn-based combat. Fleeing is a select
action that takes several vulnerable turns to complete.</p>
<emclass="property"><spanclass="k"><spanclass="pre">class</span></span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">evennia.contrib.tutorials.evadventure.combat_turnbased.</span></span><spanclass="sig-name descname"><spanclass="pre">CombatActionFlee</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">combathandler</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">combatant</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">action_dict</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/evadventure/combat_turnbased.html#CombatActionFlee"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.contrib.tutorials.evadventure.combat_turnbased.CombatActionFlee"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">execute</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/evadventure/combat_turnbased.html#CombatActionFlee.execute"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.contrib.tutorials.evadventure.combat_turnbased.CombatActionFlee.execute"title="Link to this definition">¶</a></dt>
<dd><p>Perform the action as the combatant. Should normally make use of the properties
<emclass="property"><spanclass="k"><spanclass="pre">class</span></span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">evennia.contrib.tutorials.evadventure.combat_turnbased.</span></span><spanclass="sig-name descname"><spanclass="pre">EvAdventureTurnbasedCombatHandler</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o"><spanclass="pre">*</span></span><spanclass="n"><spanclass="pre">args</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/evadventure/combat_turnbased.html#EvAdventureTurnbasedCombatHandler"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.contrib.tutorials.evadventure.combat_turnbased.EvAdventureTurnbasedCombatHandler"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">action_classes</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">{'attack':</span><spanclass="pre"><class</span><spanclass="pre">'evennia.contrib.tutorials.evadventure.combat_base.CombatActionAttack'>,</span><spanclass="pre">'flee':</span><spanclass="pre"><class</span><spanclass="pre">'evennia.contrib.tutorials.evadventure.combat_turnbased.CombatActionFlee'>,</span><spanclass="pre">'hold':</span><spanclass="pre"><class</span><spanclass="pre">'evennia.contrib.tutorials.evadventure.combat_base.CombatActionHold'>,</span><spanclass="pre">'stunt':</span><spanclass="pre"><class</span><spanclass="pre">'evennia.contrib.tutorials.evadventure.combat_base.CombatActionStunt'>,</span><spanclass="pre">'use':</span><spanclass="pre"><class</span><spanclass="pre">'evennia.contrib.tutorials.evadventure.combat_base.CombatActionUseItem'>,</span><spanclass="pre">'wield':</span><spanclass="pre"><class</span><spanclass="pre">'evennia.contrib.tutorials.evadventure.combat_base.CombatActionWield'>}</span></em><aclass="headerlink"href="#evennia.contrib.tutorials.evadventure.combat_turnbased.EvAdventureTurnbasedCombatHandler.action_classes"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">flee_timeout</span></span><aclass="headerlink"href="#evennia.contrib.tutorials.evadventure.combat_turnbased.EvAdventureTurnbasedCombatHandler.flee_timeout"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">fallback_action_dict</span></span><aclass="headerlink"href="#evennia.contrib.tutorials.evadventure.combat_turnbased.EvAdventureTurnbasedCombatHandler.fallback_action_dict"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">turn</span></span><aclass="headerlink"href="#evennia.contrib.tutorials.evadventure.combat_turnbased.EvAdventureTurnbasedCombatHandler.turn"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">combatants</span></span><aclass="headerlink"href="#evennia.contrib.tutorials.evadventure.combat_turnbased.EvAdventureTurnbasedCombatHandler.combatants"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">advantage_matrix</span></span><aclass="headerlink"href="#evennia.contrib.tutorials.evadventure.combat_turnbased.EvAdventureTurnbasedCombatHandler.advantage_matrix"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">disadvantage_matrix</span></span><aclass="headerlink"href="#evennia.contrib.tutorials.evadventure.combat_turnbased.EvAdventureTurnbasedCombatHandler.disadvantage_matrix"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">fleeing_combatants</span></span><aclass="headerlink"href="#evennia.contrib.tutorials.evadventure.combat_turnbased.EvAdventureTurnbasedCombatHandler.fleeing_combatants"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">defeated_combatants</span></span><aclass="headerlink"href="#evennia.contrib.tutorials.evadventure.combat_turnbased.EvAdventureTurnbasedCombatHandler.defeated_combatants"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">give_advantage</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">combatant</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">target</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/evadventure/combat_turnbased.html#EvAdventureTurnbasedCombatHandler.give_advantage"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.contrib.tutorials.evadventure.combat_turnbased.EvAdventureTurnbasedCombatHandler.give_advantage"title="Link to this definition">¶</a></dt>
<dd><p>Let a benefiter gain advantage against the target.</p>
<spanclass="sig-name descname"><spanclass="pre">give_disadvantage</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">combatant</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">target</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/evadventure/combat_turnbased.html#EvAdventureTurnbasedCombatHandler.give_disadvantage"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.contrib.tutorials.evadventure.combat_turnbased.EvAdventureTurnbasedCombatHandler.give_disadvantage"title="Link to this definition">¶</a></dt>
<dd><p>Let an affected party gain disadvantage against a target.</p>
<spanclass="sig-name descname"><spanclass="pre">has_advantage</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">combatant</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">target</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/evadventure/combat_turnbased.html#EvAdventureTurnbasedCombatHandler.has_advantage"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.contrib.tutorials.evadventure.combat_turnbased.EvAdventureTurnbasedCombatHandler.has_advantage"title="Link to this definition">¶</a></dt>
<dd><p>Check if a given combatant has advantage against a target.</p>
<spanclass="sig-name descname"><spanclass="pre">has_disadvantage</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">combatant</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">target</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/evadventure/combat_turnbased.html#EvAdventureTurnbasedCombatHandler.has_disadvantage"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.contrib.tutorials.evadventure.combat_turnbased.EvAdventureTurnbasedCombatHandler.has_disadvantage"title="Link to this definition">¶</a></dt>
<dd><p>Check if a given combatant has disadvantage against a target.</p>
<spanclass="sig-name descname"><spanclass="pre">add_combatant</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">combatant</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/evadventure/combat_turnbased.html#EvAdventureTurnbasedCombatHandler.add_combatant"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.contrib.tutorials.evadventure.combat_turnbased.EvAdventureTurnbasedCombatHandler.add_combatant"title="Link to this definition">¶</a></dt>
<dd><p>Add a new combatant to the battle. Can be called multiple times safely.</p>
<ddclass="field-odd"><p><strong>combatant</strong> (<aclass="reference internal"href="evennia.contrib.tutorials.evadventure.characters.html#evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter"title="evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter"><em>EvAdventureCharacter</em></a><em>, </em><aclass="reference internal"href="evennia.contrib.tutorials.evadventure.npcs.html#evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC"title="evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC"><em>EvAdventureNPC</em></a>) – Any number of combatants to add to
<spanclass="sig-name descname"><spanclass="pre">remove_combatant</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">combatant</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/evadventure/combat_turnbased.html#EvAdventureTurnbasedCombatHandler.remove_combatant"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.contrib.tutorials.evadventure.combat_turnbased.EvAdventureTurnbasedCombatHandler.remove_combatant"title="Link to this definition">¶</a></dt>
<dd><p>Remove a combatant from the battle. This removes their queue.</p>
<ddclass="field-odd"><p><strong>combatant</strong> (<aclass="reference internal"href="evennia.contrib.tutorials.evadventure.characters.html#evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter"title="evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter"><em>EvAdventureCharacter</em></a><em>, </em><aclass="reference internal"href="evennia.contrib.tutorials.evadventure.npcs.html#evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC"title="evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC"><em>EvAdventureNPC</em></a>) – A combatant to add to
<spanclass="sig-name descname"><spanclass="pre">start_combat</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/evadventure/combat_turnbased.html#EvAdventureTurnbasedCombatHandler.start_combat"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.contrib.tutorials.evadventure.combat_turnbased.EvAdventureTurnbasedCombatHandler.start_combat"title="Link to this definition">¶</a></dt>
<dd><p>This actually starts the combat. It’s safe to run this multiple times
since it will only start combat if it isn’t already running.</p>
<spanclass="sig-name descname"><spanclass="pre">stop_combat</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/evadventure/combat_turnbased.html#EvAdventureTurnbasedCombatHandler.stop_combat"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.contrib.tutorials.evadventure.combat_turnbased.EvAdventureTurnbasedCombatHandler.stop_combat"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">get_combat_summary</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">combatant</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/evadventure/combat_turnbased.html#EvAdventureTurnbasedCombatHandler.get_combat_summary"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.contrib.tutorials.evadventure.combat_turnbased.EvAdventureTurnbasedCombatHandler.get_combat_summary"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">get_sides</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">combatant</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/evadventure/combat_turnbased.html#EvAdventureTurnbasedCombatHandler.get_sides"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.contrib.tutorials.evadventure.combat_turnbased.EvAdventureTurnbasedCombatHandler.get_sides"title="Link to this definition">¶</a></dt>
<dd><p>Get a listing of the two ‘sides’ of this combat, from the perspective of the provided
combatant. The sides don’t need to be balanced.</p>
<spanclass="sig-name descname"><spanclass="pre">queue_action</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">combatant</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">action_dict</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/evadventure/combat_turnbased.html#EvAdventureTurnbasedCombatHandler.queue_action"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.contrib.tutorials.evadventure.combat_turnbased.EvAdventureTurnbasedCombatHandler.queue_action"title="Link to this definition">¶</a></dt>
<dd><p>Queue an action by adding the new actiondict.</p>
<spanclass="sig-name descname"><spanclass="pre">get_next_action_dict</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">combatant</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/evadventure/combat_turnbased.html#EvAdventureTurnbasedCombatHandler.get_next_action_dict"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.contrib.tutorials.evadventure.combat_turnbased.EvAdventureTurnbasedCombatHandler.get_next_action_dict"title="Link to this definition">¶</a></dt>
<dd><p>Give the action_dict for the next action that will be executed.</p>
<ddclass="field-odd"><p><strong>combatant</strong> (<aclass="reference internal"href="evennia.contrib.tutorials.evadventure.characters.html#evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter"title="evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter"><em>EvAdventureCharacter</em></a><em>, </em><aclass="reference internal"href="evennia.contrib.tutorials.evadventure.npcs.html#evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC"title="evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC"><em>EvAdventureNPC</em></a>) – The combatant to get the action for.</p>
<spanclass="sig-name descname"><spanclass="pre">execute_next_action</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">combatant</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/evadventure/combat_turnbased.html#EvAdventureTurnbasedCombatHandler.execute_next_action"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.contrib.tutorials.evadventure.combat_turnbased.EvAdventureTurnbasedCombatHandler.execute_next_action"title="Link to this definition">¶</a></dt>
<dd><p>Perform a combatant’s next queued action. Note that there is _always_ an action queued,
even if this action is ‘hold’, which means the combatant will do nothing.</p>
<spanclass="sig-name descname"><spanclass="pre">check_stop_combat</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/evadventure/combat_turnbased.html#EvAdventureTurnbasedCombatHandler.check_stop_combat"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.contrib.tutorials.evadventure.combat_turnbased.EvAdventureTurnbasedCombatHandler.check_stop_combat"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">at_repeat</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/evadventure/combat_turnbased.html#EvAdventureTurnbasedCombatHandler.at_repeat"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.contrib.tutorials.evadventure.combat_turnbased.EvAdventureTurnbasedCombatHandler.at_repeat"title="Link to this definition">¶</a></dt>
<dd><p>This method is called every time Script repeats (every <strong>interval</strong> seconds). Performs a full
turn of combat, performing everyone’s actions in random order.</p>
<emclass="property"><spanclass="k"><spanclass="pre">exception</span></span><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">DoesNotExist</span></span><aclass="headerlink"href="#evennia.contrib.tutorials.evadventure.combat_turnbased.EvAdventureTurnbasedCombatHandler.DoesNotExist"title="Link to this definition">¶</a></dt>
<emclass="property"><spanclass="k"><spanclass="pre">exception</span></span><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">MultipleObjectsReturned</span></span><aclass="headerlink"href="#evennia.contrib.tutorials.evadventure.combat_turnbased.EvAdventureTurnbasedCombatHandler.MultipleObjectsReturned"title="Link to this definition">¶</a></dt>
<emclass="property"><spanclass="k"><spanclass="pre">exception</span></span><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">NotUpdated</span></span><aclass="headerlink"href="#evennia.contrib.tutorials.evadventure.combat_turnbased.EvAdventureTurnbasedCombatHandler.NotUpdated"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">path</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'evennia.contrib.tutorials.evadventure.combat_turnbased.EvAdventureTurnbasedCombatHandler'</span></em><aclass="headerlink"href="#evennia.contrib.tutorials.evadventure.combat_turnbased.EvAdventureTurnbasedCombatHandler.path"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">typename</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'EvAdventureTurnbasedCombatHandler'</span></em><aclass="headerlink"href="#evennia.contrib.tutorials.evadventure.combat_turnbased.EvAdventureTurnbasedCombatHandler.typename"title="Link to this definition">¶</a></dt>
<spanclass="sig-prename descclassname"><spanclass="pre">evennia.contrib.tutorials.evadventure.combat_turnbased.</span></span><spanclass="sig-name descname"><spanclass="pre">node_choose_enemy_target</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">caller</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">raw_string</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/evadventure/combat_turnbased.html#node_choose_enemy_target"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.contrib.tutorials.evadventure.combat_turnbased.node_choose_enemy_target"title="Link to this definition">¶</a></dt>
<dd><p>Choose an enemy as a target for an action</p>
<spanclass="sig-prename descclassname"><spanclass="pre">evennia.contrib.tutorials.evadventure.combat_turnbased.</span></span><spanclass="sig-name descname"><spanclass="pre">node_choose_enemy_recipient</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">caller</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">raw_string</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/evadventure/combat_turnbased.html#node_choose_enemy_recipient"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.contrib.tutorials.evadventure.combat_turnbased.node_choose_enemy_recipient"title="Link to this definition">¶</a></dt>
<dd><p>Choose an enemy as a ‘recipient’ for an action.</p>
<spanclass="sig-prename descclassname"><spanclass="pre">evennia.contrib.tutorials.evadventure.combat_turnbased.</span></span><spanclass="sig-name descname"><spanclass="pre">node_choose_allied_target</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">caller</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">raw_string</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/evadventure/combat_turnbased.html#node_choose_allied_target"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.contrib.tutorials.evadventure.combat_turnbased.node_choose_allied_target"title="Link to this definition">¶</a></dt>
<dd><p>Choose an enemy as a target for an action</p>
<spanclass="sig-prename descclassname"><spanclass="pre">evennia.contrib.tutorials.evadventure.combat_turnbased.</span></span><spanclass="sig-name descname"><spanclass="pre">node_choose_allied_recipient</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">caller</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">raw_string</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/evadventure/combat_turnbased.html#node_choose_allied_recipient"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.contrib.tutorials.evadventure.combat_turnbased.node_choose_allied_recipient"title="Link to this definition">¶</a></dt>
<dd><p>Choose an allied recipient for an action</p>
<spanclass="sig-prename descclassname"><spanclass="pre">evennia.contrib.tutorials.evadventure.combat_turnbased.</span></span><spanclass="sig-name descname"><spanclass="pre">node_choose_ability</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">caller</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">raw_string</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/evadventure/combat_turnbased.html#node_choose_ability"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.contrib.tutorials.evadventure.combat_turnbased.node_choose_ability"title="Link to this definition">¶</a></dt>
<spanclass="sig-prename descclassname"><spanclass="pre">evennia.contrib.tutorials.evadventure.combat_turnbased.</span></span><spanclass="sig-name descname"><spanclass="pre">node_choose_use_item</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">caller</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">raw_string</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/evadventure/combat_turnbased.html#node_choose_use_item"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.contrib.tutorials.evadventure.combat_turnbased.node_choose_use_item"title="Link to this definition">¶</a></dt>
<spanclass="sig-prename descclassname"><spanclass="pre">evennia.contrib.tutorials.evadventure.combat_turnbased.</span></span><spanclass="sig-name descname"><spanclass="pre">node_choose_wield_item</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">caller</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">raw_string</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/evadventure/combat_turnbased.html#node_choose_wield_item"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.contrib.tutorials.evadventure.combat_turnbased.node_choose_wield_item"title="Link to this definition">¶</a></dt>
<spanclass="sig-prename descclassname"><spanclass="pre">evennia.contrib.tutorials.evadventure.combat_turnbased.</span></span><spanclass="sig-name descname"><spanclass="pre">node_combat</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">caller</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">raw_string</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/evadventure/combat_turnbased.html#node_combat"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.contrib.tutorials.evadventure.combat_turnbased.node_combat"title="Link to this definition">¶</a></dt>
<emclass="property"><spanclass="k"><spanclass="pre">class</span></span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">evennia.contrib.tutorials.evadventure.combat_turnbased.</span></span><spanclass="sig-name descname"><spanclass="pre">CmdTurnAttack</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/evadventure/combat_turnbased.html#CmdTurnAttack"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.contrib.tutorials.evadventure.combat_turnbased.CmdTurnAttack"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">key</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'attack'</span></em><aclass="headerlink"href="#evennia.contrib.tutorials.evadventure.combat_turnbased.CmdTurnAttack.key"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">aliases</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">['turnbased</span><spanclass="pre">combat',</span><spanclass="pre">'hit']</span></em><aclass="headerlink"href="#evennia.contrib.tutorials.evadventure.combat_turnbased.CmdTurnAttack.aliases"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">turn_timeout</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">30</span></em><aclass="headerlink"href="#evennia.contrib.tutorials.evadventure.combat_turnbased.CmdTurnAttack.turn_timeout"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">flee_time</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">3</span></em><aclass="headerlink"href="#evennia.contrib.tutorials.evadventure.combat_turnbased.CmdTurnAttack.flee_time"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">parse</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/evadventure/combat_turnbased.html#CmdTurnAttack.parse"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.contrib.tutorials.evadventure.combat_turnbased.CmdTurnAttack.parse"title="Link to this definition">¶</a></dt>
<dd><p>Once the cmdhandler has identified this as the command we
want, this function is run. If many of your commands have a
similar syntax (for example ‘cmd arg1 = arg2’) you should
simply define this once and just let other commands of the
same form inherit from this. See the docstring of this module
for which object properties are available to use (notably
<spanclass="sig-name descname"><spanclass="pre">func</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/evadventure/combat_turnbased.html#CmdTurnAttack.func"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.contrib.tutorials.evadventure.combat_turnbased.CmdTurnAttack.func"title="Link to this definition">¶</a></dt>
<dd><p>This is the actual executing part of the command. It is
called directly after self.parse(). See the docstring of this
module for which object properties are available (beyond those
<spanclass="sig-name descname"><spanclass="pre">help_category</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'general'</span></em><aclass="headerlink"href="#evennia.contrib.tutorials.evadventure.combat_turnbased.CmdTurnAttack.help_category"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">lock_storage</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'cmd:all();'</span></em><aclass="headerlink"href="#evennia.contrib.tutorials.evadventure.combat_turnbased.CmdTurnAttack.lock_storage"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">search_index_entry</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">{'aliases':</span><spanclass="pre">'turnbased</span><spanclass="pre">combat</span><spanclass="pre">hit',</span><spanclass="pre">'category':</span><spanclass="pre">'general',</span><spanclass="pre">'key':</span><spanclass="pre">'attack',</span><spanclass="pre">'no_prefix':</span><spanclass="pre">'</span><spanclass="pre">turnbased</span><spanclass="pre">combat</span><spanclass="pre">hit',</span><spanclass="pre">'tags':</span><spanclass="pre">'',</span><spanclass="pre">'text':</span><spanclass="pre">'\nStart</span><spanclass="pre">or</span><spanclass="pre">join</span><spanclass="pre">combat.\n\nUsage:\n</span> <spanclass="pre">attack</span><spanclass="pre">[<target>]\n\n'}</span></em><aclass="headerlink"href="#evennia.contrib.tutorials.evadventure.combat_turnbased.CmdTurnAttack.search_index_entry"title="Link to this definition">¶</a></dt>
<emclass="property"><spanclass="k"><spanclass="pre">class</span></span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">evennia.contrib.tutorials.evadventure.combat_turnbased.</span></span><spanclass="sig-name descname"><spanclass="pre">TurnCombatCmdSet</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cmdsetobj</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">key</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/evadventure/combat_turnbased.html#TurnCombatCmdSet"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.contrib.tutorials.evadventure.combat_turnbased.TurnCombatCmdSet"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">key</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'turncombat_cmdset'</span></em><aclass="headerlink"href="#evennia.contrib.tutorials.evadventure.combat_turnbased.TurnCombatCmdSet.key"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">at_cmdset_creation</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/tutorials/evadventure/combat_turnbased.html#TurnCombatCmdSet.at_cmdset_creation"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.contrib.tutorials.evadventure.combat_turnbased.TurnCombatCmdSet.at_cmdset_creation"title="Link to this definition">¶</a></dt>
<dd><p>Hook method - this should be overloaded in the inheriting
class, and should take care of populating the cmdset by use of
<spanclass="sig-name descname"><spanclass="pre">path</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'evennia.contrib.tutorials.evadventure.combat_turnbased.TurnCombatCmdSet'</span></em><aclass="headerlink"href="#evennia.contrib.tutorials.evadventure.combat_turnbased.TurnCombatCmdSet.path"title="Link to this definition">¶</a></dt>