setTokenVBL: Difference between revisions
Jump to navigation
Jump to search
(Added example that clears VBL from token.) |
(Some documentation on using it to auto-generate. Needs more.) |
||
| Line 19: | Line 19: | ||
{{param|id|OPTIONAL: The token {{code|id}} of the token for which you want to set this setting, defaults to the [[Current Token]]. }} | {{param|id|OPTIONAL: The token {{code|id}} of the token for which you want to set this setting, defaults to the [[Current Token]]. }} | ||
|example= | |||
Transfer VBL from one Token to another | |||
<source lang="mtmacro"> | |||
[h: vbl = getTokenVBL("Door, Steel")] | [h: vbl = getTokenVBL("Door, Steel")] | ||
[h: setTokenVBL(vbl, "Door, Wood")] | [h: setTokenVBL(vbl, "Door, Wood")] | ||
</source><br /> | </source><br /> | ||
Erase VBL from Token | |||
<source lang="mtmacro"> | |||
[r: finalVblData = "{'shape':'none'}"] | [r: finalVblData = "{'shape':'none'}"] | ||
[r: setTokenVBL(finalVblData)] | [r: setTokenVBL(finalVblData)] | ||
</source><br /> | |||
Auto-generate VBL for the [[Current Token]] | |||
<source lang="mtmacro"> | |||
[h: options = json.set("{}", "shape", "auto", "sensitivity", 10, "inverse", 0, "level", 2, "method", "Douglas Peucker", "r", 0, "g", 0, "b", 0, "a", 255)] | |||
[h: setTokenVBL(options)] | |||
</source><br /> | </source><br /> | ||
|also= | |also= | ||
[[Introduction to Vision Blocking ]], {{func|getTokenVBL}}, {{func|drawVBL}}, {{func|eraseVBL}} | [[Introduction to Vision Blocking ]], {{func|getTokenVBL}}, {{func|drawVBL}}, {{func|eraseVBL}} | ||
|changes= | |||
* '''1.6.0''' - Added support for auto-generation of VBL with {{code|shape:auto}}. | |||
}} | }} | ||
[[Category:Miscellaneous Function]] | [[Category:Miscellaneous Function]] | ||
[[Category:VBL Function]] | [[Category:VBL Function]] | ||
Revision as of 01:24, 1 April 2020
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 in the JSON object parameter.
Usage
setTokenVBL(vbl, id)This function is used to attach the TOKEN VBL passed in as a JSON object to a token. The JSON object may be be created by calling getTokenVBL() on a different token and may also be used with drawVBL() or eraseVBL().
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 thevblto be added to the token. Use getTokenVBL() to get VBL from another token.id- OPTIONAL: The tokenidof the token for which you want to set this setting, defaults to the Current Token.
Example
Transfer VBL from one Token to another
[h: vbl = getTokenVBL("Door, Steel")]
[h: setTokenVBL(vbl, "Door, Wood")]Erase VBL from Token
[r: finalVblData = "{'shape':'none'}"]
[r: setTokenVBL(finalVblData)]Auto-generate VBL for the Current Token
[h: options = json.set("{}", "shape", "auto", "sensitivity", 10, "inverse", 0, "level", 2, "method", "Douglas Peucker", "r", 0, "g", 0, "b", 0, "a", 255)]
[h: setTokenVBL(options)]See Also
Version Changes
- 1.6.0 - Added support for auto-generation of VBL with
shape:auto.