View source for MV Formula Library/Conditional Formulas

==Condition Basics ==

There are some common syntax that you may need to use to translate your conditions into code.

===Logical Operators===

Logical operators are used when you would like to combine multiple conditions together in a certain way using the following logic:

* AND
* OR
* NOT

For example, assuming you have condition A and condition B, you can create the following conditions:

* <code>A && B</code> - returns true only if both condition A and condition B are true.
* <code>A || B</code> - returns true if any of the conditions are true.
* <code>!A</code> - returns true if condition A is false.

You can combine any number of conditions together. For example, if you had a third condition C, you can write

* <code>A && B && C</code> - returns true if A and B and C are all true
* <code>A || B || C</code> - returns true if any of A, B, or C are true

Operators are read from left to right if they have the same precedence. What does that mean?

====Operator Precedence====

When multiple operators are used, Javascript evaluates them in a certain order. They are not necessarily evaluated from left to right.

This is important, because the meaning of your condition changes depending on how you write it. The order of precedence for logical operators is

# NOT !
# AND &&
# OR ||

For example:

* <code>A || B && C</code> - returns true if (A is true) or (B and C are true)
* <code>(A || B) && C</code> - returns true if (A or B is true) and (C is true)

Notice the differences between the two statements. The first statement is not read from left to right, because && has higher precedence than ||.

Parentheses are used to clarify which operate is evaluated first. For more information, read about [https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Operators/Operator_Precedence Operator Presence on MDN].

===Inequalities===

Inequalities are used to compare two objects. For example, a common use for inequalities is to compare two numbers. In Javascript, you can compare almost anything with each other.

For example, given two numbers A and B, 

*<code>A > B</code> - returns true if A is *greater than* B
*<code>A >= B</code> - returns true if A is *greater or equal to * B
*<code>A < B</code> - returns true if A is *less than* B
*<code>A <= B</code> - returns true if A is *less than or equal to* B
*<code>A === B</code> - returns true if A is *equal to* B
*<code>A !== B</code> - returns true if A is *not equal to* B

Precedence is important here as well.

==General Formulas==

*<code>$gameVariables.value(3) === 5</code>
: Returns true if value of variable 3 is equal to 5

*<code>$gameSwitches.value(2) === false</code>
: Returns true if switch 2 is OFF</code>

==Input-Based Formulas==

All <code>Input</code> methods take a "button", which is a virtual keycode assigned to the game. Multiple keys on your keyboard, gamepad, touch device, and so on can be assigned to the same "button".

The default key assignments for the keyboard, for example, are

* <code>ok</code> - Z key, Enter key
* <code>escape</code> - X key, Esc key, Insert key, numpad 0
* <code>pageup</code> - Q key, pageup key
* <code>pagedown</code> - W key, pagedown key
* <code>control</code> - left or right control, alt
* <code>shift</code> - left or right shift
* <code>up</code> - Up arrow, Numpad 8
* <code>down</code> - Down arrow, Numpad 2
* <code>left</code> - Left arrow, Numpad 4
* <code>right</code> - Right arrow, Numpad 6
* <code>tab</code> - tab key
* <code>debug</code> - F9

With plugins, you can assign additional inputs, or define your own buttons.

*<code>Input.isPressed(BUTTON)</code>
: Returns true if the input assigned to BUTTON is held down</code>

*<code>Input.isTriggered(BUTTON)</code>
: Returns true if the input assigned to BUTTON is pressed once (repeat ignored)</code>

*<code>Input.isRepeated(BUTTON)</code>
: Returns true if the input assigned to BUTTON is pressed repeatedly (6 frame between repeat)

*<code>Input.isLongPressed(BUTTON)</code>
: Returns true if the input assigned to BUTTON has been held down for at least 24 frames

==Battler Formulas==

In the following formulas, BATTLER represents any Game_Actor or Game_Enemy reference. Basically, these are your actors or enemies in the game.

