Macro Generator - Aedif/multi-token-edit GitHub Wiki

Mass Edit can generate simple macros using the selected fields that will update, toggle, delete, or open Mass Edit forms.

Example video

https://user-images.githubusercontent.com/7693704/199100945-1f338240-ace7-41cc-ac74-b59e67681c50.mp4

Target

Define the target for the generated macro

  • ALL - All documents within the selected scope
  • IDs of Current Selected - IDs of documents are stored within the macro and will be looked up at run-time
  • Search - A search will be performed within the selected scope using configured fields
    • Search Fields - A sub-menu made available when Search is selected. Enter key-value pairs to be used in the search
  • Tagger - A search will be performed within the selected scope using Tagger module's 'tags'.
    • Tags - A sub-menu made available when Tagger is selected. Define a comma separated list of tags to be used in the search.
    • Must Match - A sub-menu made available when Tagger is selected. Select whether any one (Any Tag) or all (All Tags) tags must be contained within the document for a successful match.

Scope

Limit the scope of documents affected by the macro.

  • Selected - Only selected documents at macro run-time will be considered
  • Active Scene - All documents in the currently active scene
  • World - All documents throughout the game world

Action

The action you want the macro to perform on all documents that matched based on Target and Scope

  • Update - Updates the documents using the data in the text box
  • Toggle - Alternates document updates between the data in the two text boxes
    • Toggle Detection - A sub-menu made available when Toggle is selected. How should the macro determine whether a particular document has been toggle on or off.
      • Field Compare - Check if the data within the text box matches the document
      • Flag - Apply a unique flag to track whether data has been already applied to the document
  • Open Mass Edit Form - Opens the Mass Edit form (Shift+E)
  • Delete - Deletes the documents

In addition to the above, if Update or Toggle are selected you'll also get an option to select the matched documents and/or run another macro. Useful if you have macros that require placeables to be under control for them to execute. For example filters in the Token Magic FX compendium.

Randomization and Addition/Subtraction operators are supported but will add a dependency on Mass Edit module to be active when the macro is run.