transferVBL: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 14: Line 14:


'''Parameters'''
'''Parameters'''
{{param|value|The value of the setting to set, {{code|transfer token (yellow) VBL to normal (blue) VBL}}({{code|1}}) or {{code|transfer normal (blue) VBL to token (yellow) VBL}}({{code|0}}).}}
{{param|value|The value of the setting to set:}}
{{param|(1)|transfer token (yellow) VBL to normal (blue) VBL}}
{{param|(0)|transfer normal (blue) VBL to token (yellow) VBL}}
{{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]]. }}





Revision as of 21:34, 10 August 2017

transferVBL() Function

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

Introduced in version 1.3b90
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:

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



See Also