setTokenPortrait

From RPTools Wiki
(Redirected from SetTokenPortrait)
Jump to navigation Jump to search

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, mapRef)
setTokenPortrait(tokenImageName)
setTokenPortrait(tokenImageName, id)
setTokenPortrait(tokenImageName, id, mapRef)

Parameters

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


Version Changes

  • 1.5.4 - Added mapname parameter option.
Retrieved from "https://wiki.rptools.info/index.php?title=setTokenPortrait&oldid=35755"