Difference between revisions of "Token/API"
From Roll20 Wiki
Andreas J. (Talk | contribs) m |
Andreas J. (Talk | contribs) m |
||
| (8 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | <noinclude>{{revdate}}{{pro only|page}} | + | <noinclude>{{revdate}}{{pro only|page}}{{apiboxRec}} |
{{main|API:Script Index}}</noinclude> | {{main|API:Script Index}}</noinclude> | ||
APIs that focus on interacting with [[tokens]], or some aspect of them. | APIs that focus on interacting with [[tokens]], or some aspect of them. | ||
| Line 9: | Line 9: | ||
* {{api-gh|ClockTokens/READEME.md Clock Tokens}} -- easy way to manage multi-sided tokens which are being used to represent progress clocks, or any other kind of incrementing timer or countdown. | * {{api-gh|ClockTokens/READEME.md Clock Tokens}} -- easy way to manage multi-sided tokens which are being used to represent progress clocks, or any other kind of incrementing timer or countdown. | ||
* [https://app.roll20.net/forum/post/10551887/random-token-tinter-new-script Random Token Tinter] -- will randomly assign (or remove) tints on tokens based on either a command-line list, a predefined Rollable Table, or a default rainbow (ROYGBV). See {{code|!!randtint --help}} for more. | * [https://app.roll20.net/forum/post/10551887/random-token-tinter-new-script Random Token Tinter] -- will randomly assign (or remove) tints on tokens based on either a command-line list, a predefined Rollable Table, or a default rainbow (ROYGBV). See {{code|!!randtint --help}} for more. | ||
| + | * {{fpl|10679139 TokenController}} - Automate Token Movement for Patrols, following, roaming, and more | ||
* {{forum|permalink/8996556/ WeaponArcs}} -- provides a means to add weapon arcs to tokens for visualization of range and targetable tokens | * {{forum|permalink/8996556/ WeaponArcs}} -- provides a means to add weapon arcs to tokens for visualization of range and targetable tokens | ||
| + | * {{fpl|10790371/ Faces}} -- This is a short script that is designed to provide a quick visual interface for swapping token images and names. Great for any changeling. by [[Keith]] | ||
===Movement, Rotation, and Size === | ===Movement, Rotation, and Size === | ||
Scripts which are triggered by or change the location of tokens should generally be placed in this category. | Scripts which are triggered by or change the location of tokens should generally be placed in this category. | ||
| − | * {{fpl| | + | * {{fpl|10661242/ Bump}} - provides a way to invisibly manipulate tokens on the GM Layer from the Objects Layer, and vice versa. |
* [[Script:Token Lock|TokenLock]] -- Allows GMs to selectively lock the movement of Player Tokens. | * [[Script:Token Lock|TokenLock]] -- Allows GMs to selectively lock the movement of Player Tokens. | ||
* {{forum|permalink/5503029/ Carry Tokens}} -- Allows tokens to "carry" and move other tokens, like dragging other characters or moving items. | * {{forum|permalink/5503029/ Carry Tokens}} -- Allows tokens to "carry" and move other tokens, like dragging other characters or moving items. | ||
| Line 29: | Line 31: | ||
* [[Script:Flip Tokens|Flip Tokens]] -- Flip graphics horizontally and/or vertically | * [[Script:Flip Tokens|Flip Tokens]] -- Flip graphics horizontally and/or vertically | ||
* [[Script:Spin Tokens|SpinTokens]] -- Allows the GM to toggle spinning of selected tokens. | * [[Script:Spin Tokens|SpinTokens]] -- Allows the GM to toggle spinning of selected tokens. | ||
| + | * [[Script:TokenController|TokenController]] -- Allows GMs to quickly create patrol path shapes, assign tokens one or more paths, lock tokens in place, set tokens to follow each-other, and more. Uses complete menu system, no chat commands required. | ||
===Conditions, Status, Health === | ===Conditions, Status, Health === | ||
| Line 37: | Line 40: | ||
* [[Script:Mark|Mark]] -- Places a numbered Marker under tokens, clears on turn change/close, and page change. | * [[Script:Mark|Mark]] -- Places a numbered Marker under tokens, clears on turn change/close, and page change. | ||
* [[Script:Marking Conditions|Marking Conditions]] -- Set status markers on targeted on individual tokens | * [[Script:Marking Conditions|Marking Conditions]] -- Set status markers on targeted on individual tokens | ||
| + | * [[Script:TurnMarker1|TurnMarker1]] -- provides a visual marker to show which token's turn it is & centers map on them. | ||
* [[Script:Token Name Number|TokenNameNumber]] -- Automatic numbering of tokens with special placeholder. | * [[Script:Token Name Number|TokenNameNumber]] -- Automatic numbering of tokens with special placeholder. | ||
* [[Script:Monster Hit Dice|Monster Hit Dice]] -- Set Monster hit points from hit dice on add, usually via drag from journal. | * [[Script:Monster Hit Dice|Monster Hit Dice]] -- Set Monster hit points from hit dice on add, usually via drag from journal. | ||
* {{fpl|4630083/ Aura/Tint HealthColors}} -- {{api-gh|HealthColors code}} -- Script to set health indicator on tokens via aura or tint, based on a bar's value. | * {{fpl|4630083/ Aura/Tint HealthColors}} -- {{api-gh|HealthColors code}} -- Script to set health indicator on tokens via aura or tint, based on a bar's value. | ||
| + | ** [https://github.com/djmoorehead/AuraTintHealthColorsDJM/blob/main/v1.1.6.DJM script variant] by David M., uses only one aura1 | ||
* [[Script:RoundMaster|RoundMaster]] -- Manages token statuses, Effect Macros, and Turn Order | * [[Script:RoundMaster|RoundMaster]] -- Manages token statuses, Effect Macros, and Turn Order | ||
| + | * [Token Patrol https://app.roll20.net/forum/post/11115799/script-token-patrol] by Patrick P. | ||
<noinclude>[[Category:API Recommendations]] | <noinclude>[[Category:API Recommendations]] | ||
[[Category:Tokens]]</noinclude> | [[Category:Tokens]]</noinclude> | ||
Latest revision as of 15:46, 3 October 2022
 | Page Updated: 2022-10-03 |
 | This page is about a Roll20 feature exclusive to Pro-subscribers (and often to players in a Game created by a Pro-subscriber). If you'd like to use this feature, consider upgrading your account. |
Roll20 Mod
Mod Suggestions
- D&D 5E
- Combat
- Character Sheet
- Dynamic Lighting
- Jukebox
- Maps
- Text Chat/Macros
- Tokens
- System Specific
- Mod Guides by Script
Debug
Other
Main Page: API:Script Index
APIs that focus on interacting with tokens, or some aspect of them.
- TokenMod -- An interface to adjusting properties of a token from a macro or the chat area. Very versatile and tons of options, and it can perform features of several other Token-related APIs.
- Reporter(Forum) -- A script to poll the game and return info on Token/Character pairs, along with customized action tools.
- SelectManager - can patch and extend token selection between APIs
- Supernotes(Forum) -- script pulls the contents from a token's GM Notes field.
-
-- easy way to manage multi-sided tokens which are being used to represent progress clocks, or any other kind of incrementing timer or countdown.
- Random Token Tinter -- will randomly assign (or remove) tints on tokens based on either a command-line list, a predefined Rollable Table, or a default rainbow (ROYGBV). See
!!randtint --helpfor more. - TokenController(Forum) - Automate Token Movement for Patrols, following, roaming, and more
- WeaponArcs(Forum) -- provides a means to add weapon arcs to tokens for visualization of range and targetable tokens
- Faces(Forum) -- This is a short script that is designed to provide a quick visual interface for swapping token images and names. Great for any changeling. by Keith
[edit] Movement, Rotation, and Size
Scripts which are triggered by or change the location of tokens should generally be placed in this category.
- Bump(Forum) - provides a way to invisibly manipulate tokens on the GM Layer from the Objects Layer, and vice versa.
- TokenLock -- Allows GMs to selectively lock the movement of Player Tokens.
- Carry Tokens(Forum) -- Allows tokens to "carry" and move other tokens, like dragging other characters or moving items.
- Collision Detection -- Handles collisions between player-controlled tokens and a subset of path objects on the page
- DupCharToken -- Duplicate a Character and Token, and add identifying number to Character and Token.
- It's a Trap! -- Script for setting traps and detecting collisions with them at any point during movement. Has separate versions customised for specific games/sheets
- KABOOM -- Creates explosion effects that move tokens away from or towards a point.
- Marching Order -- Makes tokens follow each other in some specified order.
- Measure -- Measure distances between multiple tokens, both from the corners and the center.
- Random Rotate -- Allows the GM to easily rotate all selected tokens to a random angle.
- Teleport -- Teleports tokens within a page or between pages either by chat menu or token movement by using teleport tokens on the GM layer.
- Spawn Default Token(Forum) -- general idea is to automatically spawn the default token for a given "character" with various options for token qty, location/arrangement, and certain token properties such as size, side(for multi-sided tokens), light emission etc.
- Token Fate -- Let fate decide! Randomly selects a token from the selected group.
- Flip Tokens -- Flip graphics horizontally and/or vertically
- SpinTokens -- Allows the GM to toggle spinning of selected tokens.
- TokenController -- Allows GMs to quickly create patrol path shapes, assign tokens one or more paths, lock tokens in place, set tokens to follow each-other, and more. Uses complete menu system, no chat commands required.
[edit] Conditions, Status, Health
Tokens are used to represent player characters as well as non-player characters. Naturally, both occasionally get punched around a bit. Scripts in this category deal with the changing conditions of tokens, often but not necessarily as a result of combat.
- Emojibubble(Forum) -- System to easily display emojis in a bubble above Character Tokens, or on the map.
- Flight -- Mark how high tokens are flying
- -- makes it possible for GM & players to see roughly how much health an enemy has.
- Mark -- Places a numbered Marker under tokens, clears on turn change/close, and page change.
- Marking Conditions -- Set status markers on targeted on individual tokens
- TurnMarker1 -- provides a visual marker to show which token's turn it is & centers map on them.
- TokenNameNumber -- Automatic numbering of tokens with special placeholder.
- Monster Hit Dice -- Set Monster hit points from hit dice on add, usually via drag from journal.
- Aura/Tint HealthColors(Forum) -- -- Script to set health indicator on tokens via aura or tint, based on a bar's value.
- script variant by David M., uses only one aura1
- RoundMaster -- Manages token statuses, Effect Macros, and Turn Order
- [Token Patrol https://app.roll20.net/forum/post/11115799/script-token-patrol] by Patrick P.
