transferVBL: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
(update to reflect new delete parameter) |
||
| Line 9: | Line 9: | ||
|usage= | |usage= | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
transferVBL(value) | |||
transferVBL(value, delete) | |||
transferVBL(value, id) | transferVBL(value, id) | ||
transferVBL(value, delete, id) | |||
</source> | </source> | ||
| Line 18: | 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|value|Defines if the transfered VBL is actually 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]].}} | ||
| Line 32: | Line 36: | ||
</source> | </source> | ||
''Example: Clear VBL from Token after transfer'' | ''Example: Clear VBL from Token after transfer since 1.5.1'' | ||
<source lang="mtmacro"> | |||
[h:transferVBL(1, 1)] | |||
</source> | |||
''Example: Clear VBL from Token after transfer before 1.5.1'' | |||
<source lang="mtmacro"> | <source lang="mtmacro"> | ||
[h:transferVBL(1)] | [h:transferVBL(1)] | ||
| Line 38: | Line 47: | ||
[h: setTokenVBL(finalVblData)] | [h: setTokenVBL(finalVblData)] | ||
</source> | </source> | ||
|changes= | |||
{{change|1.5.0|new delete parameter}} | |||
|also= | |also= | ||
Revision as of 22:44, 23 March 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 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
value- Defines if the transfered VBL is actually 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