Macro

From Final Fantasy XIV Online Wiki
Revision as of 20:15, 29 July 2022 by Deo (talk | contribs) (Some of my wording seems weird, would be nice if someone translated it into something more human.)
Jump to navigation Jump to search
See also Commands, Controller Guide and Macro Guides

Macros are user-defined sequences of commands that allow you to record multiple actions and trigger them with a single button or key stroke.

Creating Macros

  1. Open main menu
  2. Take the User Macro Option
  3. Select the macro number you wish to modify
  4. Name the Macro
  5. Select the Macro Icon
    • For more icon options, you can use /macroicon command and put it anywhere in the macro. Using /micon "Fast Blade" will set icon to the same icon used by this ability
  6. Add the script to the Macro
Hotbar macro guide

The Macro can then be dragged from the Macro UI to the Hotbar

Limitations

  • Each macro can contain maximum of 15 lines/commands
  • Macro cannot start another macro
  • Only one macro can run at a time. Starting macro will cancel currently running macro
  • There is no way to change macro's behavior depending on conditions. This means that branching is not possible
  • Character can have maximum of 100 individual macros
  • Entire account can have maximum of 100 shared macros - these are shared across all characters on account
  • Macros are inherently slower than human input while using <wait.X> function

Wait Function

You can use macro-specific subcommand <wait.X> to delay next command in macro.

Example: /ac "Careful Synthesis" <wait.3> - This command will execute action "Careful Synthesis" and delay next command in macro by 3 seconds. The delay starts when command is first started, not after specific action is executed.

Function can only use full seconds, use of decimal points is not possible. This means that if your recast timer(GCD) is standard 2.5 seconds, then you will waste 0.5 seconds doing nothing. Therefore using macros for combat purposes is extremely ineffective.

Typical Uses

Macros are most often used by Crafters. Using macros while crafting is much more comfortable, however you miss all the conditional benefits, like from material condition. High level crafting usually does not fit within 15 lines limitations, so you often need to use 2 or possibly more macros for single craft.

Another use is more comfortable way to change settings. It is possible to control volume, turn on/off/limit battle effects display, change job while simultaneously changing HUD layout and all of that without needlessly navigating through numerous menus.

List of Commands

This section is largely incomplete and is in need of detailing.

Text Commands

Entering a text command starting with the / (forward slash) key allows players to change equipment, use abilities, perform emotes and various other actions. Additional directions such as subcommands and placeholders can be added to commands for even greater customization, such as specifying targets, toggling functions on and off, and so on. The additional directions should follow the main command, separated by a space.

Chat

Command Shorthand Help
/say [mes.] /s Sends a message to all PCs within a small radius.
The message will not be displayed if a PC has their [Say] chat filter turned on.
Typing /say or /s without a message switches the default chat mode to [Say].
/shout [mes.] /sh .
/tell[PC_name] [mes.] /t Sends a message to a specific PC within the same World.
This message cannot be seen by any other PCs.
Typing /tell or /t [PC_name] without a message switches the default chat mode to [Tell].
/party [mes.] /p Sends a message to all members of your current party, regardless of their location.
Typing /party or /p without a message switches the default chat mode to [Party].
/linkshell [mes.] /l Sends a message to all members of your active linkshell, regardless of their location.
Typing /linkshell or /l without a message switches the default chat mode to [Linkshell].
/echo [mes.] /e Displays a message that only you can see.
/chatmode [chat mode] /cm Set the default chat mode.

>>Example:
/chatmode party
(Changes default chat mode to party chat.)
The default mode will be deactivated after a single message if it is set to Shout.
When setting the default mode to Tell, you are still required to enter the recipient PC's name.


If no chat mode is specified, the current default setting will be displayed.

Actions

Command Shorthand Help
/action [action name] /ac Uses an action on a specified target. This cannot be used with actions you have not yet learned, or when restricted by other factors.
/petaction [action name] /pac Uses a pet action on the specified PC. Uses current target when not specified. This cannot be used with pet actions you have not yet learned, or when restricted by other factors.

e.g. /petaction Obey

/companionaction [action name] /cac ses a companion action. The target of companion actions cannot be specified. This cannot be used with companion actions you have not yet learned, or when restricted by other factors.

e.g. /companionaction Attacker Stance

