> For the complete documentation index, see [llms.txt](https://lucidious89-tutorials.gitbook.io/deluxe-battle-kit-tutorial/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://lucidious89-tutorials.gitbook.io/deluxe-battle-kit-tutorial/deluxe-battle-kit-for-v21.1/mid-battle-scripting.md).

# Mid-Battle Scripting

The Deluxe Battle Kit allows you to create special scripts that will run during battle to create custom scenarios. This can be used to display trainer speech during battle, change the battle music, make an animation play, edit the attributes of a battler or the battlefield, and so much more. What you can accomplish with this is only limited by your imagination.

To set up a midbattle script, you must use the <mark style="background-color:green;">"midbattleScript"</mark> Battle Rule. This is a special rule that wasn't covered in the "Deluxe Battle Rules" section above, as it requires its own section to go over all the ways in which it may be used and set up.

This rule is entered as `setBattleRule("midbattleScript", Script)`, where "Script" can be a hash which contains a series of Trigger Keys.&#x20;

Refer to the "Trigger Keys" section for more details.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://lucidious89-tutorials.gitbook.io/deluxe-battle-kit-tutorial/deluxe-battle-kit-for-v21.1/mid-battle-scripting.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
