setTokenVBL

From RPTools Wiki
Revision as of 20:04, 20 August 2018 by Phergus (talk | contribs) (Created page with "{{MacroFunction |name=setTokenVBL |proposed=false |trusted=true |version=1.4.1.6 |description=sets the VBL of a token to that given as a parameter |usage= <source lang="mtmac...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

setTokenVBL() Function

 Note: This function can only be used in a Trusted Macro

Introduced in version 1.4.1.6
sets the VBL of a token to that given as a parameter

Usage

setTokenVBL(vbl, id)

This function can be used to transfer TOKEN VBL to a different token. Token VBL moves with the token, can be set under the VBL tab on the token edit menu and is colored YELLOW. Normal VBL is static, can be created with the VBL drawing tools or with the use of VBL functions and is colored BLUE.

Parameters

  • vbl - A JSON object containing the vbl to be added to the token. Use getTokenVBL() to get VBL from another token.
  • id - OPTIONAL: The token id of the token for which you want to set this setting, defaults to the Current Token.


Example:

[h: vbl = getTokenVBL("Door, Steel")]
[h: setTokenVBL(vbl, "Door, Wood")]



See Also