From Roll20 Wiki
The following script creates the API commands !mark, !unmark, and !clearmark
Contents |
Syntax
!mark tokenid [status [type]]
!unmark tokenid [status [type]]
!clearmark tokenid
Regular Grammar Syntax
S→ !markparameters
S→ !unmarkparameters
S→ !clearmarktokenid
parameters→tokenid
parameters→tokenidstatustype
tokenid→ string
status→condition
status→marker
condition→ string
marker→ string
type→ string
type→ ε
| Parameter | Values |
|---|---|
| tokenid | The ID of the token to mark. Use @{target|token_id} or @{selected|token_id} to get this value.
|
| status | (Optional) A D&D 4e status (except for dying, helpless, unconscious, insubstantial, or surprised) or the name of a statusmarker icon. The script has several aliases for the statuses. For example, immobilized, immobile, and immob all correspond to the same marker.
If status is not specified, the purple statusmarker will be used. |
| type | (Optional) A D&D 4e damage type. Only used if status is ongoing, damage, or dam. One of:
If type is not specified, a statusmarker to represent untyped damage will be used. |
The !mark command will set a marker, while the !unmark command will clear it. !clearmark will clear all markers from the token.
Code
on('chat:message', function(msg) {
// Code is here~!
});
Examples
!mark @{target|token_id} brown
This will set the brown marker on the target token.
!mark @{target|token_id} immob
This will set the 'immobilize' icon to the target token.
!mark @{selected|token_id} ongoing fire
This will mark the selected token with ongoing fire damage.
!unmark @{selected|token_id}
This will remove the purple (default) statusmarker from the selected token.
!clearmark @{selected|token_id}
This will remove all markers from the selected token.
