bringToFront: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
(Added details for the function)
Line 32: Line 32:


|changes=
|changes=
{{change|1.3b51|Added {{code|id}} optional id parameter.}}
{{change|1.3b51|Added optional {{code|id}} parameter.}}
}}
}}
[[Category:Token Function]]
[[Category:Token Function]]

Revision as of 05:58, 27 March 2009

bringToFront() Function

Introduced in version 1.3b48
Adjust the z order (or draw order) of the token so that is is drawn after all other tokens on the

same map layer, this has the effect of making the token appear to be in front of the other

tokens as it will obscure other tokens on the same map layer in the same location.

Usage

bringToFront()
bringToFront(id)

Parameter

  • id - The id or name of the token to effect. Can only be used when running from a Trusted Macro.

Example

<!-- Make sure that we are visible above all other tokens on the same layer -->
[h: bringToFront()]


<!-- The Hero of the piece should always stand out -->
[h: bringToFront("Hero")]


Version Changes

  • 1.3b51 - Added optional id parameter.