Event Reference - Revision history

Jaskrendix: Replaced content with "== Introduction == This page is a reference for all the available actions and conditions available in Tuxemon. You can use this reference to create new map events for your own maps. All action and condition parameters are separated with a comma (`,`). == Condition Reference == Event Reference Condition == Action Reference == Event Reference Action == Behavior Reference == Event Reference Behavior"

2026-02-02T15:23:14Z

Replaced content with "== Introduction == This page is a reference for all the available actions and conditions available in Tuxemon. You can use this reference to create new map events for your own maps. All action and condition parameters are separated with a comma (<code>,</code>). == Condition Reference == Event Reference Condition == Action Reference == Event Reference Action == Behavior Reference == Event Reference Behavior"

Show changes

Jaskrendix at 06:28, 20 October 2024

2024-10-20T06:28:00Z

Show changes

Jaskrendix at 06:25, 20 October 2024

2024-10-20T06:25:34Z

← Older revision		Revision as of 06:25, 20 October 2024
Line 4:		Line 4:

	== Condition Reference ==		== Condition Reference ==

			[[Event Reference Condition]]

			== Action Reference ==

			[[Event Reference Action]]

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

Jaskrendix at 06:23, 20 October 2024

2024-10-20T06:23:27Z

@@ Line 104: / Line 104: @@
 '''Examples'''
 * <code>is char_moved player</code>
 === char_sprite ===
@@ Line 624: / Line 635: @@
 '''Examples'''
 * <code>char_plague plague_slug,infected,npc_maple</code>
 === char_run ===

Jaskrendix at 19:28, 17 October 2024

2024-10-17T19:28:41Z

Show changes

Jaskrendix at 19:26, 17 October 2024

2024-10-17T19:26:10Z

Show changes

Jaskrendix at 19:18, 17 October 2024

2024-10-17T19:18:56Z

← Older revision		Revision as of 19:18, 17 October 2024
Line 1,552:		Line 1,552:
	Start a battle between two characters and switch to the combat module.		Start a battle between two characters and switch to the combat module.

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

	'''Examples'''		'''Examples'''
	* <code>start_battle player,npc_maple</code>		* <code>start_battle player,npc_maple</code>
	* <code>start_battle npc_maple,npc_apple</code>		* <code>start_battle npc_maple,npc_apple</code>
Line 1,562:		Line 1,562:
	=== start_cinema_mode ===		=== start_cinema_mode ===
	Start cinema mode by animating black bars to narrow the aspect ratio.		Start cinema mode by animating black bars to narrow the aspect ratio.
			For a cinematic experience, specify the width of the horizontal and vertical black bars as a ratio of the screen resolution. For example, to achieve a 2.39:1 aspect ratio on a 1920x1080 screen, you would set the horizontal ratio to 0.42 (1920 / 1080 * (16/9 - 2.39/1)) and the vertical ratio to 0 (no vertical bars). By default only bar up and down.

	'''Parameters'''		'''Parameters'''
	* <code>None</code>		* <code>aspect_y_ratio</code>: The width of the horizontal black bars as a ratio of the screen resolution. Default standard cinema mode.
			* <code>aspect_x_ratio</code>: The width of the vertical black bars as a ratio of the screen resolution. Default None.

			'''Examples'''
			* <code>start_cinema_mode</code> default, bar up and down
			* <code>start_cinema_mode ,2.0</code> bar left and right
			* <code>start_cinema_mode 2.0</code> bar up and down
			* <code>start_cinema_mode 2.0,2.0</code> bar up, down, left and right

	~~'''Examples'''~~
	* <code>start_cinema_mode</code>

	=== stop_cinema_mode ===		=== stop_cinema_mode ===

Jaskrendix at 16:18, 17 October 2024

2024-10-17T16:18:16Z

← Older revision		Revision as of 16:18, 17 October 2024
Line 363:		Line 363:
	'''Parameters'''		'''Parameters'''
	* <code>character</code>: Either "player" or npc slug name (e.g. "npc_maple").		* <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.		* <code>value</code>: all, some or none.

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

	=== party_size ===		=== party_size ===
Line 614:		Line 615:

	=== char_plague ===		=== char_plague ===
	Set the ~~character~~ as infected, inoculated or healthy.		Set the entire party as infected or inoculated or healthy.

	'''Parameters'''		'''Parameters'''
	* <code>condition</code>: Infected, inoculated or healthy.		* <code>plague_slug</code>: The slug of the plague to target.
			* <code>condition</code>: Infected, inoculated, or None (removes the plague from the character, indicating a healthy state). (optional)
	* <code>character</code>: Either "player" or npc slug name (e.g. "npc_maple"). (optional)		* <code>character</code>: Either "player" or npc slug name (e.g. "npc_maple"). (optional)

	'''Examples'''		'''Examples'''
	* <code>char_plague infected,npc_maple</code>		* <code>char_plague plague_slug,infected,npc_maple</code>

	=== char_run ===		=== char_run ===
Line 1,084:		Line 1,086:

	=== quarantine ===		=== quarantine ===
	Quarantine infected ~~monsters. Amount works only for "out", it takes out the amount in~~ a ~~random way~~.		Quarantine or release monsters infected with a specific plague.

	'''Parameters'''		'''Parameters'''
	* <code>value</code>: in or out		* <code>plague_slug</code>: The slug of the plague to target.
	* <code>amount</code>: number of monsters ~~(optional)~~		* <code>value</code>: "in" to quarantine infected monsters, "out" to release them.
			* <code>amount</code>: (Optional, only for "out") The number of monsters to release randomly.

	'''Examples'''		'''Examples'''
	* <code>quarantine out</code> everything out (player's party -> if full, then box)		* <code>quarantine plague_slug,out</code> everything out (player's party -> if full, then box)
	* <code>quarantine out,5</code> eg. box contains 30 monsters <code>quarantine out,5</code>, it means 5 monsters by random		* <code>quarantine plague_slug,out,5</code> eg. box contains 30 monsters <code>quarantine out,5</code>, it means 5 monsters by random

	=== quit ===		=== quit ===
Line 1,421:		Line 1,424:

	=== set_monster_plague ===		=== set_monster_plague ===
	Set a monster's plague to the given condition. '''To get the mechanics going, it's crucial to know that must be a technique called '~~name_of_the_plague~~' (eg. spyderbite)'''.		Set a monster's plague to the given condition. '''To get the mechanics going, it's crucial to know that must be a technique called 'plague_slug' (eg. spyderbite)'''.

	'''Parameters'''		'''Parameters'''

Jaskrendix at 16:12, 17 October 2024

2024-10-17T16:12:03Z

@@ Line 1,419: / Line 1,419: @@
 * <code>get_player_monster name_variable</code>
 * <code>set_monster_level name_variable,1</code>
 === set_monster_status ===

Jaskrendix at 06:03, 2 October 2024

2024-10-02T06:03:23Z

← Older revision		Revision as of 06:03, 2 October 2024
Line 537:		Line 537:

	'''Examples'''		'''Examples'''
	* <code>camera_position ~~infected~~,~~npc_maple~~</code>		* <code>camera_position 6,9</code>
			* <code>camera_position 6,9,free_roaming</code>

	=== change_bg ===		=== change_bg ===