setTokenVBL

From RPTools Wiki
Jump to navigationJump 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 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.

The method parameter in the JSON object must use one of the following: DOUGLAS_PEUCKER_SIMPLIFIER, TOPOLOGY_PRESERVING_SIMPLIFIER, VW_SIMPLIFIER, or NONE.

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

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_SIMPLIFIER", "r", 0, "g", 0, "b", 0, "a", 255)]
[h: setTokenVBL(options)]

See Also

Version Changes

  • 1.9.0 - VBL method must use the enum values DOUGLAS_PEUCKER_SIMPLIFIER, TOPOLOGY_PRESERVING_SIMPLIFIER, VW_SIMPLIFIER, or NONE.
  • 1.6.0 - Added support for auto-generation of VBL with shape:auto.