Editing Event Reference Condition

Here is a list of currently implemented conditions. New event conditions can be created by creating a new page under the '''tuxemon/event/conditions''':

== battle_is ==
Check to see if a character has fought against another one and won, lost or draw.

'''Parameters'''
* <code>fighter</code>: Npc slug name (e.g. "npc_maple").
* <code>outcome</code>: One among "won", "lost" or "draw".
* <code>opponent</code>: Npc slug name (e.g. "npc_maple").

'''Examples'''
* <code>is battle_is player,won,npc_maple</code> (has player won against npc_maple in the last fight?)

== button_pressed ==
Check to see if a particular key has been pressed. E.g. <code>K_RETURN</code>.

'''Parameters'''
* <code>key</code>: A pygame key constant such as <code>K_RETURN</code>. For a list of all possible keys, refer to the [https://www.pygame.org/docs/ref/key.html Pygame Key Page]

'''Examples'''
* <code>is button_pressed K_RETURN</code>
* <code>is button_pressed K_ESCAPE</code>
* <code>not button_pressed K_SPACE</code>

== char_at ==
Check to see if the character is at the condition position on the map.

'''Parameters'''
* <code>character</code>: Either "player" or npc slug name (e.g. "npc_maple").

'''Examples'''
* <code>is char_at Maple</code>

== char_defeated ==
Check to see the character has at least one tuxemon, and all tuxemon in their party are defeated.

'''Parameters'''
* <code>character</code>: Either "player" or npc slug name (e.g. "npc_maple").

'''Examples'''
* <code>is char_defeated player</code>

== char_exists ==
Check to see if a character object exists in the current list of NPCs.

'''Parameters'''
* <code>character</code>: Either "player" or npc slug name (e.g. "npc_maple").

'''Examples'''
* <code>not char_exists npc_maple</code>

== char_facing ==
Check to see where a character is facing.

'''Parameters'''
* <code>character</code>: Either "player" or npc slug name (e.g. "npc_maple").  
* <code>direction</code>: One of "up", "down", "left" or "right".

'''Examples'''
* <code>is char_facing npc_maple,up</code>
* <code>not char_facing npc_maple,down</code>

== char_facing_char ==
Check to see the character is next to and facing a particular character.

'''Parameters'''
* <code>character1</code>: Either "player" or npc slug name (e.g. "npc_maple").
* <code>character2</code>: Either "player" or npc slug name (e.g. "npc_maple").

'''Examples'''
* <code>is char_facing_char npc_maple,player</code>

== char_facing_tile ==
Check to see if a character is facing a tile position.

'''Parameters'''
* <code>character</code>: Either "player" or npc slug name (e.g. "npc_maple"). 

'''Examples'''
* <code>is char_facing_tile npc_maple</code>

== char_in ==
Check to see if the character is at the condition position on a specific set of tiles.

'''Parameters'''
* <code>character</code>: Either "player" or npc slug name (e.g. "npc_maple").
* <code>value</code>: value (eg surfable) inside the tileset.

'''Examples'''
* <code>is char_in npc_maple,surfable</code>

== char_moved ==
Check to see the character has just moved into this tile. Using this condition will prevent a condition like "char_at" from constantly being true every single frame.

'''Parameters'''
* <code>character</code>: Either "player" or npc slug name (e.g. "npc_maple").

'''Examples'''
* <code>is char_moved player</code>

== char_position ==
Check to see if the character is at the position on the map.

'''Parameters'''
* <code>character</code>: Either "player" or npc slug name (e.g. "npc_maple").
* <code>character</code>: X position to set the character to.
* <code>tile_pos_x</code>: Y position to set the character to.

'''Examples'''
* <code>is char_position player,6,9</code>

== char_sprite ==
Check the character's sprite

'''Parameters'''
* <code>character</code>: Either "player" or npc slug name (e.g. "npc_maple").
* <code>sprite</code>: NPC's sprite (eg maniac, florist, etc.)

'''Examples'''
* <code>is char_sprite player,adventurer</code>

== check_char_parameter ==
Check the parameter's value of the character against a given value.

'''Parameters'''
* <code>character</code>: Either "player" or npc slug name (e.g. "npc_maple").
* <code>parameter</code>: Name of the parameter to check (eg. "name", "steps", etc.).
* <code>value</code>: Given value to check.

'''Examples'''
* <code>is check_char_parameter player,name,alpha</code>

== check_evolution ==
Check to see the character has at least one tuxemon evolving. If yes, it'll save the monster and the evolution inside a list. The list will be used by the event action <code>evolution</code>.

'''Parameters'''
* <code>character</code>: Either "player" or npc slug name (e.g. "npc_maple").

'''Examples'''
* <code>is check_evolution player</code>

== check_max_tech ==
Check to see the player has at least one tuxemon with more than the max number of techniques in its party. If yes, then it saves automatically the monster_id and inside the dictionary event_data.

'''Parameters'''
* <code>nr</code>: Number of tech, default the constant

'''Examples'''
* <code>is check_max_tech</code>
* <code>is check_max_tech 2</code>

== check_mission ==
Check to see the player has failed or completed a mission. Check to see if a mission is still pending.

'''Parameters'''
* <code>character</code>: Either "player" or npc slug name (e.g. "npc_maple").
* <code>method</code>: Mission or missions, "all" means all the existing missions.  
* <code>staths</code>: pending, completed or failed    

'''Examples'''
* <code>is check_mission player,mission1,completed</code>
* <code>is check_mission player,mission1,pending</code>
* <code>is check_mission player,mission1:mission2,completed</code>
* <code>is check_mission player,all,completed</code>

== check_party_parameter ==
Check to see the player has failed or completed a mission. Check to see if a mission is still pending.

'''Parameters'''
* <code>character</code>: Either "player" or npc slug name (e.g. "npc_maple").
* <code>attribute</code>: Name of the monster attribute to check (e.g. level). 
* <code>value</code>: Value to check (related to the attribute) (e.g. 5 - level).
* <code>operator</code>: Numeric comparison operator. Accepted values are "less_than", "less_or_equal", "greater_than", "greater_or_equal", "equals" and "not_equals".
* <code>times</code>: Value to check with operator (how many times in the party?). 

'''Examples'''
* <code>check_party_parameter player,level,5,equals,1</code> (is there 1 monster in the party at level 5? True/False)

== check_world ==
Check some world's parameter against a given value. 

'''Parameters'''
* <code>parameter</code>: Name of the parameter to check (eg. "layer", etc.).
* <code>value</code>: Given value to check.

'''Supported parameters'''
* '''layer''': color value which is used to overlay the world
* '''bubble''': speech bubble of an npc

'''Examples'''
* <code>is check_world</code>
* <code>is check_world layer,255:255:255:0</code>

== current_state ==
Check to see if one or multiple state/states has/have been started or not.

'''Parameters'''
* <code>state</code>: Either "CombatState", "DialogState", etc

'''Examples'''
* <code>is current_state DialogState</code>
* <code>is current_state CombatState:DialogState</code>

== has_bag ==
Check to see how many items are in the character's bag. It doesn't count invisible items.

'''Parameters'''
* <code>character</code>: Either "player" or npc slug name (e.g. "npc_maple").
* <code>operator</code>: Numeric comparison operator. Accepted values are <code>less_than</code>, <code>less_or_equal</code>, <code>greater_than</code>, <code>greater_or_equal</code>, <code>equals</code> and <code>not_equals</code>.
* <code>value</code>: The value to compare the bag with.

'''Examples'''
* <code>is has_bag player,equals,5</code> (player's bag: 5 potions and 2 tuxeball (5 items), in this case is true because 5 = 5)
* <code>is has_bag player,equals,9</code> (player's bag: 5 potions and 2 tuxeball (5 items), in this case is false because 9 != 5)

== has_item ==
Check to see if a NPC inventory contains something.

'''Parameters'''
* <code>character</code>: Either "player" or npc slug name (e.g. "npc_maple").
* <code>item</code>: The item slug name (e.g. "item_cherry").
* <code>operator</code>: Numeric comparison operator. Accepted values are <code>less_than</code>, <code>less_or_equal</code>, <code>greater_than</code>, <code>greater_or_equal</code>, <code>equals</code> and <code>not_equals</code>.
* <code>quantity</code>: Quantity to compare with. (optional)

'''Examples'''
* <code>is has_item player,potion</code>
* <code>is has_item player,potion,greater_than,2</code>

== has_kennel ==
Check to see how many monsters are in the character's box.

'''Parameters'''
* <code>character</code>: Either "player" or npc slug name (e.g. "npc_maple").
* <code>operator</code>: Numeric comparison operator. Accepted values are <code>less_than</code>, <code>less_or_equal</code>, <code>greater_than</code>, <code>greater_or_equal</code>, <code>equals</code> and <code>not_equals</code>.
* <code>value</code>: The value to compare the party with.
* <code>box</code>: The box name.

'''Examples'''
* <code>is has_kennel player,Kennel,less_than,1</code>

== has_monster ==
Check to see if a character has a monster in its party.

'''Parameters'''
* <code>character</code>: Either "player" or npc slug name (e.g. "npc_maple").
* <code>monster_slug</code>: Monster slug name (e.g. "rockitten").

'''Examples'''
* <code>is has_monster player,rockitten</code>

== has_party_breeder ==
Check to see if the character has a male and female monsters not basic (first evolution stage) in the party.

'''Parameters'''
* <code>character</code>: Either "player" or npc slug name (e.g. "npc_maple").

'''Examples'''
* <code>is has_party_breeder player</code>

== has_tech ==
Check to see if the player has a technique in his party (one of the monsters).

'''Parameters'''
* <code>technique</code>: Technique slug name (e.g. "bullet").

'''Examples'''
* <code>is has_tech bullet</code>

== kennel ==
Check if a kennel is hidden or visible.

Note: This condition checks if the kennel is in the HIDDEN_LIST. If the kennel is in the list, it is considered hidden; otherwise, it is considered visible.

'''Parameters'''
* <code>character</code>: Either "player" or npc slug name (e.g. "npc_maple").
* <code>kennel</code>: The name of the kennel to check.
* <code>option</code>: The expected visibility of the kennel ("hidden" or "visible") or existence of it ("exist").

'''Examples'''
* <code>is kennel player,Kennel,hidden</code>
* <code>is kennel player,Kennel,visible</code>
* <code>is kennel player,Kennel,exist</code>

== location_inside ==
Check to see if the player is inside.

'''Examples'''
* <code>is location_inside</code>

== location_name ==
Check to see if the player is in a certain location name.

'''Parameters'''
* <code>technique</code>: Slug name. It's the name inside the maps. eg. <code><property name="slug" value="routeb"/></code>, so slug = routeb

'''Examples'''
* <code>is location_name routeb</code>
* <code>is location_name routea:routeb</code>

== location_type ==
Check to see if the player is in a certain location type.

'''Parameters'''
* <code>slug</code>: Slug name. Either all, notype, town, route, clinic, shop, dungeon

'''Examples'''
* <code>is location_type town</code>
* <code>is location_type town:shop:clinic</code>

== money_is ==
Check to see if the player has a certain amount of money (pocket).

'''Parameters'''
* <code>character</code>: Either "player" or npc slug name (e.g. "npc_maple").
* <code>operator</code>: Numeric comparison operator. Accepted values are "less_than", "less_or_equal", "greater_than", "greater_or_equal", "equals" and "not_equals".
* <code>amount</code>: Amount of money or value stored in variable.

'''Examples'''
* <code>is money_is player,>=,500</code>
* <code>is money_is player,equals,name_variable</code> (name_variable:75)

== monster_flair ==
Check to see if the given monster flair matches the expected value.

'''Parameters'''
* <code>slot</code>: Position of the monster in the player monster list.
* <code>property</code>: Category of the flair.
* <code>name</code>: Name of the flair.

'''Examples'''
* <code>to be defined</code>

== music_playing ==
Check to see if the specified music file is currently playing.

'''Parameters'''
* <code>music_file</code>: The music file to check.

'''Examples'''
* <code>is music_playing 472452_8-Bit-Ambient.ogg</code>

== once ==
Checks the date saved in the variables with today's date.

'''Parameters'''
* <code>timeframe</code>: nr of days the event stays "blocked" (eg. 1, 7, etc.)
* <code>variable</code>: Variable where the date is stored.

'''Examples'''
* <code>set_variable variable_name:today</code>
* <code>is once 1,variable_name</code> (it blocks the event for 1 day)
or
* <code>is once 7,variable_name</code> (it blocks the event for 7 days - 1 week)

== one_of ==
Check to see if at least 1 among multiple values in a variable is True. If the variable does not exist it will return ``False``.

'''Parameters'''
* <code>variable</code>: The variable to check.
* <code>values</code>: Value to check for (multiple values separated by ":").

'''Examples'''
* <code>is one_of stage_of_day,afternoon:dusk:morning</code>

== party_infected ==
Check to see how many monster are infected in the character's party.

'''Parameters'''
* <code>character</code>: Either "player" or npc slug name (e.g. "npc_maple").
* <code>plague_slug</code>: The slug of the plague to target.
* <code>value</code>: all, some or none.

'''Examples'''
* <code>is party_infected plague_slug,some</code>

== party_size ==
Check the character's party size. The <code>check</code> parameter can be: <code>equals</code>, <code>less_than</code>, or <code>greater_than</code>.

'''Parameters'''
* <code>character</code>: Either "player" or npc slug name (e.g. "npc_maple").
* <code>operator</code>: Numeric comparison operator. Accepted values are <code>less_than</code>, <code>less_or_equal</code>, <code>greater_than</code>, <code>greater_or_equal</code>, <code>equals</code> and <code>not_equals</code>.
* <code>party_size</code>: The size of the party to check against.

'''Examples'''
* <code>is party_size less_than,1</code>
* <code>not party_size equals,0</code>
* <code>is party_size greater_than,4</code>

== to_use_tile ==
Check if we are attempting interact with a map condition tile.

'''Parameters'''
* <code>None</code>

'''Examples'''
* <code>is to_use_tile</code>

== true ==
The <code>true</code> condition will always evaluate to *True* (unless the "not" operator is used)

'''Parameters'''
* <code>None</code>

'''Examples'''
* <code>is true</code>
* <code>not true</code>

== tuxepedia ==
Check Tuxepedia's progress.

'''Parameters'''
* <code>operator</code>: Numeric comparison operator. Accepted values are "less_than", "less_or_equal", "greater_than", "greater_or_equal", "equals" and "not_equals".
* <code>percentage</code>: Number between 0.1 and 1.0
* <code>total</code>: Total, by default the total number of tuxemon.

'''Examples'''
* <code>is tuxepedia less_than,0.2</code>
* <code>is tuxepedia less_than,0.2,10</code>

== variable_is ==
Check an operation over a variable.

'''Parameters'''
* <code>value1</code>: Either a variable or a number.
* <code>operation</code>: Numeric comparison operator. Accepted values are "less_than", "less_or_equal", "greater_than", "greater_or_equal", "equals" and "not_equals".
* <code>value2</code>: Either a variable or a number.

'''Examples'''
* <code>is variable_is [value1],operator,[value2]</code>

== variable_set ==
Check to see if <code>variable_name</code> has been set to <code>value</code>.

'''Parameters'''
* <code>variable_name:value</code>: A key, value pair of the variable to look up and the expected value.

'''Examples'''
* <code>is variable_set battle_won:yes</code>
* <code>not variable_set current_badges:4</code>
* <code>is variable_set talked_to_prof:false</code>