Difference between revisions of "Macro"
GenesisEra (talk | contribs) m (→Equipment) |
GenesisEra (talk | contribs) m (→Equipment) |
||
Line 365: | Line 365: | ||
|} | |} | ||
|- | |- | ||
| /gearset | | /gearset [subcommand] | ||
| /gs | | /gs | ||
| Execute gear set functions. | | Execute gear set functions. | ||
Line 373: | Line 373: | ||
|+ | |+ | ||
|- | |- | ||
| change [num1] [num2] | | '''change [num1] [num2]''' | ||
| Changes your equipment to the gear set registered to the slot [num1] specified.<br>If glamor plates are available, plate number [num2] can also be specified. | | Changes your equipment to the gear set registered to the slot [num1] specified.<br>If glamor plates are available, plate number [num2] can also be specified. | ||
|- | |- | ||
| view[num] | | '''view[num]''' | ||
| View your equipment in the gear set registered to the slot [num] specified. | | View your equipment in the gear set registered to the slot [num] specified. | ||
|- | |- | ||
| save[num] | | '''save[num]''' | ||
| Save current gear to to the slot [num] specified.<br>A gear set name can be specified in place of a slot number. | | Save current gear to to the slot [num] specified.<br>A gear set name can be specified in place of a slot number. | ||
|- | |- | ||
| delete[num] | | '''delete[num]''' | ||
| Delete the gear set registered to the slot [num] specified.<br>A gear set name can be specified in place of a slot number. | | Delete the gear set registered to the slot [num] specified.<br>A gear set name can be specified in place of a slot number. | ||
|} | |} |
Revision as of 18:21, 18 February 2024
- 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
- Open the Main Menu.
- Select the User Macro Option under "System".
- Select the Macro Number you wish to modify.
- Name the Macro.
- Select the Macro Icon.
- Note: for additional icon options, you can use the /macroicon or /micon command within the macro.
- For example, using /micon "Fast Blade" will set the Macro Icon to the same icon used by this ability (Fast Blade).
- Add the script to the Macro.
- The Macro can then be set from the Macro UI to the Hotbar as an action.
Macro Functionality
- Each macro can contain a maximum of 15 lines/commands.
- A macro cannot start another macro (no nested macro commands).
- Only one macro can run at a time. Starting a new macro will cancel the currently running macro.
- There is no way to change the behavior of any macro once it begins running, even if certain conditions have been changed. This means that the actions taken are set and writing branching actions/commands based on conditions within the macro is not possible.
- A character can have a maximum of 100 character-specific individual macros and 100 shared macros that are shared across all characters on the account.
- This means that each character has, at any given time, access to 200 macros.
Uses of Macros
- The ability to queue actions in sequence using the Wait Function subcommand (<wait.X>) allow for several actions to be performed with a single press of the Macro on the hotbar, allowing for players to perform multiple actions with ease.
- This mean that macros are often used by Crafters to streamline the crafting process for large numbers of items, as using a standardised macro for crafting specific items is more convenient than multiple individual manual inputs.
- Another use of macros is to change the game's settings; it is possible to control game settings such as volume, battle effects display toggle, and HUD layouts without navigating through numerous menus.
- This allows for Macros to be used for other QoL purposes, such as allowing players to quickly change your gearsets & combining actions/emotes with messages to other players with an single macro. This serves to both add ease of convenience to key functions as well as add flavor to interactions with other players.
- Macros can also be used to rapidly send messages in party or alliance chat - this is used in certain cases to quickly communicate and visualize boss mechanics to the parties/alliance before major boss fights.
Limitations
- While macros may make it easier in theory to chain a sequence of actions, there are certain limitations that affect the effectiveness of said macros:
- All macros are fixed to run even if conditions change. For crafters using Crafting Macros, altered material conditions (Poor/Good/Excellent) happening while the crafting macros are running may cause either delayed or failed syntheses.
- High level crafting usually does not fit within the 15 lines limit, so it is recommended to use 2 or more macros for certain crafting recipes.
- The process of using macros as actions while using the Wait Function (<wait.X>) to queue actions is also inherently slower than manual human inputs; the Wait Function can only delay actions by full seconds and does not allow the use of decimal points.
- This means that if the recast timer is the GCD standard of 2.5 seconds, there will be a sub-optimal delay of 0.5 seconds of inaction. As this delay adds up over time across commands within more complex macros, using macros to queue up combat actions is less time-efficient compared to manual inputs and is not recommended for multiplayer combat-oriented content.
- The Wait Function also counts the delay time starts when the first command/action is started, not after the specific command/action is executed. As the animation time for macros may vary between actions, this may make it tricky to time the sequencing of actions while writing the macro.
List of Commands
This section is largely incomplete and is in need of detailing.
Text Commands
In general, 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
- Main article: Chat Text Commands
Command | Shorthand | Help |
---|---|---|
/alliance [mes.] | /a | Sends a message to all members of your current alliance, regardless of their location. Typing /alliance or /a without a message switches the default chat mode to [Alliance]. |
/freecompany [mes.] | /fc | Sends a message to all members of your current Free Company, regardless of their location. Typing /freecompany or /fc without a message switches the default chat mode to [Alliance]. |
/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 | Sends a message to all PCs in the same area. The message will not be displayed if a PC has deselected [Shout] in the chat filter. |
/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: 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 | ||||||
/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.
| ||||||
/equipaction [slot] [action name] | /eaction | Equips an action to a specified slot.
| ||||||
/actionqueue [subcommand] | /aq | Toggle the priority input feature for actions.
Displays whether priority input is enabled or disabled when no subcommand is specified.
| ||||||
/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.
|
Targeting
Command | Shorthand | Help | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
/target [subcommand] | /ta | Targets the object/entity specified by [subcommand]. Does not work if the specified entity is out of targeting range or does not exist.
| ||||||||
/targetmode [subcommand] | /tmode | Toggle between targeting modes.
| ||||||||
/battletargetmode [subcommand] | /btmode | Toggle targeting mode only for enemies that are engaged. Toggle on and off when no subcommand is specified.
| ||||||||
/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.
| ||||||||
/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.
| ||||||||
/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.
| ||||||||
/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 and/or weapon slots.
| ||||||||||||
/gearset [subcommand] | /gs | Execute gear set functions.
| ||||||||||||
/job [subcommand] | none | Toggle the job associated with your current class. Toggle between off and on when no subcommand is specified.
|
Party
Command | Shorthand | Help | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
/partycmd [subcommand] | /pcmd | Executes various party commands.
| ||||||||||||||
/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.
| ||||||||
/actionbarhelp [subcommand] | /abarhelp | Display pop-up help text for action bars. Toggle between on and off when no subcommand is specified.
| ||||||||
/targetcursor [subcommand] | /tcursor | Set the default position of the target cursor.
| ||||||||
/names [subcommand] | none | Turn all name displays on or off. Toggles between on and off when no subcommand is specified.
| ||||||||
/enemylevel [subcommand] | /elevel | Display levels below enemies' names. Toggles between off and on when no subcommand is specified.
| ||||||||
/enemyicon [subcommand] | /eicon | Display active and non-active icons for enemies. Toggles between off and on when no subcommand is specified.
| ||||||||
/enmity [subcommand] | /enm | Display enemy enmity icons. Toggles between off and on when no subcommand is specified.
| ||||||||
/away [subcommand] | none | Change your online status to away. Toggles between off and on when no subcommand is specified.
| ||||||||
/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.
| ||||
/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.
| ||||||
/dusteffect [subcommand] | /dust | Toggle the display of graphic effects left by characters feet. Toggles between enabled and disabled when no subcommand is specified.
| ||||||
/physics [subcommand] | none | Toggle realistic physics effects. Toggles between enabled and disabled modes when no subcommand is specified.
| ||||||
/profanity [subcommand] | none | Toggle the profane language filter. Toggles between enabled and disabled when no subcommand is specified.
| ||||||
/scrollingbattletext [subcommand] | /sbt | Toggle the display of damage and other combat information.
| ||||||
/extendeddraw [subcommand] | /edraw | Extend the range at which graphics are drawn. Toggles between off and on when no subcommand specified.
| ||||||
/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.
| ||||||
/camera [subcommand] | /cam | Set the current camera position as default when no subcommand is specified.
| ||||||
/uilock [subcommand] | none | Prevents movement or resizing of UI elements. Toggles between on and off when no subcommand is specified.
| ||||||
/uihelp [subcommand] | none | Display pop-up help text for each UI element. Toggles between on and off when no subcommand given.
|
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:
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.
| ||||||||||||||
/macroicon [icon name] [category] | /micon | Changes icon with named item/action as specified by the category. Category defaults to action if none is specified.
| ||||||||||||||
/wait [time] <wait.[time]> |
none | A macro command for adjusting the pause between commands. A wait time amount of 1 equals one second, and the maximum wait time allowed is 60.
If the wait time amount is over 60, it will be counted as 60.
| ||||||||||||||
/battlemode [subcommand] | /bm | Toggles between active and passive mode. Toggles between active and passive mode when no subcommand is specified.
| ||||||||||||||
/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 | Begin moving in the current direction you are facing; move backwards to cancel manually. Toggles between on and off when no subcommand is specified.
| ||||||||||||||
/check [target name] | /c | Examines the specified PC. Examines current target when no PC is specified. Used in conjunction with Placeholders (<t>, <target>, <1>-<8>) within Macros. | ||||||||||||||
/timer [subcommand] | none | Displays the Timers Interface, showing the Daily and Weekly Checklist for in-game activities as well as the time remaining until their Daily/Weekly Resets. | ||||||||||||||
/random [subcommand] | none | Roll a random number between 0 and the specified upper limit value (from a minimum of 2 up to a maximum of 999). Results will be displayed in a /say radius. Rolls will be between 0 and 999 if no upper limit value is designated. | ||||||||||||||
/dice [chat mode] [subcommand] | none | Roll a random number between 0 and the specified upper limit value (from a minimum of 2 up to a maximum of 999). Results will be displayed in the specified chat channel. Rolls will be between 0 and 999 if no upper limit value is designated.
| ||||||||||||||
/equiplinkshell [subcommand] | /el | Activate the designated linkshell. Unequips active linkshell when no subcommand is specified.
|
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