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 Lock"

From Roll20 Wiki

Jump to: navigation, search
m (tagged for cleanup)
(Add info)
Line 5: Line 5:
 
|dependencies={{api repository link|IsGM}}
 
|dependencies={{api repository link|IsGM}}
 
|lastmodified=2015-02-01}}
 
|lastmodified=2015-02-01}}
{{stub}}
+
 
{{cleanup}}
+
'''TokenLock''' allows the GM to selectively prevent players from moving their tokens.
Allows GMs to selectively lock the movement of Player Tokens.
+
 
 +
Determination of player tokens is based on whether that token has an entry in the <code>controlled by</code>-field of either the token or the character it represents(this is due to <code>change:graphic</code>-events to not specify who changed the graphic).
 +
 
 +
If <code>controlled by</code> is empty, the GM can freely move the token at any point. If there is any entry in <code>controlled by</code>, the token can only be moved when '''TokenLock''' is unlocked.
 +
 
 +
Moving of player-controlled [[Cards]] is still permissible.
 +
 
 +
==Commands==
 +
 
 +
:<code>!tl</code> Executing the command with no arguments prints this help.
 +
::The following arguments may be supplied in order to change the configuration. All changes are persisted between script restarts.
 +
::<code>lock</code> -- Locks the player tokens to prevent moving them.
 +
** <code>unlock</code> -- Unlocks the player tokens allowing them to be moved.
 +
:<code>!tl-config [<Options>|--help]</code> Swaps the selected Tokens for their counterparts on the other layer.
 +
::<code>--help</code> -- Shows the Help screen.
 +
::<code>--toggle-allowmoveonturn</code> -- Sets whether tokens can be moved if they are at the top of the turn order.
 +
 
 
<br clear="all">
 
<br clear="all">
  
=== Changelog ===
+
== Changelog ==
 
{{changelog version|0.11|2015-02-01|* Release}}
 
{{changelog version|0.11|2015-02-01|* Release}}

Revision as of 18:48, 26 December 2020

API ScriptAuthor: Aaron C. M.
Version: 0.11
Last Modified: 2015-02-01
Code: TokenLock
Dependencies: IsGM
Conflicts: None

TokenLock allows the GM to selectively prevent players from moving their tokens.

Determination of player tokens is based on whether that token has an entry in the controlled by-field of either the token or the character it represents(this is due to change:graphic-events to not specify who changed the graphic).

If controlled by is empty, the GM can freely move the token at any point. If there is any entry in controlled by, the token can only be moved when TokenLock is unlocked.

Moving of player-controlled Cards is still permissible.

Commands

!tl Executing the command with no arguments prints this help.
The following arguments may be supplied in order to change the configuration. All changes are persisted between script restarts.
lock -- Locks the player tokens to prevent moving them.
    • unlock -- Unlocks the player tokens allowing them to be moved.
!tl-config [<Options>|--help] Swaps the selected Tokens for their counterparts on the other layer.
--help -- Shows the Help screen.
--toggle-allowmoveonturn -- Sets whether tokens can be moved if they are at the top of the turn order.


Changelog

v0.11 (2015-02-01)

  • Release