There are many different ways to obtain a reference to a battler, depending on the plugin you're using and where the formula is written.

For example

* In damage formulas, they are represented as <code>a</code> or <code>b</code>.
* <code>$gameParty.leader()</code> is the leader of the party
* <code>$gameActors.actor(3)</code> is game actor 3
* <code>$gameTroop.members()[2]</code> is the third enemy in the current troop (zero-indexed)

Certain conditions are only available to actors or enemies by default, for example enemies by default do not have levels unless you have a plugin that adds it.

*<code>BATTLER.isStateAffected(STATE_ID)</code>
:- returns true if the battler is affected by the given state

*<code>BATTLER.isEnemy()</code>
:- returns true if the battler is a Game_Enemy

*<code>BATTLER.isActor()</code>
:- returns true if the battler is a Game_Actor.

*<code>BATTLER.isAlive()</code>
:- returns true if the battler is alive

*<code>BATTLER.isDead()</code>
:- returns true if the battler is dead

*<code>BATTLER.result().hpDamage > 100</code>
:- returns true if the HP damage from the current action is greater than 100

*<code>BATTLER.result().mpDamage < 50</code>
:- returns true if the MP damage from the current actio nis less than 50

*<code>ACTOR.isWtypeEquipped(WTYPE_ID)</code>
:- returns true if the actor is holding a weapon of the given type

*<code>ACTOR.isLearnedSkill(SKILL_ID)</code>
:- returns true if the actor has learned the skill (excluding skills added by traits)
*<code>ACTOR.skills().contains($dataSkills[SKILL_ID])</code>
:- returns true if the actor has the skill (includes learned skills, and added by traits)
*<code>ACTOR.isClass($dataClasses[CLASS_ID])</code>
:- returns true if the actor is the specified class (assuming $dataClasses is the class database)

*<code>ACTOR.weapons().some( function(eq) { return eq && eq.id === WEAPON_ID})</code>
:- returns true if the actor is holding the specified weapon

*<code>ACTOR.armors().some( function(eq) { return eq && eq.id === WEAPON_ID})</code>
:- returns true if the actor is holding the specified armor

*<code>ACTOR.level === LEVEL</code>
:- returns true if the actor's level is equal to the given LEVEL

==Party Formulas==

These formulas are used for anything related to Game_Party objects.

The word <code>PARTY</code> refers to a Game_Party reference. For example, you can substitute it with <code>$gameParty</code> if you want to reference the current party. If you have plugins such as [http://himeworks.com/2016/02/party-manager-mv/ HimeWorks Party Manager], you may have more parties to work with. Please refer to plugin instructions to see how to reference those parties.

The word <code>ITEM</code> refers to a weapon, armor, or usable item.

*<code>PARTY.hasItem(ITEM)</code>
:- returns true if the party has item 2 in the inventory

*<code>PARTY.numItems(ITEM) === 10 </code>
:- returns true if the party has 10 of the specified item in the inventory

*<code>PARTY.size() === 1</code>
:- returns true if the party has only 1 member

*<code>PARTY.gold() > 1000</code>
:- returns true if the party has more than 1000 gold

*<code>PARTY.steps() < 100</code>
:- returns true if the party has taken less than 100 steps

*<code>PARTY.hasMaxItems(ITEM)</code>
:- returns true if the party has reached the max amount it can hold for wea 5

*<code>PARTY.isAnyMemberEquipped(ITEM)</code>
:- returns true if any party members has the item equipped

*<code>PARTY.allMembers().contains(ACTOR)</code>
:- returns true if the Game_Actor is in the party.

*<code>PARTY.battleMembers.contains(ACTOR)</code>
:- returns true if the Game_Actor is in the battle party

*<code>PARTY.allMembers.contains(ACTOR) && !PARTY.battleMembers().contains(ACTOR)</code>
:- returns true if the Game_Actor is in the reserve party (ie: in party, but not in battle)