Difference between revisions of "Player API"
From Roll20 Wiki
Andreas J. (Talk | contribs) m |
Andreas J. (Talk | contribs) m |
||
| (One intermediate revision by one user not shown) | |||
| Line 1: | Line 1: | ||
| − | <noinclude>{{revdate}}{{pro only|page}} | + | <noinclude>{{revdate}}{{pro only|page}}{{apiboxRec}} |
{{main|API}} | {{main|API}} | ||
| − | |||
| − | |||
This is a guide listing various [[API scripts]] that can be used for '''expanding or restricting what [[players]] normally can do in Roll20'''. Normally, people in a [[campaign]] is either: | This is a guide listing various [[API scripts]] that can be used for '''expanding or restricting what [[players]] normally can do in Roll20'''. Normally, people in a [[campaign]] is either: | ||
* the '''[[GM|GM/Creator]]''', who have full access and visibility to everything in a game, or | * the '''[[GM|GM/Creator]]''', who have full access and visibility to everything in a game, or | ||
| Line 17: | Line 15: | ||
* '''[[Script:ChatSetAttr|ChatSetAttr]]''' -- can be configured to allow players to evaluate or edit stats on characters they don't control, useful for automatically reducing enemy HP, or granting healing/ temp HP to allies. | * '''[[Script:ChatSetAttr|ChatSetAttr]]''' -- can be configured to allow players to evaluate or edit stats on characters they don't control, useful for automatically reducing enemy HP, or granting healing/ temp HP to allies. | ||
* '''[[Script:CharSheet|CharSheet]]''' -- A simple and easily customizable script allowing players to create their own character sheets, using the command <code>!charsheet</code> | * '''[[Script:CharSheet|CharSheet]]''' -- A simple and easily customizable script allowing players to create their own character sheets, using the command <code>!charsheet</code> | ||
| − | * ''' | + | * '''[[Door Knocker]]''' -- Enables players to reveal/hide [[Dynamic Lighting]] sections such as doors. The GM can change doors from between locked/unlocked to adjust which doors the players can open. Speeds up DL management for GM as well. |
| − | ** can be used for revealing hidden door | + | ** can be used for revealing hidden door, as well as making "[[Windows|windows]]" |
| − | + | ||
* '''[[Script:emas|emas]]''' -- Provides player <code>!emas</code> and <code>!as</code> commands. This is equivalent to the [[Text_Chat#Speaking_and_Emoting_as_a_Random_NPC_.28.2Fas.29_.28.2Femas.29|<code>/emas</code>]], which is GM-only | * '''[[Script:emas|emas]]''' -- Provides player <code>!emas</code> and <code>!as</code> commands. This is equivalent to the [[Text_Chat#Speaking_and_Emoting_as_a_Random_NPC_.28.2Fas.29_.28.2Femas.29|<code>/emas</code>]], which is GM-only | ||
* '''[[Script:MapChange|MapChange]]''' -- has option to allow players to move between map pages, and GM can choose which pages are available/visible to them | * '''[[Script:MapChange|MapChange]]''' -- has option to allow players to move between map pages, and GM can choose which pages are available/visible to them | ||
Latest revision as of 10:06, 18 February 2022
 | Page Updated: 2022-02-18 |
 | 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
This is a guide listing various API scripts that can be used for expanding or restricting what players normally can do in Roll20. Normally, people in a campaign is either:
- the GM/Creator, who have full access and visibility to everything in a game, or
- a player, who can only see and affect a limited number of things, most of which a GM explicitly needs give the player permissions/access to
This base system lacks some granularity and has some frustrations to first-time users(like how a GM needs to create & assign character sheets to players), but there are surprisingly many API that can change that.
Using these APIs you can hand some campaign responsibilities to individual or all players, or to create a "Co-GM" that can do almost as many things as an actual GM, when needed.
Most of these APIs makes the GMs life easier by themselves, even without granting players any access to them.
[edit] Expand Permissions
Some GM-only features can be indirectly granted to players through the use of different APIs:
- ChatSetAttr -- can be configured to allow players to evaluate or edit stats on characters they don't control, useful for automatically reducing enemy HP, or granting healing/ temp HP to allies.
- CharSheet -- A simple and easily customizable script allowing players to create their own character sheets, using the command
!charsheet - Door Knocker -- Enables players to reveal/hide Dynamic Lighting sections such as doors. The GM can change doors from between locked/unlocked to adjust which doors the players can open. Speeds up DL management for GM as well.
- can be used for revealing hidden door, as well as making "windows"
- emas -- Provides player
!emasand!ascommands. This is equivalent to the/emas, which is GM-only - MapChange -- has option to allow players to move between map pages, and GM can choose which pages are available/visible to them
- Observer(Forum) -- handy way to add/remove players as "Observer", who can see & control all player characters.
- PublicSheet(Forum) — create public, read-only versions of character sheets
- Roll20 Audio Master (aka. Roll20AM) -- API commands to manage the u Jukebox, GM can grant selective access to individual players/tracks
- Teleport -- provides a way for GMs or players to teleport tokens within,or between, map pages
- TokenMod -- For managing token properties with chat commands. Usually players have limited control of their token settings, apart from editing the three bubbles.
- Includes setting that enables players to target tokens they don't control
Restrict Permissions
There are also API that can be used to restrict players more that normal:
- DryErase(Forum) – An API that can stop players from drawing on the map, deleting any drawing instantly.
- TokenLock – Allows GMs to lock/unlock the movement of all Player Tokens. - Useful for when you want to pause the situation and prevent players from accidentally moving forward.
- MapLock - similar to TokenMod, but can be used for locking down any individual graphic/token on the map, so even the GM can't accidentally move things.
- Useful if you want players to have control over a token otherwise(see stats, edit/see name & notes), but stop it form being moved.
Related Pages
- Game Management
- API:Script Index - longer list of APIs
- Subscription | Free vs Plus vs Pro
- Character Sheets
- Complete Macro Guide
- Community FAQ
- Streaming Roll20
