Battle Rules

Help spread the word!

Facebook

Tumblr

Twitter

Linkedin

Reddit

Flattr

This script allows you to set up “battle rules” for victory or defeat. All battle rules must be met in order to achieve victory (or defeat).

The default battle rules are

default victory rules: all enemies are dead
default defeat rules: all actors are dead

There are four scopes for battle rules

• Global battle rules
  These apply to all battles. These are the “default” rules.
•  Map battle rules
  These apply to all battles that occur on the current map
•  Troop battle rules
  These apply to any encounter with this troop.
•  Event battle rules
  These apply to encounters on a per-event basis

There are two ways to specify rules for a battle

1. Set rules. These overwrite any previous rules. So for example, if you had defined map rules and troop rules, but then have “set” event rules, then all of the map rules and troop rules will not apply for this battle.
2. Add rules. These are added on top of any previous rules, so you can add event battle rules to any troop rules or map rules.

Download

Script: download here
Addon: Battle Rule Display – displays the battle rules

Note that the current version is not compatible with the battle rule display. You will need to use the previous version, though it does not come with rule groups. You can get the previous version here.

Installation

Place this script below Materials and above Main

Usage

All rules use the same syntax as follows:

<victory rule: add>
cond: some victory condition
desc: some description
group: 1
</victory rule>

<defeat rule: set>
cond: some defeat condition
desc: some description
group: 2
</defeat rule>

cond is the condition of this rule, as a ruby statement that evaluates to
true or false.

desc is a description of this rule. This is not necessary, but maybe some
other scripts will find some use for it.

group is the rule group that this rule will be placed in. If the group is not specified, is will default to 1.

Add and set types apply to both victory and defeat rules. They are just
example syntax.

For maps, they will be written in the note-box
For troops and events they will be written as comments.

All rules must be satisfied in order for a victory or defeat condition to be
met, so if you have 3 victory rules, then you must meet all 3 rules in order
to win a battle.

In the configuration, you can modify the default rules as necessary.

Rules Groups and Multiple victory/defeat conditions

Sometimes you would like to be able to say victory is achieved if one task is completed, or maybe another task is completed. For example, perhaps the victory conditions are

1. Kill all enemies, OR
2. Wait 5 turns

You can accomplish this using logical OR’s in your formula like this:

<victory rule: set>
Cond: (the appropriate condition, as a ruby statement. Could be very long)
Desc: kill all slime OR wait five turns
</victory rule>

Alternatively, you can use Rule Groups. These groups come with the following properties:

• All rules WITHIN a group must be satisfied in order to satisfy the group
• Only ONE group needs to be satisfied in order to achieve victory (or defeat)

The above victory condition can be re-written as follows:

<victory rule: set>
Desc: Kill all slime
Cond: $game_troop.members.select {|mem|mem.id == 1}.empty?
Group: 1
</victory rule>

<victory rule: set>
Desc: Wait 5 turns
Cond: $game_troop.turns >= 5
Group: 2
</victory rule>

By using rule groups to organize your battle rules, it becomes much easier and cleaner to manage rules for a battle.

Endless battles

It is possible that you may end up in a situation where the battle simply cannot end because the rules are set up so that at some point you will be unable to complete them. There is currently no default way to handle this, so you just have to make sure there is always a way to end a battle

Help spread the word!

Facebook

Tumblr

Twitter

Linkedin

Reddit

Flattr