Actions

A list of all actions with examples.

Generator Actions

Keep Stage

Stay on the current stage when a generator block is mined. (Same behavior as if idle was true)

on-break:
  do: keepStage   # Only works with on-break

Previous Stage

Set the generator to the previous stage.

  do: previousStage

Next Stage

Set the generator to the next stage.

do: nextStage

Set Stage

Set the generator to a specific stage.

do: setStage 1

Damage Generator

Decrease the health of the current generator stage.

do: damageGenerator 1-3   # Do 1 to 3 damage

do: damageGenerator   # Leave empty to use config.yml powerful damage options
                      # i.e. tool type, efficiency, ect..

Server Actions

Broadcast

Sends a chat message to all players on the server. Supports placeholders and color codes.

do: broadcast <This is a broadcast message>

Lightning

Strikes lightning at a specific coordinate in a given world.

Optional: world, doDamage

do: lightning world=world_name x=0 y=0 z=0 doDamage=true

Console Command

Runs a command from the server console.

do: consoleCommand <say Hello World!>

Drop Item

Drops a specific item at a given coordinate.

Optional: world

do: dropItem dirt world=world_name x=0 y=0 z=0

Drop Exp

Drops specific exp at the given coordinate. Supports amount (fixed, ranged, multi).

Optional: world, orbs

do: dropExp 100 orbs=100 world=world_name x=0 y=0 z=0

do: dropExp 10-100 x=0 y=0 z=0

do: dropExp 50;100 orbs=1-10 x=0 y=0 z=0

Spawn Particle

Spawns a particle effect at a specific coordinate.

Optional: world

do: spawnParticle particle_name world=world_name x=0 y=0 z=0

Play Sound

Plays a sound at a specific coordinate.

Optional: world

do: playSound sound_name world=world_name x=0 y=0 z=0

---

Function Actions

Stop

Ends function execution completely when called from anywhere.

function:
  do:
    - stop
    - chatMessage <This message will NOT be sent!>

Even when used inside a global function:

# Global Function
giveDiamondIfFirstJoin:
  if-not: hasPlayedBefore
  do:
    - chatMessage <This is the first time playing huh? Have a diamond!>
    - giveItem diamond 
    - stop

on-break:
  - giveDiamondIfFirstJoin
  - do: chatMessage <This message will NOT be sent!>

Return

Ends current function execution. It will only have effect on the function it is used in.

function:
  do:
    - return
    - chatMessage <This message will NOT be sent!>

When used inside a global function:

# Global Function
giveDiamondIfFirstJoin:
  if-not: hasPlayedBefore
  do:
    - chatMessage <This is the first time playing huh? Have a diamond!>
    - giveItem diamond 
    - return

on-break:
  - giveDiamondIfFirstJoin
  - do: chatMessage <This message will be sent!>

Goto

Go to a specific function in a multi function. This should be rarely need to be used, I leave for very few cases when necessary.

DANGEROUS: if used improperly it will cause a StackOverflowError and crash your server.

function:
  # Function 1
  - if: hasPermission orestack.admin
    do: goto 3   # Skip money check in function 2 if player is an admin
    
  # Function 2  
  - if-not: hasMoney 1000
    do:
      - sendChat <You don't have the money to perform this action>
      - return
  
  # Function 3
  - do: sendChat <You have 1000$ or you are an admin!>

Event Actions

Cancel Event

Stops the event that triggered the function from continuing.

Supported by: on-break

# Triggered by GeneratorMineEvent
on-break:   
  do: cancelEvent # The generator stays on the current stage and items/exp are not dropped

Set Cancelled

Manually sets whether the event is cancelled (true or false).

Supported by: on-break

on-break:
  do: setCancelled true

---

Block Actions

Strike Block

Creates a lightning effect on the block that was interacted with.

do: lightningAtBlock

Drop Item at Block

Drops an item from the block towards the player or on top of the block.

do: dropItemAtBlock dirt

# Specify the amount
do: dropItemAtBlock lapis_lazuli amount=2-3

