What a trigger does

A trigger does whatever its sections hold, all at once, each time it finds its line. Leave a part empty and it does not do that.

Show it

What happens to the line itself.

Colour and Background: tick to colour what the trigger found, then click the swatch to choose the colour.
Colour the whole line, not only the words: the colours go on every word of the line.
Hide the line: the line is not shown. Its sound, banner and notification still come.
Write instead: what the trigger found is written as these words. The rest of the line stays. $1, $2 put in what a pattern’s groups caught: $2 to $1: "$3" turns a long line of speech into a short one.
Move to: a line goes to another window by a stream rule, not a trigger; the link opens the Streams page.

Tell me

How the trigger gets your attention.

Sound: a sound file’s name, a .wav, .mp3, .ogg or .flac in the sounds folder in Hydra’s data folder. The file name alone: ding.wav.
Volume: how loud, a percent of the window’s volume. It shows once a sound is named.
Banner: a banner under the play window’s top bar for a few seconds: The line, or These words of your own.
Notification: a notification from your computer, as other programs send: the line, or your own words.
Push to phone: a banner on each phone paired with Hydra in the HydraFE app, even with the app closed: the line, or your own words. Tapping it opens HydraFE on that character (Push to phone). .push lists the phones, .push test sends one to try it, and .push forget <name> stops one.
Speech: your computer’s voice reads the line, or your own words.
Rumble: the game controller rumbles: short, long, double, or a pattern of your own from the controller’s file.
Picture: a picture placed in the story after the line: an https:// address, or a file in the pictures folder set on the Hydra’s General page of Settings.

Several characters hearing the same line within a second, a shout in a room they share, make one sound, one notification and one voice, not one each.

Do something

What the trigger does beyond the line.

Send

Game commands, one a line, sent as if you typed them. A pattern’s $1 can fill a command’s words: target $1. Some care is built in:

$1 fills a command’s words, never the command itself.
Only game commands: never Hydra’s own or Lich’s.
Only once the character is in the game and ready: nothing while it logs in or reconnects.
The trigger’s Cooldown is the pace of its sends: at 0 it sends for every line it finds.
A send that an import brought waits until you read it and press Approve this send.

Timer

A countdown of your own, which the Timers widget shows.

Timer: its name. The words the trigger finds start it. .timer <name> starts it too.
Default duration: how long it runs.
Up message says: when the line says how long, $1 with a pattern’s first group, times a number: $1 times 5 for a line that counts rounds of five seconds. The default duration is used when the line says none.
Down message: words that end it early, such as a spell’s message that it has worn off.
Shows in: which list it counts down in, Active spells, Buffs, Debuffs, Cooldowns, or Custom. The Timers widget gathers every list.

Flag

A flag is a name a trigger sets and other triggers read: it shows nowhere. Under When, the condition flag holds while it is set.

Name it, and choose how long it lasts: set for some seconds, or 0 until something clears it. Tick clears it to make a trigger that puts the flag down instead.

A status is like a flag, but it shows: the Custom statuses widget lights it while it is set, and under When the condition indicator reads it as it reads the game’s own. Set and clear it as you would a flag.

Cooldown

Under the sections, when the trigger has something to hold back: Cooldown is how long before its sound, banner, notification, push, speech, rumble, picture, timer and commands come again. 3 seconds unless you change it. A line the trigger finds while it cools down is still coloured, hidden, rewritten and moved, and its flag and status are still set.

Keyboard shortcuts

Hydra