/macroicon [action name] /micon Changes icon with ability name and displays the cooldown spiral.
/macroicon [action name][Pet name] /micon Changes icon with Pet ability name and displays the cooldown spiral.
/recast [action name] none Displays time remaining until the specified action can be used again.
/actionerror [toggle] /aerror Disables, or enabled action errors, useful for preventing messaging on macros that are intended to fallback.
Value Description
Options
On Enable action error messages
Off Disable action error messages
/equipaction [slot] [action name] /eaction Equips an action to a specified slot.


If an action name is omitted, the action currently equipped to that slot will be removed. Basic class actions cannot be removed. Slots are designated by the numbers 1–30.

/actionqueue [subcommand] /aq Toggle the priority input feature for actions.

Displays whether priority input is enabled or disabled when no subcommand is specified.

Value Description
Subcommands
On Enable priority input
Off Disable priority input
/actioncancel [subcommand] /acan Enable cancelling of actions by selecting them again from the action bar while they are being cast or channeled.

Toggles between on and off when no subcommand is specified.

Value Description
Subcommands
On Enable cancelling via the action bar.
Off Disable cancelling via the action bar.

Targeting

Command Shorthand Help
/targetmode [subcommand] /tmode Toggle between targeting modes.
Value Description
Subcommands
a Activate targeting mode A. Use up and down to target party members, and left and right to cycle targets based on current target filter.
b Activate targeting mode B. Use up and down to select a target filer, and left and right to cycle targets.
c Activate targeting mode C. Use up and down to target party members, and left and right to cycle all targets.
/battletargetmode [subcommand] /btmode Toggle targeting mode only for enemies that are engaged. Toggle on and off when no subcommand is specified.
Value Description
Subcommands
On Activate targeting mode.
Off Disable targeting mode.
/directtarget [subcommand] /dtar Toggle direct targeting on. Press accept/confirm to select the nearest target, regardless of filters. Toggle between on and off when no subcommand is specified.
Value Description
Subcommands
On Toggle direct targeting on. Press Accept/Confirm to select the nearest target, regardless of target filters.
Off Toggle direct targeting off.
/targetpc none Targets the closest PC within a certain radius.
/targetnpc none Targets the closest NPC or enemy within a certain radius.
/targetenemy /tenemy Targets the closest enemy
/battletarget /bt Targets the closest engaged target
/lockon none Locks on to the target. Enter the command again to turn lock off.
/autolockon [subcommands] /autolock Automatically lock onto targets. Toggle between enabled and disabled modes when no subcommand is specified.
Value Description
Subcommands
On Enable automatic target lock.
Off Disable automatic targtet lock.
/assist /as Targets the target of a PC specified by a ‹t› or ‹p#› macro.
/subtarget [subcommand] /st Toggles subtargeting when executing commands directly from the action bar. Toggle between on and off when no command is specified.
Value Description
Subcommands
On Enable subtargeting.
Off Disable subtargeting.
/facetarget /ft When executed, the character will immediately turn to face the main target. If the character is in motion, the character will come to an immediate halt.

Equipment

Command Shorthand Help
/display[slot] [subcommand] none Toggle the display of gear in the head or main hand slots.

Gear Slots:

  • main (valid in passive mode only)
  • head
Value Description
Subcommands
On Show the item equipped in the designated slot.
Off Hide the item equipped in the designated slot.
/job [subcommand] none Toggle the job associated with your current class. Toggle between off and on when no subcommand is specified.
Value Description
Subcommands
On Activate the associated job.
Off Deactivate the associated job.

Party

Command Shorthand Help
/partycmd [subcommand] /pcmd Executes various party commands.
Value Description
Subcommands
join Accept a party invite.
decline Decline a party invite.
add [name] Invite targeted PC to your party.
leave Leave your current party.
kick [name] Oust a PC from your party.
breakup Dissolve your current party.
/join none Accepts a party invite.
/decline none Declines a party invite.

UI Display

