sendToBack: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Added version.)
m (Updated with recent version changes.)
Line 1: Line 1:
{{stub|Examples of usage.}}
{{MacroFunction
{{MacroFunction
|name=sendToBack
|name=sendToBack
|version=1.3b48
|version=1.3b48
|description=
|description=
Moves the [[Token:Current Token|Current Token]] behind of all of the other [[Token:token|token]]s on the same [[Map:map layer|map layer]].
Adjust the z-order (or draw order) of the [[Token]] so that it is drawn before all other [[Token]]s on the same [[Map Layer]], this has the effect of making the Token appear to be in back of the other [[Token]]s as it will be obscured by other [[Token]]s on the same [[Map Layer]] in the same location.  


|usage=
|usage=
Line 9: Line 10:
sendToBack()
sendToBack()
</source>
</source>
<source lang="mtmacro" line>
sendToBack(id)
</source>
'''Parameter'''
{{param|id|The token {{code|id}} or name of the token that has its z-order changed, defaults to the [[Current Token]]. {{TrustedParameter}} }}
|also=
{{func|bringToFront}}
|changes=
{{change|1.3b51|Added {{code|id}} parameter option.}}
}}
}}
[[Category:Token Function]]
[[Category:Token Function]]

Revision as of 05:03, 31 March 2009

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

sendToBack() Function

Introduced in version 1.3b48
Adjust the z-order (or draw order) of the Token so that it is drawn before all other Tokens on the same Map Layer, this has the effect of making the Token appear to be in back of the other Tokens as it will be obscured by other Tokens on the same Map Layer in the same location.

Usage

sendToBack()
sendToBack(id)

Parameter

  • id - The token id or name of the token that has its z-order changed, defaults to the Current Token.

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


See Also

Version Changes

  • 1.3b51 - Added id parameter option.