transferHillVBL

 This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.

transferHillVBL() Function

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

• Introduced in version 1.12

Directly transfers Hill VBL from token to the Hill VBL layer if true; otherwise, it transfers from the Hill VBL layer to the token's Hill VBL.

Usage

transferHillVBL(direction)
transferHillVBL(direction, delete)
transferHillVBL(direction, id)
transferHillVBL(direction, delete, id)

This function can be used to transfer token Hill VBL to normal Hill VBL, or vice versa. Token VBL moves with the token, can be set under the VBL tab on the Token Editor Dialog, and is colored YELLOW. Normal VBL is static, can be created with the VBL drawing tools, or with the use of the VBL functions, and is colored BLUE.

Parameters

• direction - This value can be:
  • 0 transfer normal (blue) Hill VBL to token (yellow) Hill VBL
  • 1 transfer token (yellow) Hill VBL to normal (blue) Hill VBL
• delete - Defines if the transferred Hill VBL is deleted from the source.
• id - OPTIONAL: The token id of the token being acted upon. Defaults to the Current Token.

Examples

Example: Transfer Hill VBL from Token to Map

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

Example: Transfer Hill VBL from Map to current Token

[h: transferHillVBL(0)]

Example: Clear Hill VBL from Token after transfer

[h: transferHillVBL(1, 1)]

See Also

Introduction to Vision Blocking, eraseHillVBL(), drawHillVBL(), setTokenHillVBL()