Character Vault
Any Concept / Any System
Compendium
Your System Come To Life
Roll20 for Android
Streamlined for your Tablet
Roll20 for iPad
Streamlined for your Tablet

Personal tools

Difference between revisions of "Script:Token Mod"

From Roll20 Wiki

Jump to: navigation, search
m
(link to latest update, add defaulttoken example)
Line 1: Line 1:
 
{{script overview
 
{{script overview
 
|name=TokenMod
 
|name=TokenMod
|author=[[Aaron|Aaron C. M.]]
+
|author=[[Aaron|Aaron C. M.]]}}
|version=0.8.57
+
|lastmodified=2020-06-10}}
+
 
{{main|API:Script Index}}
 
{{main|API:Script Index}}
  
 
The Aaron's TokenMod API Script. '''TokenMod''' provides an interface to setting almost all changeable properties of a token. [[Players]] can also use it to edit [[tokens]] they control, with option to edit/target other's tokens.  
 
The Aaron's TokenMod API Script. '''TokenMod''' provides an interface to setting almost all changeable properties of a token. [[Players]] can also use it to edit [[tokens]] they control, with option to edit/target other's tokens.  
 +
 +
It's among the most popular APIs, and is quickly updated every time Roll20 makes new API keys accessible.
 +
 +
* '''{{fpl|10136003/ Update v0.8.69  June 2021}}''' -- Support for Token Bar Location, Compact Token Bars,  Light Sensitivity Multiplier (UDL), and Night Vision Effect (UDL)
 +
 +
  
 
'''Commands:''' <code><nowiki>!token-mod <--help|--ignore-selected|--config|--on|--off|--flip|--set> <parameter> [<parameter> ...] ... [ --ids <token id> [<token id> ...]]</nowiki></code>
 
'''Commands:''' <code><nowiki>!token-mod <--help|--ignore-selected|--config|--on|--off|--flip|--set> <parameter> [<parameter> ...] ... [ --ids <token id> [<token id> ...]]</nowiki></code>
  
Full user documentation can be found in the '''Help: TokenMod'''-Handout in-game, or by running the command '''<code>!token-mod --help</code>'''.
+
'''Full user documentation''' can be found in the '''Help: TokenMod'''-Handout in-game, or by running the command '''<code>!token-mod --help</code>'''.
  
 
* {{repo|shdwjk/Roll20API/tree/master/TokenMod TokenMod sourcecode}} - lastest version
 
* {{repo|shdwjk/Roll20API/tree/master/TokenMod TokenMod sourcecode}} - lastest version
Line 21: Line 25:
  
 
==Examples==
 
==Examples==
Some examples of <code>!token-mod</code> commands, with possible explanations. Texamples taken from the forum thread or in-game documentation.  
+
Some examples of <code>!token-mod</code> commands, with possible explanations. Examples are taken from the forum thread or in-game documentation.  
  
 
<pre style="overflow:auto;" data-language="javascript">
 
<pre style="overflow:auto;" data-language="javascript">
Line 29: Line 33:
 
!token-mod --set bar1_value|-3      // decrease value of bar 3 by 3
 
!token-mod --set bar1_value|-3      // decrease value of bar 3 by 3
 
!token-mod --set name|"Sir Thomas" bar1_value|23      //Setting a token's name to "Sir Thomas" and bar1 value to 23
 
!token-mod --set name|"Sir Thomas" bar1_value|23      //Setting a token's name to "Sir Thomas" and bar1 value to 23
 +
!token-mod --set represents|@{Bob|character_id} defaulttoken      // sets the default token for that character, a quick way to update the default token
 
!token-mod --set statusmarkers|blue|broken-shield      //adds the 2 status markers to the token
 
!token-mod --set statusmarkers|blue|broken-shield      //adds the 2 status markers to the token
 
!token-mod --move 3g                // move token 3 grids in the current facing(up being default)
 
!token-mod --move 3g                // move token 3 grids in the current facing(up being default)

Revision as of 16:28, 4 June 2021

API ScriptAuthor: Aaron C. M.
Code: TokenMod
Dependencies: None
Conflicts: None

Main Page: API:Script Index

The Aaron's TokenMod API Script. TokenMod provides an interface to setting almost all changeable properties of a token. Players can also use it to edit tokens they control, with option to edit/target other's tokens.

It's among the most popular APIs, and is quickly updated every time Roll20 makes new API keys accessible.

  • -- Support for Token Bar Location, Compact Token Bars, Light Sensitivity Multiplier (UDL), and Night Vision Effect (UDL)


Commands: !token-mod <--help|--ignore-selected|--config|--on|--off|--flip|--set> <parameter> [<parameter> ...] ... [ --ids <token id> [<token id> ...]]

Full user documentation can be found in the Help: TokenMod-Handout in-game, or by running the command !token-mod --help.

Config

Enable players to target/edit tokens they don't control(is also a button in the config menu):

!token-mod --config players-can-ids|on

Examples

Some examples of !token-mod commands, with possible explanations. Examples are taken from the forum thread or in-game documentation.


!token-mod --on showname            // show nameplate
!token-mod --set layer|gmlayer      // move to gmlayer
!token-mod --set bar1_value|-3      // decrease value of bar 3 by 3
!token-mod --set name|"Sir Thomas" bar1_value|23      //Setting a token's name to "Sir Thomas" and bar1 value to 23
!token-mod --set represents|@{Bob|character_id} defaulttoken      // sets the default token for that character, a quick way to update the default token
!token-mod --set statusmarkers|blue|broken-shield       //adds the 2 status markers to the token
!token-mod --move 3g                // move token 3 grids in the current facing(up being default)
!token-mod --move =90|2u           // moves 2 grids to the right(ignoring current facing)

//Various examples
!token-mod --on showplayers_aura1 --set aura1_radius|35 aura1_color|0000ff //Turning on aura1 for players, setting it's radius to 35, setting it's color to blue
!token-mod --set bar[[1d3]]_value|X statusmarkers|blue:[[1d9]]|green:[[1d9]] name:"[[1t[randomName]]]"     // use inline rolls to set values
!token-mod --set width|25s height|35s     // 's' represent the unit of measurement for the page
!token-mod --set scale|*2
!token-mod --set imgsrc|https://s3.amazonaws.com/files.d20.io/images/4095816/086YSl3v0Kz3SlDAu245Vg/max.png?1400535580        // change token image 

//Sidenumber Multi-sided tokens
!token-mod --set currentside|2
!token-mod --set currentside|+      //shift side by 1
!token-mod --set currentside|*      //set random side

//Controlled by
!token-mod --set controlledby|bob
!token-mod --set controlledby|+susan|+tommy        //add susan & tommy to list
!token-mod --set controlledby|=@{target|token_id}   //copy controlled by from other token
!token-mod --set controlledby|                      //nobody
!token-mod --set controlledby|all                   //all players

//Legacy DL examples
!token-mod --set light_radius|40 light_dimradius|20 adv_fow_view_distance|30

//Chaining multiple TokenMod commands
!token-mod {{
  --set
    represents|@{bob|character_id}
    bar1_link|hp
    bar2_link|speed
    bar3_link|ac
    controlledby|tom|sally|nancy
    statusmarkers|blue:3|red:[[1d6]]
    defaulttoken
}}

See Also