transferVBL

transferVBL() Function

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

• Introduced in version 1.4.2.0

directly transfers vbl from token to normal VBL if true, otherwise it transfers from VBL to token

Usage

transferVBL(value, id)

This function can be used to transfer TOKEN VBL to NORMAL VBL or vice versa. 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

• value - The value of the setting to set:
• (1) - transfer token (yellow) VBL to normal (blue) VBL
• (0) - transfer normal (blue) VBL to token (yellow) VBL
• 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 Token to Map

[h:transferVBL(1, "Dragon")]
[h:transferVBL(0)]

Example: Transfer VBL from Map to current Token

[h:transferVBL(0)]

Example: Clear VBL from Token after transfer

[h:transferVBL(1)]
[h: finalVblData = "{'shape':'none'}"]
[h: setTokenVBL(finalVblData)]

See Also

Introduction to Vision Blocking , eraseVBL(), drawVBL(), setTokenVBL()