Macro for changing a Token Status, I have Token Mod.

Hey im looking for a mouse over or click macro where I can assign a status to a token!  Thanks for your help.

Hi John! I use TokenMod too, an API made by The Aaron.

The easy way to write that macro, makes a button that turns ON a particular status icon, on a token that you select or target*. Any preference?


Another variation of the macro, would make an ON/OFF button for a particular status on the token. This variation would check the token to see if it has the status, and would turn it OFF if it was ON when you pressed it, or would add the status if it wasn't there at the time.

Third variation, a longer and more complex macro that would have an interface, it is possible to make a macro with a drop-down list of all the Status (or all the ones that you want) and clicking the macro button would offer a choice of which status to apply on the token.

Which style are you envisioning? Or describe the actual-play uses.

In your chat room type 

!token-mod --help

and a bunch of text will come up.  If you scroll to the "Status" section it gives these instructions and options that can help to make your macro.

Here is the help documentation in the Status section.

Status

There is only one Status property. Status has a somewhat complicated syntax to support the most possible flexibility.
Available Status Property:
statusmarkers

Status is the only property that supports multiple values, all seperated by | as seen below.

!token-mod --set statusmarkers|blue|red|green|padlock|broken-shield

You can optionally preface each status with a + to remind you it is being added. This command is identical:

!token-mod --set statusmarkers|+blue|+red|+green|+padlock|+broken-shield

Each value can be followed by a colon and a number between 0 and 9. (The number following the dead status is ignored because it is special.)

!token-mod --set statusmarkers|blue:0|red:3|green|padlock:2|broken-shield:7

The numbers following a status can be prefaced with a + or -, which causes their value to be applyed to the current value. Here's an example showing blue getting incremented by 2, and padlock getting decremented by 1. Values will be bounded between 0 and 9.

!token-mod --set statusmarkers|blue:+2|padlock:-1

You can optionally preface each status with a ? to modify the way + and - on status numbers work. With ? on the front of the status, only selected tokens that have that status will be modified. Additionally, if the status reaches 0, it will be removed. Here's an example showing blue getting decremented by 1. If it reaches 0, it will be removed and no status will be added if it is missing.

!token-mod --set statusmarkers|?blue:-1

By default, status markers will be added, retaining whichever status markers are already present. You can override this behavior by prefacing a value with a - to cause the status to be removed. Below will remove the blue and padlock status.

!token-mod --set statusmarkers|-blue|-padlock

Sometimes it is convenient to have a way to add a status if it is not there, but remove it if it is. This allows marking tokens with markers and clearing them with the same command. You can preface a status with ! to toggle it's state on and off. Here is an example that will add or remove the Rook piece from a token.

!token-mod --set statusmarkers|!white-tower

Sometimes, you might want to clear all status marker as part of setting a new status marker. You can do this by prefacing a status marker with a =. Note that this affects all status markers before as well, so you will want to do this only on the first status marker. Below all status markers are removed and the dead marker is set. (If you want to remove all status markers, just specify the same marker twice with a = and then a -.)

!token-mod --set statusmarkers|=dead

Available Status Markers:

• red
• blue
• green
• brown
• purple
• pink
• yellow
• dead
• skull
• sleepy
• half-heart
• half-haze
• interdiction
• snail
• lightning-helix
• spanner
• chained-heart
• chemical-bolt
• death-zone
• drink-me
• edge-crack
• ninja-mask
• stopwatch
• fishing-net
• overdrive
• strong
• fist
• padlock
• three-leaves
• fluffy-wing
• pummeled
• tread
• arrowed
• aura
• back-pain
• black-flag
• bleeding-eye
• bolt-shield
• broken-heart
• cobweb
• broken-shield
• flying-flag
• radioactive
• trophy
• broken-skull
• frozen-orb
• rolling-bomb
• white-tower
• grab
• screaming
• grenade
• sentry-gun
• all-for-one
• angel-outfit
• archery-target

All of these operations can be combine in a single statusmarkers command.

!token-mod --set statusmarkers|blue:3|-dead|red:3

Guessing at the easiest answer for you, John:

(replace "white-tower" with any of the status marker names that are listed above)

Here is the simple API command that you can put in a macro that just adds the status called White Tower:

!token-mod --set statusmarkers|white-tower

And here is the simple version that just adds the status called White Tower if it isn't there, and takes it away if it was already there (On/Off switch):

!token-mod --set statusmarkers|!white-tower

Thanks for the help man, exactly what I needed.