Macro Commonality

From RPTools Wiki
Jump to navigation Jump to search

 This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.
 This article needs: Needs more/fuller examples and cross-linking.

Macro commonality is found in the macro editor under the 'Options' tab.

When two or more tokens are selected that contain macros, macros the tokens have in common appear in a 'Common Macros' group at the top of the Selection panel. Macro Commonality determines the conditions where two macros should appear in the 'Common Macros' group.

Macro Commonality options are found under the 'Options' tab in the Macro Editor as a set of checkboxes.

To be considered "common", macros **must** have the same name/label. If the names match, each macro is then compared to one another based on the checkbox values:

  • Group
  • Sort Prefix
  • Command
  • Include Label
  • Auto Execute
  • Apply to Selected Tokens

Each macro with a matching label will only be included in 'Common Macros' if each of its checked Macro Commonality options also matches all the others.

Visual settings (label colors, text size, and button size) don't affect macro commonality. The 'Common Macro' version of a macro button will be displayed with the last selected token's button style.

Examples of use

  • Ignoring Command Differences: Consider multiple NPC tokens which are attacking simultaneously, but they may have slightly different commands in their 'Attack' macros. By deselecting the 'Use Command' Macro Commonality option on all of the Attack macros, they will still always appear under 'Common Macros' as a single macro when multiple NPC tokens are selected.
  • Ignoring Sort Order & Group: Consider all player tokens have the same 'Long Rest' macro. The commands are identical, but one player has organized their macros into groups and used a 'Sort Prefix' on their version of the macro. By deselecting the 'Use Group' and 'Use Sort Prefix' Macro Commonality options on the all the 'Long Rest' macros, they will still appear under 'Common Macros' as a single macro when multiple player tokens are selected.

Note that if a token's version of a macro is different enough to exclude from 'Common Macros', such as a boss who shouldn't attack with their minions by accident in the first example, you could check 'Use Command' on that single macro and it will be excluded from 'Common Macros' (or, more reliably , simply rename the macro).