Difference between revisions of "Macro"

Revision as of 00:31, 14 October 2013

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

Creating Macros

Open main menu
Take the User Macro Option
Select the macro number you wish to modify
Name the Macro
Select the Macro Icon
Add the script to the Macro

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

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.

/macroicon [action name]

none

Changes icon with ability name and displays the cooldown spiral.

/recast [action name]

none

Displays time remaining until the specified action can be used again.

/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.

Subcommands
Value	Description
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.

Subcommands
Value	Description
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.

Subcommands
Value	Description
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.

Subcommands
Value	Description
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.

Subcommands
Value	Description
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.

Subcommands
Value	Description
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.

Subcommands
Value	Description
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

/equip [slot] [item name]

none

Equips an item to a specified slot. If an item name is omitted, then the item currently equipped to that slot will be unequipped.

Available slots:

main
sub
throwing
pack
pouch
head
body
shirt
legs
garment
hands
feet
waist
neck
ears
wrists
R.finger
L.finger.

/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

Subcommands
Value	Description
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.

Subcommands
Value	Description
On	Activate the associated job.
Off	Deactivate the associated job.

Party

Command

Shorthand

Help

/partycmd [subcommand]

/pcmd

Executes various party commands.

Subcommands
Value	Description
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

Help

/actionbar(/abar) [subcommand]

Toggle action bar display method.

>>Subcommands:
on	- Always display action bar.
off	- Display bar only when executing a command.
Toggle between on and off when no subcommand is specified.

/actionbarhelp(abarhelp) [subcommand]

Display pop-up help text for action bars.

>>Subcommands:
on	- Display help text.
off	- Hide help text.
Toggle between on and off when no subcommand is specified.

/targetcursor(/tcursor) [subcommand]

Set the default position of the target cursor.

>>Subcommands:
a -	Set to central.

b -	Set to floating.

c -	Set to both central and floating.

/names [subcommand]

Turns all name displays on/off.

>>Subcommands:
on	- Turn names on.
off	- Turn names off.
Toggle on and off when no subcommand is specified.

/enemylevel(/elevel) [subcommand]

Display levels below enemies’ names.

>>Subcommands:
on	- Display enemy levels.
off	- Hide enemy levels.
Toggle between on and off when no subcommand is specified.

/enemyicon(/eicon) [subcommand]

Display active and non-active icons for enemies.

>>Subcommands:
on	- Display active (red) and non-active (green) icons.
off	- Hide active (red) and non-active (green) icons.
Toggle between on and off when no subcommand is specified.

/enmity(/enm) [subcommand]

Display enemy enmity icons.

>>Subcommands:
on	- Display enmity icons next to enemies' HP bars.
off	- Hide enmity icons.
Toggle between on and off when no subcommand is specified.

/away [subcommand]

Changes your online status to Away.

>>Subcommands:
on	- Display Away icon.
off	- Hide Away Icon
Toggle between on and off when no subcommand is specified.

/countdown(/count) [value]

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.

Subcommands
Command	Description
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

Help

/shadow [subcommand]

Toggle the display of character shadows.

>>Subcommands:
on	- Enable character shadows.
off	- Disable character shadows.
Toggle between enabled and disabled modes when no subcommand is specified.

/dusteffect(/dust) [subcommand]

Toggle the display of graphic effects left by characters feet.

>>Subcommands:
on	- Enable effects made by feet.
off	- Disable effects made by feet.
Toggle between enabled and disabled modes when no subcommand is specified.

/physics [subcommand]

Toggle realistic physics effects.

>>Subcommands:
on	- Enable realistic physics effects.
off	- Disable realistic physics effects.
Toggle between enabled and disabled modes when no subcommand is specified.

/profanity [subcommand]

Toggle the profane language filter.

>>Subcommands:
on	- Enable the language filter.
off	- Disable the language filter.
Toggle between enabling and disabling modes when no subcommand is specified.

/scrollingbattletext(/sbt) [subcommand]

Toggle the display of damage and other combat information.

>>Subcommands:
on	- Enable graphic combat text.
off	- Disable graphic combat text.
Toggle between enabled and disabled modes when no subcommand is specified.

/extendeddraw(/edraw) [subcommand]

Extend the range at which graphics are drawn.

>>Subcommands:
on	- Enable extended drawing.
off	- Disable extended drawing.
Toggle between enabled and disabled modes when no subcommand is specified.

/textclear(/tc) [number 1–2] [subcommand]

Toggle the text auto-hide feature for the designated log window (1 or 2). Text will be hidden after 60 seconds.

>>Subcommands:
on	- Turn on the log text hide feature.
off	- Turn off the log text hide feature.
Toggle between on and off when no subcommand is specified.

