# Actions

List of all actions available to use in dungeon scripts.

# Chance

Every action has a Chance option that defines a chance for the action to execute. Defaults to 100.0 (always execute).

# Target

Some scripts have Target option to define action target. It accepts the following values:

GLOBAL - Performs an action globally.
ALL_PLAYERS - Performs an action per each dungeon player.
ALIVE_PLAYERS - Performs an action per each alive dungeon player.
EVENT_PLAYER - Performs an action for a player involved in the dungeon event.

# List

Adds specific task to the current dungeon's stage.

Type: add_task

Options:

TaskId - Task identifier (must present in the config of the current dungeon stage).
Replace - Whether to replace the current task with the same identifier.

Example:

Type: add_task
Chance: 100.0
TaskId: kill_mobs
Replace: false

Removes a task from the current dungeon's stage.

Type: remove_task

Options:

TaskId - Task identifier (must present in the config of the current dungeon stage).

Example:

Type: remove_task
Chance: 100.0
TaskId: kill_mobs

Marks dungeon as 'completed' or 'failed' and initializes end countdown.

Type: dungeon_end

Options:

Countdown - End countdown value (in seconds).
Completed - Whether dungeon is completed or not.

Example:

Type: dungeon_end
Chance: 100.0
Completed: true
Countdown: 10

Resets spot to it's initial state set in the config. All spots are auto-reset on dungeon end.

Type: reset_spot

Options:

SpotId - Spot identifier.

Example:

Type: reset_spot
Chance: 100.0
SpotId: gate

Revives dead players if they have extra lives and there is at least one alive player left in a dungeon.

Type: revive_players

Options:

Check_Death_Time - Whether to check player's death time or not.
Seconds_Since_Death - Min. and max. amount of seconds since player's death to revive. Use -1 for no min/max limit.

Example:

Type: revive_players
Chance: 100.0
Check_Death_Time: true
Seconds_Since_Death:
  Min: 30
  Max: 60

Runs listed commands globally or on specific player(s).

Type: run_command

Options:

Commands - List of commands.
Target - Command Target.

Placeholders:

%player_name% - Player name.
%player_display_name% - Player display name.
Variables placeholders.
PlaceholderAPI

Example:

Type: run_command
Chance: 100.0
Target: EVENT_PLAYER
Commands:
- eco give %player_name% 10
- heal %player_name%

Gives reward to specific player(s).

Type: give_reward

Options:

RewardId - Reward Identifier.
Target - Reward Target.
Instant - If set on true, gives reward directly in game. Otherwise, gives reward after leaving a dungeon (see settings below).
KeepOnDeath - Whether to keep this reward when dying in a dungeon. Works only if Instant is false.
KeepOnDefeat - Whether to keep this reward when failing a dungeon. Works only if Instant is false.

Example:

Type: give_reward
Chance: 100.0
RewardId: gold
Instant: false
KeepOnDeath: false
KeepOnDefeat: true
Target: ALIVE_PLAYERS

Generates loot in specific loot chest(s).

Type: generate_loot

Options:

Specific - If set on true, generates loot in specific chests only. Otherwise, generates loot in all loot chests.
LootChestIds - Loot Chest identifier(s) to generate loot in if Specific is set on true.

Example:

Type: generate_loot
Chance: 100.0
Specific: true
LootChestIds: chest1,chest2

Changes current dungeon level. If a dungeon is already on that level, nothing happens.

Type: set_level

Options:

LevelId - Level identifier.

Example:

Type: set_level
Chance: 100.0
LevelId: level_2

Changes current dungeon stage. If a dungeon is already on that stage, nothing happens.

Type: set_stage

Options:

StageId - Stage identifier.

Example:

Type: set_stage
Chance: 100.0
StageId: stage_2

Changes spot state. If a spot is already on that state, nothing happens.

Type: set_spot

Options:

SpotId - Spot identifier.
StateId - State identifier.

Example:

Type: set_spot
Chance: 100.0
SpotId: gate
StateId: open

Spawns mob(s) in the dungeon.

Type: spawn_mob

Options:

MobId - Mob Identifier.
SpawnerId - Spawner Identifier (must present in the dungeon config).
Amount - Scalable Amount of mobs to spawn.

Example:

Type: spawn_mob
Chance: 100.0
MobId: 'ada:zombie'
SpawnerId: spawner_1
Amount:
  Initial:
    Min: 1
    Max: 1
  Scalers:
    PLAYER_AMOUNT:
      Value: 1
      Type: PLAIN

Creates custom variable with defined name and initial value.

Type: create_var

Options:

Name - Variable name.
InitialValue - Initial variable value.
Limited - Whether to respect MinValue and MaxValue options.
MinValue - Min. possible variable value. Variable can't go below that value.
MaxValue - Max. possible variable value. Variable can't go above that value.

Example:

Type: create_var
Chance: 100.0
Name: zombies_amount
InitialValue: 1.0
Limited: true
MinValue: 1.0
MaxValue: 3.0

Modifies variable's value.

Type: modify_var

Options:

Variable - Name of the variable to modify value of.
Operation - Operation between the current variable value and the one from the Value setting. Values: PLUS, MINUS, MULTIPLY, DIVIDE.
Value - Value used for variable modification.

Example:

Type: modify_var
Chance: 100.0
Variable: zombies_amount
Operation: PLUS
Value: 1.0