# Do fortune drop if the player's tool has the enchant
do: dropItemAtBlock diamond doFortune=true

# Combined
do: dropItemAtBlock redstone amount=1-4 doFortune=true

Spawn Particle at Block

Spawns a particle effect at the block. Particle effects are located inside effects/particles.

do: spawnParticleAtBlock particle_name 

Play Sound at Block

Plays a sound effect at the block. Sound effects are located inside effects/sounds.

do: playSoundAtBlock sound_name

---

Player Actions

Drop Item at Player

Drops an item at the player's location.

Optional: amount, doFortune

do: dropItemAtPlayer item_name amount=1-3 doFortune=true

Spawn Particle at Player

Spawns a particle effect at the player. Particle effects are located inside effects/particles.

do: spawnParticleAtPlayer particle_name

Play Sound at Player

Plays a sound for the player. Sound effects are located inside effects/sounds.

do: playSoundAtPlayer sound_name

Give Exp

Gives a specific amount of experience points to the player.

do: giveExp 10-20

Give Flag

Assigns a flag to the player. (Flags are not saved when the player quits the server)

do: giveFlag my_custom_flag

Give Item

Gives a material or item to the player. (If it cannot fit in the inventory it will drop on the ground)

do: giveItem diamond amount=1-3 doFortune=true

Give Money

Gives a specific amount of money to the player. (Requires Vault and economy plugin installed)

do: giveMoney 100
do: giveMoney 10-100
do: giveMoney 10;20;30

Take Exp

Removes a specific amount of experience points from the player.

do: takeExp 10
do: takeExp 10-100
do: takeExp 10;20;30

Take Flag

Removes a flag from the player.

do: takeFlag my_custom_flag

Take Item

Removes a specific item from the player's inventory.

do: takeItem diamond:5   # removes 5 diamons
do: takeItem item_name:3

Take Money

Removes a specific amount of money from the player.

do: takeMoney 10
do: takeMoney 10-100
do: takeMoney 10;20;30

Set Exp

Sets the player's experience points to a specific value.

do: setExp 10
do: setExp 10-100
do: setExp 10;20;30

Heal

Restores a specific amount of health to the player.

do: heal            # default amount is 20
do: heal 10         # 10
do: heal 10-100     # 10 to 100
do: heal 10;20;30   # 10, 20 or 30

Damage

Deals a specific amount of damage to the player.

do: damage            # default amount is 2
do: damage 10         # 10
do: damage 10-100     # 10 to 100
do: damage 10;20;30   # 10, 20 or 30

Command

Runs a command as the player.

do: command <warp spawn>

Chat Message

Sends a chat message to the player.

do: chatMessage <Hello, this is a chat message>

Message

Sends a custom message to the player. Messages are found inside messages folder.

do: message message_name

Send Chat

Sends a chat message to the player. (This is the same as chatMessage)

do: sendChat <This is a chat message!>

Send Title

Sends a title message to the player.

do: sendTitle <This is a title message!> <subtitle=This is the subtitle> fadeIn=10 stay=70 fadeOut=20

Send Actionbar

Sends an actionbar message to the player.

do: sendActionbar <This is an actionbar message!>

Send Hologram

Sends a hologram message to the player.

Optional: offsetX, offsetY, offsetZ, rangeX, rangeY, rangeZ

do: sendHologram <This is a hologram message!> duration=60 rangeX=1 rangeY=1 rangeZ=1

Strike Player

Creates a lightning effect on the player.

Optional: doDamage

do: strikePlayer doDamage=true

Set Flight

Enables or disables flight for the player.

do: setFlight true
do: setFlight false

Teleport

Teleports the player to a specific coordinate and rotation.

Open Ender Chest

Opens the player's ender chest.

do: openEnderChest

Damage Tool

Damage the player's main hand tool. Compatible with unbreaking enchant.

do: damageTool            # Default amount is 1
do: damageTool 3          # 3
do: damageTool 1-3        # 1 to 3
do: damageTool 1;10;100   # 1, 10 or 100