Command Shorthand Help
/actionbar [subcommand] /abar Toggle actionbar display method. Toggles between on and off when no subcommand is specified.
Value Description
Subcommands
on Always display actionbar.
off Display bar only when executing commands.
/actionbarhelp [subcommand] /abarhelp Display pop-up help text for action bars. Toggle between on and off when no subcommand is specified.
Value Description
Subcommands
on Display help text.
off Hide help text.
/targetcursor [subcommand] /tcursor Set the default position of the target cursor.
Value Description
Subcommands
a Set to central.
b Set to floating.
c Set to both central and floating.
/names [subcommand] none Turn all name displays on or off. Toggles between on and off when no subcommand is specified.
Value Description
Subcommands
on Turn names one.
off Turn names off.
/enemylevel [subcommand] /elevel Display levels below enemies' names. Toggles between off and on when no subcommand is specified.
Value Description
Subcommands
on Display enemy levels
off Hide enemy levels.
/enemyicon [subcommand] /eicon Display active and non-active icons for enemies. Toggles between off and on when no subcommand is specified.
Value Description
Subcommands
on Display active (red) and non-active (green) icons.
off Hide active (red) and non-active (green) icons.
/enmity [subcommand] /enm Display enemy enmity icons. Toggles between off and on when no subcommand is specified.
Value Description
Subcommands
on Display enmity icons next to enemy HP bars.
off Hide enmity icons.
/away [subcommand] none Change your online status to away. Toggles between off and on when no subcommand is specified.
Value Description
Subcommands
on Display away icon.
off Hide away icon.
/countdown [value] /count Initiate a countdown in seconds, starting at the designated value (up to 20 seconds).

Countdown length is 5 seconds when no value is specified. Words and numbers displayed will not appear in screenshots.

Menus

Command Shorthand Help
/loot none Opens your loot list.
/friendlist /flist Opens your friend list.
/blacklist [subcommand] /blist Opens your blacklist.
Command Description
Subcommands
add [name] Adds the character with the specified name to your blacklist.
/map none Opens the current area map.
/supportdesk /helpdesk Opens the help desk menu.
/logout none Begins the log out process.
/shutdown none Log out and exit the game.

Configuration

Command Shorthand Help
/shadow [subcommand] none Toggle the display of character shadows. Toggles between enabled and disabled when no subcommand is specified.
Value Description
Subcommands
on Enable character shadows.
off Disable character shadows.
/dusteffect [subcommand] /dust Toggle the display of graphic effects left by characters feet. Toggles between enabled and disabled when no subcommand is specified.
Value Description
Subcommands
on Enable effects made by feet.
off Disable effects made by feet.
/physics [subcommand] none Toggle realistic physics effects. Toggles between enabled and disabled modes when no subcommand is specified.
Value Description
Subcommands
on Enable realistic physics effects.
off Disable realistic physics effects.
/profanity [subcommand] none Toggle the profane language filter. Toggles between enabled and disabled when no subcommand is specified.
Value Description
Subcommands
on Enable the language filter.
off Disable the language filter.
/scrollingbattletext [subcommand] /sbt Toggle the display of damage and other combat information.
Value Description
Subcommands
on Enable graphic combat text.
off Disable graphic combat text.
/extendeddraw [subcommand] /edraw Extend the range at which graphics are drawn. Toggles between off and on when no subcommand specified.
Value Description
Subcommands
on Enable extended drawing.
off Disable extended drawing.
/textclear [num] [subcommand] /tc Toggle the text auto-hide feature for num log window. Text will be hidden after 60 seconds.

Toggles between off and on when no subcommand is specified.

Value Description
Subcommands
on Turn on the log text hide feature.
off Turn off the log text hide feature.
/camera [subcommand] /cam Set the current camera position as default when no subcommand is specified.
Value Description
Subcommands
reset Reset position to system default.
/uilock [subcommand] none Prevents movement or resizing of UI elements. Toggles between on and off when no subcommand is specified.
Value Description
Subcommands
on Lock the position and size of all UI elements.
off Unlock the position and size of all UI elements.
/uihelp [subcommand] none Display pop-up help text for each UI element. Toggles between on and off when no subcommand given.
Value Description
Subcommands
on Display help text.
off Hide help text.

Player Search

Command Shorthand Help
/search [query] ... /who Search for players using the designated conditions. Results are displayed in the player search interface.

The following can be used as search subcommands:

  • Status
  • Class
  • Level
  • Job
  • Grand Company Affiliation
  • Area
  • Language

Subcommands for the /search (/who) text command can be input directly in the language selected in the FINAL FANTASY XIV Config. Searches can also be made using words found in the auto-translate dictionary.

Other

Command Shorthand Help
/? /[command name] Gives a detailed explanation of specified command. Abbreviations can be used.

If a command name is incomplete or does not exist, similar commands will be listed.

  • All names used with these commands must be one word or in quotation marks.