/camera(/cam) [subcommand]

Set the current camera position as default when no subcommand is specified.

>>Subcommands:
reset	- Reset position to system default.

/uilock [subcommand]

Prevents movement or resizing of UI elements.

>>Subcommands:
on	- Lock the position and size of all UI elements.
off	- Unlock the position and size of all UI elements.
Toggle between on and off when no subcommand is specified.

/macrobar(/mbar) [subcommand]

Toggle the continuous display of the macro bar.

>>Subcommands:
on	- Display or hide the macro bar with a single press of Ctrl or Alt.
off	- Display the macro bar by holding down Ctrl or Alt.
Toggle between on and off when no subcommand is specified.

/uihelp [subcommand]

Display pop-up help text for each UI element.

>>Subcommands:
on	- Display help text.
off	- Hide help text.
Toggle between on and off when no subcommand is specified.

Player Search

Command

Help

/search(/who) Search condition 1 search condition 2, etc.

Search for players using the designated conditions. Results are displayed in the player search interface.

>>Subcommands

The following conditions can be applied to filter the search. Refer to this <a> href="/pl/guide/macro02.html" target="_blank">separate table</a> for more details.

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. For more details on language settings in FINAL FANTASY Config, please refer to <a href="/pl/envi/envi05.html">Settings</a>.

Other

Command

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 [wait time]

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.

/battlemode(/bm) [subcommand]

Toggles between active and passive mode.

>>Subcommands:
on	- Switch to active mode.
off	- Switch to passive mode.
Toggle between active and passive mode when no subcommand is specified.

/item [item name] [target name]

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(/enemysign)
[number (1–8)] [target]

Set an enemy sign on the specified target. Select the type of sign using a number from 1 to 8.

>>Example:

/enemysign 1(Set sign type 1 on target.)

/automove

Continue walking/running in the current direction you are moving.
Move in the opposite direction to cancel.

/check [target name]

Checks targeted player.

/clock

Displays the current time, as well as the time remaining until several in-game activities such as guildleve renewal and behests.

/random(/dice) [value]

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(/el) [subcommand]

Activate the desginated linkshell.

>>Subcommands:
LS name	- Equip linkshell of the designated name. Quotation marks are required for names containing a space.
LS number	- Equip linkshell corresponding to designated number.
Unequip active linkshell when no subcommand is specified.

Emotes

*	Using the motion subcommand together with any emote other than those formed with the /emote command will display the physical action only, with no accompanying message in the log.

Special

Command

Help

/sit (/lounge) [subcommand]

Certain emotes have special sitting equivalents.

Also sits your character in a chair if the chair is nearby.

* Moving while seated will cause your character to stand.

>>Subcommands:
on	– Switch to a sitting position.
off	– Switch to standing position.
Toggle between sitting and standing when no subcommand is specified.

Salutations

Command	Help
/bow	Perform a bow.
/grandcompanysalute (/gcsalute)	Perform your Grand Company's salute. * Cannot be performed by those of Recruit rank.
/goodbye	Bid farewell.
/kneel	Kneel in respect.
/salute	Perform a salute.
/wave	Wave your hand.
/welcome	Make a welcoming gesture.

Emotes & Signs

Command	Help
/blowkiss	Blow a kiss.
/cheer	Cheer enthusiastically.
/congratulate	Offer congratulations.
/me	Motion to yourself.
/deny	Strongly disagree.
/no	Disagree.
/pray	Offer solemn words of prayer to the Twelve or whatever gods it is you keep.
/psych	Psych yourself up.
/think	Become lost in thought.
/thumbsup	Strongly agree.
/yes	Nod in approval.

Actions & Movements

Command	Help
/airquotes	Make air quotes. * Motion not accompanied by a log message.
/clap	Applaud.
/dance	Start dancing.
/doze	Start dozing off.
/grovel	Fall to your knees in unworthiness.
/pose	Strike a pose.
/stagger	Stagger for a moment.
/stretch	Stretch.
/surprised	Act surprised.

Signals & Instructions

Command	Help
/beckon	Make a beckoning motion.
/examineself	Admire yourself.
/lookout	Scan the area.
/point	Point at something.
/poke	Make a poking gesture.

Positive Reactions

Command	Help
/blush	Blush with embarrassment.
/chuckle	Chuckle in amusement.
/comfort	Make a consoling gesture.
/happy	Display extreme happiness.
/joy	Express joy.
/laugh	Burst out laughing.
/rally	Give encouragement.
/soothe	Make a comforting gesture.

Negative Reactions

