Difference between revisions of "Script:Conditions and Status Tracker"
From Roll20 Wiki
m (→Syntax) |
|||
| Line 11: | Line 11: | ||
=== Syntax === | === Syntax === | ||
| − | {{syntaxbox top|formal=true}} | + | {{syntaxbox top|formal=true|Conditions and Status Tracker}} |
{{API command|StatusAdd}} {{API parameter|name=status}} {{API parameter|name=duration}} {{API parameter|name=description}} {{API parameter|name=GM only flag|optional=true}} {{API parameter|name=</em>// <em>marker|optional=true}}<br> | {{API command|StatusAdd}} {{API parameter|name=status}} {{API parameter|name=duration}} {{API parameter|name=description}} {{API parameter|name=GM only flag|optional=true}} {{API parameter|name=</em>// <em>marker|optional=true}}<br> | ||
{{API command|StatusDel}} {{API parameter|name=status}}<br> | {{API command|StatusDel}} {{API parameter|name=status}}<br> | ||
Revision as of 22:42, 8 January 2015
API ScriptAuthor: Josh
Version: 1.8
Last Modified: 2014-01-15
Code: Conditions and Status Tracker
Dependencies: None
Conflicts: None
Version: 1.8
Last Modified: 2014-01-15
Code: Conditions and Status Tracker
Dependencies: None
Conflicts: None
Tracks arbitrary statuses associated with tokens. Statuses may have a turn-limited duration, or may be permanent. Only the GM may modify what statuses exist on a given token, but depending on settings the status may be broadcast to all players.
The API commands !StatusAdd, !StatusDel, !StatusAll, and !StatusClearAll are used to manipulate what statuses are present.
Syntax
!StatusAdd <status> <duration> <description> [GM only flag] [// marker]
!StatusDel <status>
!StatusAll
!StatusClearAllFormally:
S→ !StatusAddstatusdurationdescriptionGMFlagmarker
S→ !StatusDelstatus
S→ !StatusAll
S→ !StatusClearAll
status→ string
duration→ integer
description→ string
GMFlag→ ε
GMFlag→ GM
marker→ ε
marker→ // string
| Parameter | Values |
|---|---|
| status | Name of the status to add. No spaces are allowed. |
| duration | Number of turns the status lasts. Use -1 for permanent duration.
|
| description | Description of the status. |
| GM only flag | Optional. GM is the only accepted value. If this flag is set, only the GM will be notified about this status.
|
| marker | Optional. Defines the statusmarker to set on the token representing this status. |
Installation
There are several configuration variables near the top of the script. You may alter them to customize the script functionality:
- StatusTracker.statusIndicator – Then default marker to use if
markeris not supplied. - StatusTracker.Chat – Set to
trueto indicate the status in the chat window, orfalseotherwise. - StatusTracker.ChatDescriptions – Set to
trueto display the status descriptions, orfalseotherwise. - StatusTracker.ChatOnlyGM – If set to
true, all chat messages will be sent to the GM regardless of theGMflag. Set tofalseto control statuses individually. - StatusTracker.currentTurn – Not customizable.
- StatusTracker.bloodiedTintColor – Set to a hexadecimal color value in order to tint the token to the set color when
bar1is below half of its maximum. Set to"transparent"to disable this behavior. - StatusTracker.bloodiedMarker – Set to a statusmarker name in order to mark the token when
bar1is below half of its maximum. Set to"none"to disable this behavior. - StatusTracker.deadMarker – Set to a statusmarker name which indicates that the token is dead (
bar1is 0). - StatusTracker.statusIncidatorBG – Background style color for status chat messages.
- StatusTracker.statusIndicatorFontColor – Foreground style color for status chat messages.
