Actions

Difference between revisions of "Triggers"

From Iron Realms Nexus Client Documentation

Line 59: Line 59:
* Exact match: Will only match a line that matches exactly like your trigger text.
* Exact match: Will only match a line that matches exactly like your trigger text.
* Regular expression: This will match any regular expression patterns. This is advanced, but good to learn.  
* Regular expression: This will match any regular expression patterns. This is advanced, but good to learn.  
** Examples for matching the text: You have recovered balance.
*** Contains: have recovered balance
*** Begins with: You have recovered
*** Exact match: recovered balance.
*** Regular expression: You have recovered (\w+).
** Regular Expression Help:
*** http://www.w3schools.com/js/js_regexp.asp
*** http://www.regular-expressions.info/


'''Whole Words Only:''' If this box is checked, the trigger will only check whole words. For example:
'''Whole Words Only:''' If this box is checked, the trigger will only check whole words. For example:

Revision as of 16:07, 29 June 2015

Triggers are used to automatically send commands to the game when certain lines of text are received from the game.


How to Create a New Trigger

Triggers are settings created by you to automatically send commands back to the game when you receive specific text from the game. For example, you may want to automatically attack a rat whenever you see one enter the room you are in.

On this page we will demonstrate how to create a new trigger and explain the various settings.

You can then follow some of the example links at the bottom of the page to help get a better understanding.

Step 1. Open the settings page and click the 'Reflexes' tab.

Reflexes is a term for settings you used to help automate your game experience. In order to create a new trigger you must first click on the 'Reflexes' tab.

Tab-reflexes.png


Step 2. Click the 'Add' Button and select 'Add a Trigger'.

There are several different types of reflexes. In this case we want to create a new trigger. In order to do this, click on the 'Add' button and then click on 'Add a Trigger'.

Trigger-create.png


Step 3. Options for Triggers.

There are two main parts of a trigger. Matching and Actions.

Matching is used to figure out what text you would like to respond to.

Actions are used tell the game what you want to happen when that text is matched.

Trigger-blank.png

Matching Options

The matching part of a trigger is used to tell them game what text you want to react to.

Trigger-matching.png

There are five options for matching text.

Trigger Text: In this field you put the text you want to match.

Examples:

  • You have recovered balance.
  • You have recovered
  • recovered balance.
  • You have recovered balance.

You can match much more complicated text then just text. You can set up triggers to look for text that may not always be the same using regular expressions. This is more complicated and you can check the examples at the bottom of the page for how to do this.

Trigger Name: (Optional) The name of the trigger. The name is an identifier that will show up in your list of triggers. It is not required for your trigger and has nothing to do with the actual operation of the trigger.

Matching Type: There are four options.

  • Contains: This will match any line that has your trigger text in it.
  • Begins with: Will only match a line that starts with your trigger text in it.
  • Exact match: Will only match a line that matches exactly like your trigger text.
  • Regular expression: This will match any regular expression patterns. This is advanced, but good to learn.

Whole Words Only: If this box is checked, the trigger will only check whole words. For example:

Case Sensitive: The case has to be the same when matching a trigger. For example, if this box is checked and your trigger text is 'You have recovered balance' then the text 'You HAVE reCOvered balance' will not match. However, if you uncheck the this option, the case will not matter.

Action Options

Trigger-actions.png

Examples

Balance Recovery Attack: This is an example of a trigger to automatically attack a target when you recover balance.