transferMBL: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Added description; fleshed out the rest of the page)
m (Removed the STUB template)
 
Line 1: Line 1:
{{stub}}
{{MacroFunction
{{MacroFunction
|name=transferMBL
|name=transferMBL

Latest revision as of 05:24, 6 June 2023

transferMBL() Function

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

Introduced in version 1.12
Directly transfers MBL to/from a token and the MBL layer.

Usage

transferMBL(direction)
transferMBL(direction, id)
transferMBL(direction, delete, id)

See the description of drawMBL() for details on the data format.

Parameters

  • direction - The direction of the data transfer:
    • 0 transfer normal (blue) VBL to token (yellow) VBL
    • 1 transfer token (yellow) VBL to normal (blue) VBL
  • delete - Defines if the transferred VBL is deleted from the source.
  • id - OPTIONAL: The token id of the token which data will be transferred to or from. Defaults to the Current Token.


See Also