/wait [time]
<wait.[time]>
none A macro command for adjusting the pause between commands.

A wait time amount of 1 equals one second. The maximum wait time allowed is 60. If the wait time amount is over 60, it will be counted as 0.
e.g. /action Swiftcast <me> <wait.1>

/battlemode [subcommand] /bm Toggles between active and passive mode. Toggles between active and passive mode when no subcommand is specified.
Value Description
Subcommands
on Switch to active mode.
off Switch to passive mode.
/item [item name] [target name] none Uses an item on the specified target. Cannot be used with items that are not in your inventory, or when restricted by other factors.
/marking [num] [target] /enemysign Set an enemy sign on the specified target. Select the type of sign using a number from 1 to 8

Example:

/enemysign 1

sets sign type one on target.

/automove none Continue walking/running in the direction you are moving. Move in the opposite direction to cancel.
/check [target name] none Checks the targeted player
/clock [subcommand] none Displays the current time, as well as the time remaining until several in-game activities such as guildleve renewal and behests.
/random [value] /dice Roll a random number between 0 and the desginated value (up to 1,000). Results will be displayed in a /say radius.

Rolls will be between 0 and 100 when no value is designated.

/equiplinkshell [subcommand] /el Activate the designated linkshell. Unequips active linkshell when no subcommand is specified.
Value Description
Subcommands
LS Name Equip linkshell with provided name. Quotation marks are required for names containing a space.
LS Number Equip linkshell corresponding to designated number.

Placeholders

The following placeholder commands are also available for chatting and text commands.

Targeting Placeholders

Placeholder Description
<t>, <target> Displays current target's name.
<tt>, <t2t> Displays target of current target's name
<f>, <focus> Displays your focus target's name
<r>, <reply> Displays the name of the last player to send you a /tell
<pet> Displays your current (Familiar/Egi/Fairy) name
<comp>, <buddy>, <c>, <b> Displays your summoned chocobo companion's name
<mo>, <mouse> Displays the name of the target under your mouse cursor (or party/ally UI)
<f>, <focus> Displays the name of your /focustarget
<me>, <0> Displays your character's name.
<1> Party Member 1. Displays name of first party member in list.
<2> Party Member 2. Displays name of second party member in list.
<3> Party Member 3. Displays name of third party member in list.
<4> Party Member 4. Displays name of fourth party member in list.
<5> Party Member 5. Displays name of fifth party member in list.
<6> Party Member 6. Displays name of sixth party member in list.
<7> Party Member 7. Displays name of seventh party member in list.
<8> Party Member 8. Displays name of eighth party member in list.
<la>, <lastattacker> Displays the last enemy that attacked you.
<le>, <lastenemy> Displays the last enemy you targeted.
<lt>, <lasttarget> Displays your last target.
<attack1>, <attack2>, <attack3>, <attack4>, <attack5> Displays target to attack 1-5's name (using signs)
<bind1>, <bind2>, <bind3> Displays target to bind 1-3's name (using signs)
<ignore1>, <ignore2> Displays target to ignore 1-2's name (using signs)
<square> Displays the name of the target marked with a square (using signs)
<circle> Displays the name of the target marked with a circle (using signs)
<cross> Displays the name of the target marked with a cross (using signs)
<triangle> Displays the name of the target marked with a triangle (using signs)

Non-Targeting Placeholders

Placeholder Description
<class>, <job> Displays current class (or job) and level.
Example: scholar(80)
<hp> Displays current HP and maximum HP.
Example: 150/200
<hpp> Displays current HP as a percentage.
Example: 75%
<mp> Displays current MP and maximum MP.
Example: 75/100
<mpp> Displays current MP as a percentage.
Example: 75%
<comphp> Displays your chocobo's current HP and maximum HP.
Example: 150/200
<comphpp> Displays your chocobo's current HP as a percentage.
Example: 75%
<thpp>, <targethpp> Displays target's current HP as a percentage.
Example: 75%
<fhpp>, <focushpp> Displays focus target's current HP as a percentage.
Example: 75%
<fclass>, <focusclass>, <fjob>, <focusjob> Displays focus target's class (or job).
Example: astrologian
<pos> Display's coordinates of current location.
<flag> Display's coordinates of flag's location.
<recast.[action name]> Display's cooldown for specified action.
Example (<recast.summon seraph>): 1:32

Guides

Main article: Macro Guides