setTokenPortrait: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Conversion script moved page SetTokenPortrait to setTokenPortrait: Converting page titles to lowercase)
No edit summary
Line 6: Line 6:


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
setTokenPortrait(assetId)
setTokenPortrait(assetId)
setTokenPortrait(assetId, id)
setTokenPortrait(assetId, id)
setTokenPortrait(assetId, id, mapname)
setTokenPortrait(assetId, id, mapname)
</source>
</syntaxhighlight>
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
setTokenPortrait(tokenImageName)
setTokenPortrait(tokenImageName)
setTokenPortrait(tokenImageName, id)
setTokenPortrait(tokenImageName, id)
setTokenPortrait(tokenImageName, id, mapname)
setTokenPortrait(tokenImageName, id, mapname)
</source>
</syntaxhighlight>


'''Parameters'''
'''Parameters'''

Revision as of 20:28, 14 March 2023

setTokenPortrait() Function

Introduced in version 1.3b77
Sets the portrait image for the for the Current Token. The image can come from several sources. It can be an asset id (like from tblImage() or getTokenImage()), or a Image Token.

Usage

setTokenPortrait(assetId)
setTokenPortrait(assetId, id)
setTokenPortrait(assetId, id, mapname)
setTokenPortrait(tokenImageName)
setTokenPortrait(tokenImageName, id)
setTokenPortrait(tokenImageName, id, mapname)

Parameters

  • id - OPTIONAL: The token id of the token for which you want to set the portrait, defaults to the Current Token.
  • mapname - OPTIONAL: The name of the map to find the token. Defaults to the current map.


Version Changes

  • 1.5.4 - Added mapname parameter option.