## The Triggers Pane

- General Information
- Menu Reference
- The Toolbar
- The Settings Dialog
  - Connection pane
  - Appearance pane
    - Colors tab
    - Fonts/Sizes tab
  - General pane
  - Macros pane
  - Triggers pane
  - Aliases pane
  - Channels pane

Triggers are actions Cantrip can take when it sees a particular bit of text - a "trigger" - come in from the server. This pane lets you create and name sets of triggers.

To create a trigger:

- Click on the "+" button to create a new `Untitled` trigger.

- Select the new trigger in the list.

- Type a new name for the trigger in the Trigger name field.

- Select Trigger On: from the Scripts pop-up menu. Then type the text you want Cantrip to watch for in the text field. Cantrip uses regular expressions in this field.

- If you want to use your trigger to replace some incoming text with your own, select Substitute: from the Scripts pop-up menu. Type the text you want to substitute when triggered into the text field; note that you can use backreferences to pull bits from your Trigger On regular expression. Then choose Substitute from the Modification pop-up menu.

- If you want your trigger to run a series of commands, select Script: from the Scripts pop-up menu, and type the command(s) into the text field. You can type `Option-Return` to enter multiple lines of text, allowing you to include multiple commands in the script.

- If you want your trigger to speak some text, select Spoken text: from the Scripts pop-up menu. Then type your spoken text into the text field; you can use backreferences to pull bits from your regular expression here as well. Finally, check the Speak with voice: checkbox, and pick the voice you want to use from the pop-up menu.

- In addition to the uses above, the Modification pop-up menu lets you have Cantrip play formatting tricks on the incoming text that matches your Trigger On: text; choose Highlight from the menu, then pick the formatting you want Cantrip to apply from the choices below.

- Choose Gag from the Modification menu to have Cantrip strip out the text you matched with Trigger On:.

- Finally, you can have Cantrip play a sound when a trigger is tripped. Check the Play sound named: checkbox, and pick the sound you want to use from the menu.

To delete a trigger, select it in the list of names, and click the "-" button. To turn it off temporarily, uncheck the checkbox for the trigger.

Return to Top