getStateImage: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Conversion script moved page getStateImage to GetStateImage without leaving a redirect: Converting page title to first-letter uppercase)
m (Conversion script moved page GetStateImage to getStateImage: Converting page titles to lowercase)
(No difference)

Revision as of 23:12, 9 February 2023

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

getStateImage() Function

Introduced in version 1.3b40
Gets the asset id for the image of a state, the state must be one of the image types for this to work.

Usage

getStateImage(state)
getStateImage(state, size)

Parameters

  • state - The name of the state which has its image asset returned.
  • size - The size that the state image will be resized to; this is the height of the final size.

Example

To display the image for the "Dead" token state use.
<img src='[r:getStateImage("Dead")]'></img>