transferVBL: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
(Added example that clears VBL from token.)
Line 20: Line 20:




''Example: Transfer VBL from Token to Map''<source lang="mtmacro">
[h:transferVBL(1, "Dragon")]
[h:transferVBL(0)]
</source><br />


''Example:''<source lang="mtmacro">
''Example: Transfer VBL from Map to current Token''<source lang="mtmacro">
[h:transferVBL(1, "Dragon")]
[h:transferVBL(0)]
[h:transferVBL(0)]
</source><br />
</source><br />
''Example: Clear VBL from Token after transfer''<source lang="mtmacro">
[h:transferVBL(1)]
[h: finalVblData = "{'shape':'none'}"]
[h: setTokenVBL(finalVblData)]
</source><br />


|also=
|also=
[[Introduction to Vision Blocking ]], {{func|eraseVBL}}, {{func|drawVBL}}
[[Introduction to Vision Blocking ]], {{func|eraseVBL}}, {{func|drawVBL}}, {{func|setTokenVBL}}
}}
}}
[[Category:Miscellaneous Function]]
[[Category:Miscellaneous Function]]
[[Category:VBL Function]]
[[Category:VBL Function]]

Revision as of 16:27, 3 February 2019

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