getTokenVBL: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(Created page with "{{MacroFunction |name=getTokenVBL |proposed=false |trusted=true |version=1.4.1.6 |description=gets the VBL attached to a token |usage= <source lang="mtmacro" line> transferVB...")
 
m (Fixed typo in usage.)
Line 8: Line 8:
|usage=
|usage=
<source lang="mtmacro" line>
<source lang="mtmacro" line>
transferVBL(id)
getTokenVBL(id)
</source>
</source>



Revision as of 20:04, 20 August 2018

getTokenVBL() Function

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

Introduced in version 1.4.1.6
gets the VBL attached to a token

Usage

getTokenVBL(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

  • 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