Command	Help
/angry	Be angry.
/cry	Break into tears.
/disappointed	Convey utter disappointment.
/doubt	Appear doubtful.
/fume	Express disappointment.
/furious	Be furious.
/huh	Express confusion.
/panic	Start to panic.
/shocked	Act shocked.
/shrug	Shrug.
/sulk	Wallow in self-pity.
/upset	Express disgust.

Placeholders

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

Targeting Placeholders

Command	Help
<t>	Displays current target name.
<me>	Displays your character's name.
<p0>	Party Member 0. Displays your character's name.
<p1>	Party Member 1. Displays name of first party member in list.
<p2>	Party Member 2. Displays name of second party member in list.
<p3>	Party Member 3. Displays name of third party member in list.
<p4>	Party Member 4. Displays name of fourth party member in list.
<p5>	Party Member 5. Displays name of fifth party member in list.
<p6>	Party Member 6. Displays name of sixth party member in list.
<p7>	Party Member 7. Displays name of seventh party member in list.
<st>	Subtarget.
<stpc>	Displays available PC subtargets.
<stnpc>	Displays available NPC subtargets.
<stenemy>	Displays available engageable enemy subtargets.
<stenmity>	Displays available engaged enemy subtargets.
<stparty>	Displays available party member subtargets.
<lastat>	Displays the last enemy that attacked you.

Non-Targeting Placeholders

Command	Help
<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%
<tp>	Displays current TP. Example: 3000
<lastst>	Displays name of last subtarget.
<pos>	Display’s coordinates of current location.
<sign0>	Displays ally sign 0.
<sign1>	Displays ally sign 1.
<sign2>	Displays ally sign 2.
<sign3>	Displays ally sign 3.
<sign4>	Displays ally sign 4.
<sign5>	Displays ally sign 5.
<sign6>	Displays ally sign 6.
<sign7>	Displays ally sign 7.

@@ Line 511: / Line 511: @@
 ====Menus====
-							<div class="text-margin"></div>
+====Menus====
-							<table width="641" class="contents-table2" cellspacing="1">
+{| class="wikitable"
-								<tr>
+!Command
-									<td class="contents-table2TH1 txtCenter" width="32%">Command</td>
+!Shorthand
-									<td class="contents-table2TH1 txtCenter" width="68%">Help</td>
+!Help
-								</tr>
+|-
+| /loot
-								<tr>
+| none
-									<td class="contents-table2TH2 txtCenter">/loot</td>
+| Opens your loot list.
-									<td class="contents-table2TD1">Opens your Loot List.</td>
+|-
-								</tr>
+| /friendlist
+| /flist
-								<tr>
+| Opens your friend list.
-									<td class="contents-table2TH2 txtCenter">/friendlist(/flist)</td>
+|-
-									<td class="contents-table2TD1">Opens your Friend List.</td>
+| /blacklist [subcommand]
-								</tr>
+| /blist
+| Opens your blacklist.
-								<tr>
+{| class="wikitable"
-									<td class="contents-table2TH2 txtCenter">/blacklist(/blist)</td>
+!Command
-									<td class="contents-table2TD1">Displays your blacklist.</td>
+!Description
-								</tr>
+|+ Subcommands
+|-
-								<tr>
+| '''add''' [name]
-									<td class="contents-table2TH2 txtCenter">/map</td>
+| Adds the character with the specified name to your blacklist.
-									<td class="contents-table2TD1">Opens the current area map.</td>
+|}
-								</tr>
+|-
+| /map
-								<tr>
+| none
-									<td class="contents-table2TH2 txtCenter">/supportdesk(/helpdesk)</td>
+| Opens the current area map.
-									<td class="contents-table2TD1">Opens the Help Desk menu.</td>
+|-
-								</tr>
+| /supportdesk
+| /helpdesk
-								<tr>
+| Opens the help desk menu.
-									<td class="contents-table2TH2 txtCenter">/logout</td>
+|-
-									<td class="contents-table2TD1">Begins the logout process.</td>
+| /logout
-								</tr>
+| none
+| Begins the log out process.
-								<tr>
+|-
-									<td class="contents-table2TH2 txtCenter">/shutdown</td>
+| /shutdown
-									<td class="contents-table2TD1">Log out and exit the game.</td>
+| none
-								</tr>
+| Log out and exit the game.
-							</table>
+|}
-							<br><div class="text-margin"></div>
 ====Configuration====

Difference between revisions of "Macro"

Revision as of 00:31, 14 October 2013

Contents

Creating Macros

List of Commands

Text Commands

Chat

Actions

Targeting

Equipment

Party

UI Display

Menus

Menus

Configuration

Player Search

Other

Emotes

Salutations

Emotes & Signs

Actions & Movements

Signals & Instructions

Positive Reactions

Negative Reactions

Placeholders

Targeting Placeholders

Non-Targeting Placeholders

Navigation menu

Search