Bukkit

Triggers

Triggers are are a way to set up a reaction to some action or event in the game. If a player dies, that is an event or if a player clicks on a certain block that is an action and we can setup a reaction to these with triggers.

Triggers are set with in-game commands like /vtclick and /vtevent you add lines of script to the trigger with these same commands. Triggers are saved in the trigger files located in the /plugins/VariableTriggers/ folder. Each trigger type has its own file as in WalkTriggers.yml and EventTriggers.yml and so on..

Below is a list of the different trigger types.

Location Triggers

Triggers that are based on a block Location

To set a click trigger or add script to an existing click trigger you use /vtclick [Line of script]
To set a walk trigger or add script to an existing walk trigger you use /vtwalk [Line of script]

Command Triggers

Create triggers that run script when a player types a /command. You can make some extra things happen when players type commands like /heal or you can create your very own commands like /foobar or /setquest
See In-Game Commands for a list of commands to create the triggers.

Area Triggers

You can set two locations to create an area cube and set triggers on it.

To set an area trigger you first need to define an area. You do this by typing /vt setarea and then use the wand to Left click for possition 1 and Right click for possition 2. Once the two locations are set type
/vt definearea [AreaName]

To set a trigger on an area or add script to an existing trigger you use
/vtarea [AreaName] [Enter|Exit] [Line of script]

A few words about areas and how they work and remember areas ar 3D cubes so you must also set the height.

Here are the commands to create Area triggers.

Event Triggers

To set an event trigger or add script to an existing event you use
/vtevent [EventName] [Line of script]

  Inventory:
    CoolDown: 0
    Script:
    - '@IF s <inventorytitle> ?= TELEPORTS'
    - '    @SWITCH i <clickedslot>'
    - '        @CASE 0'
    - '            @CMDOP spawn'
    - '        @CASE 1'
    - '            @CMDOP warp <playername> pvp'
    - '        @CASE 2'
    - '            @CMDOP warp <playername> minigames'
    - '    @ENDSWITCH'
    - '@ENDIF'

  teleportInventory:
    - 'cancelled: true'
    - 'title: TELEPORTS'
    - 'slots: 9'
    - 'item: wool, meta: 5, amount: 1, name: Spawn, lore: Teleport % &a&ospawn, enchant:durability, slot: 0'
    - 'item: wool, meta: 6, amount: 1, name: PVP, lore: Teleport % &4&opvp, enchant:durability, slot: 1'
    - 'item: wool, meta: 7, amount: 1, name: Minigames, lore: Teleport % &3&ominigames, enchant:durability, slot: 2'

BlockBreak and BlockPlaced Events are not called if any other block protection has cancelled it. This should be true with most severs but depending on the plugins you use it may still be cancelled after the script is called so if you experience your scripts running even though the event was cancelled you need to test for this in your script if you only want your script to run if the event was not cancelled. Since VariableTriggers Script Interpreter runs on its own thread it starts running the script faster than the other plugins have a chance to cancel the event so start your script for these two events with a pause and test like so:

For BlockBreak:

- '// Pause 1/4 second'
- '@PAUSE 0.25'
- '// Test to see if block was is still there'
- '@IF <isblocktype:<triggerloc>:<blocktype>> = false'
- '// Break was succesfull so continue with script'

For BlockPlaced:

- '// Pause 1/4 second'
- '@PAUSE 0.25'
- '// Test to see if block was is still there'
- '@IF <isblocktype:<triggerloc>:<blocktype>> = true'
- '// Place was succesfull so continue with script'