Macro: Difference between revisions

From HorizonXI Wiki
m (→‎Available commands: added # for <wait> and the definition.)
 
(3 intermediate revisions by one other user not shown)
Line 12: Line 12:


==Available commands==
==Available commands==
Each macro starts with a command to determine what type of command you will issue. The most common are:
:''See [[Commands]] for a complete list of commands that can be used.''
:''See [[Commands]] for a complete list of commands that can be used.''
 
{| width="60%" cellpadding="2" cellspacing="2"
Each macro starts with a command to determine what type of command you will issue. The most common are:
:{| width="60%" cellpadding="2" cellspacing="2"
! style="background:#ffdead;" width="25%" | Command
! style="background:#ffdead;" width="25%" | Command
! style="background:#ffdead;" width="75%" | Definition
! style="background:#ffdead;" width="75%" | Definition
Line 67: Line 66:
| Displays text viewable only by the Macro user.
| Displays text viewable only by the Macro user.
|- style="background:#e3e6ff;"  valign="top"
|- style="background:#e3e6ff;"  valign="top"
| '''[[Command/wait|/wait]] #'''
| '''[[Command/wait|/wait ]] #'''
| Used in between other commands in macros to set a delay before moving onto the next line (where # = number of seconds desired).
| Used in between other commands in macros to set a delay before moving onto the next line (where # = number of seconds desired).
|- style="background:#e3e6ff;"  valign="top"
|- style="background:#e3e6ff;"  valign="top"
| '''[[Command/wait|<wait>]]'''
| '''[[Command/wait|<wait #>]]'''
| Used on same line at the end of other commands in macros to set a delay before moving onto the next line.
| Used on same line at the end of other commands in macros to set a delay before moving onto the next line (where # = number of seconds desired).
|- style="background:#e3e6ff;"  valign="top"
|- style="background:#e3e6ff;"  valign="top"
| '''[[Command/seacom|/seacom]]'''
| '''[[Command/seacom|/seacom]]'''
Line 84: Line 83:


==Selecting a Target (Pronouns)==
==Selecting a Target (Pronouns)==
Several commands require you to specify a target as a parameter to your action (such as /lockon, /target, /magic, and /range), you can use the following placeholders to select targets:


Several commands require you to specify a target as a parameter to your action (such as /lockon, /target, /magic, and /range), you can use the following placeholders to select targets:
{| width="50%" cellpadding="2" cellspacing="2"
! style="background:#ffdead;" width="25%" | Pronoun
! style="background:#ffdead;" width="75%" | Target
|- style="background:#e3e6ff;"  valign="top"
| '''<me>'''
| Activates automatically on your character
|- style="background:#e3e6ff;"  valign="top"
| '''<t>'''
| Activates on current selected target. If a command is missing a target, or the target is unrecognizable, its target is assumed to be the player's current target.
|- style="background:#e3e6ff;"  valign="top"
| '''<bt>'''
| Activates on last monster claimed by party (will not work on alliance targets).
|- style="background:#e3e6ff;"  valign="top"
| '''<ht>'''
| Activates on [[Call for Help]] target
|- style="background:#e3e6ff;"  valign="top"
| '''<ft>'''
| Activates on [[Adventuring Fellow Guide|NPC Fellow]]
|- style="background:#e3e6ff;"  valign="top"
| '''<st>'''
| Activates after toggling between available targets
|- style="background:#e3e6ff;"  valign="top"
| '''<stpc>'''
| Activates after toggling between available player characters
|- style="background:#e3e6ff;"  valign="top"
| '''<stpt>'''
| Activates after toggling between available party members
|- style="background:#e3e6ff;"  valign="top"
| '''<stal>'''
| Activates after toggling between available alliance members
|- style="background:#e3e6ff;"  valign="top"
| '''<stnpc>'''
| Activates after toggling between available [[NPC]]s
|- style="background:#e3e6ff;"  valign="top"
| '''<lastst>'''
| Activates on last target acquired from <stpc>, <stnpc>, <stpt>, or <stal>
|- style="background:#e3e6ff;"  valign="top"
| '''<r>'''
| Activates on last player to /tell you (similar to /reply)
|- style="background:#e3e6ff;"  valign="top"
| '''<pet>'''
| Activates on your active [[pet]]
|- style="background:#e3e6ff;"  valign="top"
| '''<scan>'''
| Your [[widescan]] target
|}


{{:Macros/Placeholders}}
Targeting specific party and alliance members:
{| width="50%" cellpadding="2" cellspacing="2"
! style="background:#ffdead;" width="25%" | Pronoun
! style="background:#ffdead;" width="75%" | Target
|- style="background:#e3e6ff;"  valign="top"
| '''<p0>'''
| Targets self
|- style="background:#e3e6ff;"  valign="top"
| '''<p1>''' ... '''<p5>'''
| Targets second party member, and so on to <p5>
|- style="background:#e3e6ff;"  valign="top"
| '''<a10>''' ... '''<a15>'''
| Targets top most alliance, first member, and so on to <a15>
|- style="background:#e3e6ff;"  valign="top"
| '''<a20>''' ... '''<a25>'''
| Targets second alliance, first member, and so on to to <a25>
|}


==Syntax==
==Syntax==
Line 95: Line 156:
**''Make sure as you are typing out a macro line you put the auto-translated format of whichever word first and then go back and add quotation marks to each side of the auto-translated phrase. As putting a quotation mark first and typing out the first couple of letters and pressing TAB will interfere.''
**''Make sure as you are typing out a macro line you put the auto-translated format of whichever word first and then go back and add quotation marks to each side of the auto-translated phrase. As putting a quotation mark first and typing out the first couple of letters and pressing TAB will interfere.''


:{| width="75%" cellpadding="2" cellspacing="2"
{| width="75%" cellpadding="2" cellspacing="2"
! style="background:#ffdead;" width="40%" | Syntax
! style="background:#ffdead;" width="40%" | Syntax
! style="background:#ffdead;" width="60%" | Example
! style="background:#ffdead;" width="60%" | Example
Line 194: Line 255:


==Macro Guides==
==Macro Guides==
* Need to add guides
* [[Beginner's Macro Guide]]
* [[Intermediate Macro Guide]]

Latest revision as of 23:40, 26 March 2024

A Macro is a shortcut to execute a sequence of one to six commands, each of which can be used to activate a Job Ability, start casting a spell, issue a pet command, change an item of equipment, put text to a chat channel, or perform some other action.

The execution is sequential, and can be interrupted by activating another macro during /wait commands, or by pressing the "Escape" key or the cancel button on a controller/gamepad during select target (for example, <st> or others) commands. A macro interrupted during its execution will not complete the command on which the interruption occurred, nor execute the remaining commands in the sequence.

Users are given 20 Books with 10 macro palettes each. Each palette consists of 2 rows of 10 macros each. Every character has its own, unique set of macro palettes, which are not shared with other characters on the same account. Macros are stored on the game client, not on the server.

Backing up Macros

To backup macros, make a copy of the "USER" folder. This can be found via the path HorizonXI > Game > SquareEnix > Final Fantasy XI > User .

Available commands

Each macro starts with a command to determine what type of command you will issue. The most common are:

See Commands for a complete list of commands that can be used.
Command Definition
/ja Job Ability
/magic or /ma Magic, Songs, or Ninjutsu
/ws Weapon Skill
/ra Performs a ranged attack on specified target.
/equip Equip an item.
/recast Displays recast time for Abilities or Spells.
/item Allows you to use item in inventory, or trade a single item to an NPC.
/pcmd Party command
/pet Pet commands
/p Party Chat
/l Linkshell Chat
/lockon Locks player's view and direction to current selected target.
/check Examines Player or Gauges the monster
/target Moves active pointer to target specified by targeting pronoun.
/targetnpc Targets closest NPC or monster (including player pets if /ignorepet command is not active).
/echo Displays text viewable only by the Macro user.
/wait # Used in between other commands in macros to set a delay before moving onto the next line (where # = number of seconds desired).
<wait #> Used on same line at the end of other commands in macros to set a delay before moving onto the next line (where # = number of seconds desired).
/seacom Allows users to create search comment macros.
/seacomup Allows user to set the category that a /seacom macro is inserted into.
/macro set #
/macro book #
Change to "#" macro line
Change to macro book "#"

Selecting a Target (Pronouns)

Several commands require you to specify a target as a parameter to your action (such as /lockon, /target, /magic, and /range), you can use the following placeholders to select targets:

Pronoun Target
<me> Activates automatically on your character
<t> Activates on current selected target. If a command is missing a target, or the target is unrecognizable, its target is assumed to be the player's current target.
<bt> Activates on last monster claimed by party (will not work on alliance targets).
<ht> Activates on Call for Help target
<ft> Activates on NPC Fellow
<st> Activates after toggling between available targets
<stpc> Activates after toggling between available player characters
<stpt> Activates after toggling between available party members
<stal> Activates after toggling between available alliance members
<stnpc> Activates after toggling between available NPCs
<lastst> Activates on last target acquired from <stpc>, <stnpc>, <stpt>, or <stal>
<r> Activates on last player to /tell you (similar to /reply)
<pet> Activates on your active pet
<scan> Your widescan target

Targeting specific party and alliance members:

Pronoun Target
<p0> Targets self
<p1> ... <p5> Targets second party member, and so on to <p5>
<a10> ... <a15> Targets top most alliance, first member, and so on to <a15>
<a20> ... <a25> Targets second alliance, first member, and so on to to <a25>

Syntax

When programming your macros, be sure to always include proper spelling, punctuation, and targets. Refer to the page for each command for more information about their usage and examples. Quotation marks are optional when referencing a single-word ability, weapon skill, spell, etc. (for instance, "/ja Benediction <me>" is a working macro).

  • You may also create macro command lines (such as the examples listed below) with words used in the Auto-Translator format which can cut down on time it takes (and make sure it is spelled correctly) to write out an ability, weaponskill, or items. All auto-translated words appear as {example}.
    • Make sure as you are typing out a macro line you put the auto-translated format of whichever word first and then go back and add quotation marks to each side of the auto-translated phrase. As putting a quotation mark first and typing out the first couple of letters and pressing TAB will interfere.
Syntax Example
/ja "Job Ability" <target> /ja "Benediction" <me>
/ja "Steal" <bt>
/ma "Spell Name" <target> /ma "Blizzard IV" <bt>
/ma "Curaga" <stpc>
/nin "Ninjutsu Name" <target>
/ma "Ninjutsu Name" <target>
/nin "Hojo: Ni" <bt>
/nin "Utsusemi: Ichi" <me>
/ma "Utsusemi: Ni" <me>
/so "Song Name" <target>
/ma "Song Name" <target>
/so "Army's Paeon III" <me>
/so "Horde Lullaby" <t>
/ma "Mage's Ballad" <me>
/ws "Weapon Skill Name" <target> /ws "Sturmwind" <bt>
/ws "Hexa Strike" <bt>
/range "[target name]" /ra <stnpc>
/shoot <bt>
/throw <stnpc>
/item "item" [target] /item "Rolanberry Pie" <me>
/item "Imperial Silver Piece" <t>
/equip <slot> "Gear" /equip ring1 "Zircon Ring"
/equip main "Ice Staff"
/equip main
/ta "Target Name or Pronoun" Example: /ta <bt>
/pcmd [subcommand] /pcmd add "Dudeman"
/pcmd leave
/pet [subcommand] /pet "Deploy" <t>
/pet "Deactivate" <me>

Other Placeholders

These are some additional placeholders which make using macros more helpful. These may be placed anywhere in a chat or echo line:

Syntax Definition
<hp> Your current hit points as a ratio of current HP over max HP.
<hpp> Your current hit points as a percentage.
<tp> Your current TP as a percentage.
<mp> Your current MP as a ratio of remaining MP over max MP.
<mpp> Your current MP as a percentage.
<pet> Your pet's name
<pethpp> Your pet's current HP as a percentage.
<petmpp> Will display the current MP of your pet or automaton as a percentage of its maximum value.
<pettp> Your pet's current TP as a percentage.
<fthpp> Your NPC Fellow's current HP as a percentage.
<call0> Sends out an audible signal and vibrate the controller of everyone in your party. May only be used with /party command.
<ncall0> Sends out an audible signal to everyone in your party. May only be used with the /party command.
<scall0> Sends out an audible signal to everyone in your party, but without the controller vibration. May only be used with the /party command.
<job> Displays your current job/subjob and their levels.
<mjob> Displays your current job level (without subjob).
<sjob> Displays your current subjob level (without main job).
<pos> Your current map coordinates. Will not work while under the effects of Charm (Status Effect).

Macro Guides