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 (update to 8.57)
(add link to forum thread, bunch of examples)
Line 6: Line 6:
 
|lastmodified=2020-06-10}}
 
|lastmodified=2020-06-10}}
  
The Aaron's TokenMod API Script.
+
The Aaron's TokenMod API Script. '''TokenMod''' provides an interface to setting almost all changeable properties of a token.
 
+
TokenMod provides an interface to setting almost all settable properties of a token.
+
  
 
'''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 documnetation can be found in the API Script dropdown menu when the script is selected.
+
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
 +
* {{forum|post/4225825/script-update-tokenmod-an-interface-to-adjusting-properties-of-a-token-from-a-macro-or-the-chat-area TokenMod Forum thread}}
 +
 
 +
==Examples==
 +
Some examples of <code>!token-mod</code> commands, with possible explanations. Texamples taken from the forum thread or in-game documentation.
 +
 
 +
<pre style="overflow:auto;" data-language="javascript">
 +
 
 +
!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 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
 +
}}
 +
 
 +
</pre>
  
The latest version can be found here: [https://github.com/shdwjk/Roll20API/tree/master/TokenMod GitHub link]
+
<br>
 
<br>
 
<br>
 
[[Category:User API Scripts]]
 
[[Category:User API Scripts]]

Revision as of 14:31, 22 December 2020

API ScriptAuthor: Aaron C. M.
Version: 0.8.57
Last Modified: 2020-06-10
Code: TokenMod
Dependencies: IsGM
Conflicts: None

The Aaron's TokenMod API Script. TokenMod provides an interface to setting almost all changeable properties of a token.

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.

Examples

Some examples of !token-mod commands, with possible explanations. Texamples 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 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
}}