This shows you the differences between two versions of the page.
Next revision | Previous revision | ||
start_battle [2017/05/14 15:31] – external edit 127.0.0.1 | start_battle [2021/04/21 18:53] (current) – justin | ||
---|---|---|---|
Line 2: | Line 2: | ||
---- | ---- | ||
- | Starts the specified battle. | + | Starts the specified battle. The battle name is case-sensitive. |
+ | ====Signature: | ||
<code python> | <code python> | ||
- | start_battle("battle_name") | + | start_battle(battle_name) |
</ | </ | ||
^Argument^Description^Type^Required^ | ^Argument^Description^Type^Required^ | ||
- | |"battle_name"|Description.|[[String]]|Yes| | + | |battle_name|Name of the battle to start (as defined in the [[Battle Editor]]).|[[String]]|Yes| |
====Example: | ====Example: | ||
- | < | + | < |
- | start_battle(" | + | start_battle(" |
</ | </ | ||
- | // | + | // |
<WRAP center round tip 100%> | <WRAP center round tip 100%> | ||
- | Use the **Start Battle** function to ... | + | Use the **Start Battle** function to manually trigger a battle as part of a [[script|scripted]] sequence, for example to force the player to kill some guardians before entering a dungeon. |
</ | </ | ||