3.0 Aliases

Aliases are simply convenient shortcuts you can make for more complex in-game actions. They are often used during in-game combat to perform actions more quickly. Aliases can also be combined with certain changeable elements (known as variables) to make even more versatile shortcuts.

Here are some examples to illustrate the concept of aliases:

Typing "dh" instead of the longer "DRINK HEALTH" command.
Using "t jeremy" to designate Jeremy as your in-game target.
Creating a safeguard for a command you might accidentally activate, such as "GIVE" or "QUIT".
Setting up a shortcut like "cg" to perform the longer command of "consecrate ground with holysymbol".

How to Create a New Alias

Aliases are categorized as a type of reflex. This means they are quick actions performed with ease. To create and manage aliases, you'll need to go to the "Reflexes" settings option, which is located in the settings window.

Here’s how you can access this tab:

Look for a gear icon on the main game screen, situated in the lower right corner.
Click on this gear icon to open the settings window.
Within the settings window, find and click on the "Reflexes" button.
Here, you will be able to create new aliases and manage existing ones for more efficient gameplay.

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

Creating a new alias is simple. Begin by accessing the settings window. You can do this by clicking on the gear icon, typically located in the lower right corner of your game screen. When you click on this icon, you will be presented with the settings window.

Select the "Reflexes" button and a new window will appear in your browser, where you'll be able to manage and create aliases as well as many other settings.

Step 2. Click the 'Add New' Button and select 'Add an Alias'.

Within the settings window, you will see options to create different types of reflexes. For our purpose, we want to create an alias.

Here are the steps to create an alias:

Look for the "Add New" button, which is usually located in the left section of the window.
Click on this "Add New" button.
A menu will appear. From this menu, select "Add an Alias".

By doing this, you have created a new alias, but it doesn't have any instructions yet – it's undefined. Next, you'll need to define what this alias should do.

Step 3. Aliases Options.

In the alias creation area, you will find three main sections for setting up your aliases. They are not clearly labeled, but can be identified as "Enabled", "Matching", and "Actions".

Enabled: This section has a checkbox that you can toggle on or off. When this checkbox is ticked, it means that the alias is turned on and ready to be used. If it's not ticked, the alias is turned off and the system won't use it.
Matching: Here, you will assign a command to your alias, which is typically a shorter version of a longer command. For example, you could use 'arl' as an alias for 'apply restoration to legs'. This short command is what you will type into the game to trigger the alias.
Actions: This section defines the outcome that takes place when the alias command is entered into the game. For instance, if you have set 'arl' as your alias for 'apply restoration to legs', typing 'arl' into the game will execute the full command 'apply restoration to legs'.

These three sections work together to create a streamlined experience by allowing you to use shorter commands for actions you perform frequently in the game.

Understanding Matching Options

The "Matching" section helps you set up the command for the alias you're creating. It offers five different settings.

Match Text That

This option defines how your alias text will be recognized. There are three possibilities:

Begins with: The system will only recognize a command that starts with your alias text.
Exact match: The system will only recognize an input that is identical to your alias text.
Matches regex: This advanced option allows the system to match regular expression patterns.

Typically, the 'Begins with' option is the most useful for most situations.

Value

This mandatory field is where you input the alias text. You can use anything to create your alias, but it's usually best to keep it short and memorable. For instance, you might use 'sh' and later assign it an action like 'say hello world!'.

The Alias Text field interacts closely with the 'Matching Type' option, as explained above.

Whole Words Only

When this checkbox is ticked, the alias will only recognize whole words.

Consider an alias text like 'sh':

If you type 'sha', it will NOT be recognized as your alias. However, if you type 'sh a', it will be recognized.

If you uncheck the 'Whole words only' box, then 'sha' would be recognized as the alias.

In most cases, it's best to keep 'Whole words only' checked. Note that words are considered whole if they are separated by spaces, and any punctuation is considered part of the word.

Match Case

With this checkbox ticked, the alias will be case-sensitive.

For instance, if this option is enabled, 'sh' would not be seen as the same as 'SH'.

Alias Name

(Optional) This is simply a label for your alias. It helps identify the alias in your list of reflexes. It isn't necessary for the operation of the alias and doesn't impact its functionality.

Understanding Action Options

After determining the text for your alias, you can associate it with one action or a sequence of multiple actions. Actions will execute in the order they are listed.

The image above presents a simple example of three separate actions that occur when an alias command is input into the game.

Simplified Scripting

The Nexus client supports twelve different simplified scripting actions that can be used in aliases. In many cases, an immediate return of a command is ideal. However, the Nexus client also allows you to cycle through commands, use if statements, wait commands, highlight text, and much more.

Detailed explanations and examples of these options can be found here: simplified scripting.

Below is a simple alias example that automatically opens a door blocking your path when trying to move south.

The first selected action is "send a command", which sends the text "south" to the game as if you typed it into the command line. Next, there's the "wait for" action, which sets up a temporary trigger that waits for the phrase "There is a door in the way." When this message appears, we send the next action, which is once again "send a command". This time, we send two commands: one to open the door, and another to move south.

A more advanced option would be overriding the basic SAY command to alternate between different speech patterns.

To break down this alias: In the first "talk" alias, we set a local variable named "talk_counter" that increments by 1 every time we talk. Depending on the value of that variable, we choose a different style of talking to send to the client, like (Sloshing around) or (Waving his hands). The labels direct the If blocks based on the "talk_counter" value. After reaching the final If result, the script simply continues to the next line without going to a label, setting "talk_counter" back to 0 to restart the loop. Note the use of the "Stop" command to prevent the script from continuing after reaching the end of a specific label.

However, this setup could cause issues if you attempt to "SAY TO" someone. To resolve this, we create a second alias to handle "SAY TO" input.

In this second alias, we set two local variables and change the alias to "sayto", enabling us to address the specific scenario of speaking directly to a person, rather than general speaking.

Advanced Scripting

There are two main advanced scripting options: Call function and Execute script. Both of these options allow for the use of JavaScript. To learn more, you can find information on functions here and on JavaScript here.

Expansions

Aliases support expansions, which allow you to add on-the-spot modifications to the command you send to the game.

For example, let's say you want to make an alias that picks up an item and puts it into your pack, called pp. To do this, you can simply make an alias with pp as the alias text, and two actions (use Add Action to add the second one), get @suffix and put @suffix in pack. The 'suffix' in this case is anything that comes after the alias in your command.

For both actions, disable the include prefix and suffix option, and you are done. See Put Pack Alias.

The available expansions are:

@match - the matched text
@suffix - anything coming after the matched text
@prefix - anything coming in front of the matched text; this only makes sense for regular expressions

Tip: You can use @line to send the original command along with the aliased commands - this is useful if you want to perform additional actions when sending a particular command, instead of replacing it.

3.0 Aliases

From Iron Realms Nexus Client Documentation

Revision as of 05:34, 21 June 2023 by Jeremy (talk | contribs) (→‎Action Options Explained)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

How to Create a New Alias

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