transferVBL: Difference between revisions
Jump to navigation
Jump to search
(update to reflect new delete parameter) |
No edit summary |
||
| (4 intermediate revisions by 3 users not shown) | |||
| Line 8: | Line 8: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
transferVBL(value) | transferVBL(value) | ||
transferVBL(value, delete) | transferVBL(value, delete) | ||
transferVBL(value, id) | transferVBL(value, id) | ||
transferVBL(value, delete, id) | transferVBL(value, delete, id) | ||
</ | </syntaxhighlight> | ||
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. | 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. | ||
| Line 21: | Line 21: | ||
** {{code|0}} transfer normal (blue) VBL to token (yellow) VBL}} | ** {{code|0}} transfer normal (blue) VBL to token (yellow) VBL}} | ||
** {{code|1}} transfer token (yellow) VBL to normal (blue) VBL | ** {{code|1}} transfer token (yellow) VBL to normal (blue) VBL | ||
{{param| | {{param|delete|Defines if the transferred VBL is deleted from the source.}} | ||
{{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]].}} | ||
|examples= | |examples= | ||
''Example: Transfer VBL from Token to Map'' | ''Example: Transfer VBL from Token to Map'' | ||
< | <syntaxhighlight lang="mtmacro"> | ||
[h:transferVBL(1, "Dragon")] | [h:transferVBL(1, "Dragon")] | ||
[h:transferVBL(0)] | [h:transferVBL(0)] | ||
</ | </syntaxhighlight> | ||
''Example: Transfer VBL from Map to current Token'' | ''Example: Transfer VBL from Map to current Token'' | ||
< | <syntaxhighlight lang="mtmacro"> | ||
[h:transferVBL(0)] | [h:transferVBL(0)] | ||
</ | </syntaxhighlight> | ||
''Example: Clear VBL from Token after transfer since 1.5.1'' | ''Example: Clear VBL from Token after transfer since 1.5.1'' | ||
< | <syntaxhighlight lang="mtmacro"> | ||
[h:transferVBL(1, 1)] | [h:transferVBL(1, 1)] | ||
</ | </syntaxhighlight> | ||
''Example: Clear VBL from Token after transfer before 1.5.1'' | ''Example: Clear VBL from Token after transfer before 1.5.1'' | ||
< | <syntaxhighlight lang="mtmacro"> | ||
[h:transferVBL(1)] | [h:transferVBL(1)] | ||
[h: finalVblData = "{'shape':'none'}"] | [h: finalVblData = "{'shape':'none'}"] | ||
[h: setTokenVBL(finalVblData)] | [h: setTokenVBL(finalVblData)] | ||
</ | </syntaxhighlight> | ||
|changes= | |changes= | ||
Latest revision as of 23:59, 14 March 2023
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 the VBL layer if true; otherwise, it transfers from the VBL layer to the token.
Usage
transferVBL(value)
transferVBL(value, delete)
transferVBL(value, id)
transferVBL(value, delete, 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:0transfer normal (blue) VBL to token (yellow) VBL1transfer token (yellow) VBL to normal (blue) VBL
delete- Defines if the transferred VBL is deleted from the source.id- OPTIONAL: The tokenidof the token for which you want to set this setting, defaults to the Current Token.
Examples
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 since 1.5.1
[h:transferVBL(1, 1)]Example: Clear VBL from Token after transfer before 1.5.1
[h:transferVBL(1)]
[h: finalVblData = "{'shape':'none'}"]
[h: setTokenVBL(finalVblData)]See Also
Version Changes
- 1.5.0 - new delete parameter