getAssetProperties: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Conversion script moved page GetAssetProperties to getAssetProperties: Converting page titles to lowercase)
m (Text replacement - "source>" to "syntaxhighlight>")
Line 9: Line 9:
<source lang="mtmacro" line>
<source lang="mtmacro" line>
getAssetProperties(assetId)
getAssetProperties(assetId)
</source>
</syntaxhighlight>


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

Revision as of 18:28, 14 March 2023

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

getAssetProperties() Function

Introduced in version 1.5.8
Returns a JSON Object holding the properties of the asset.

Usage

<source lang="mtmacro" line> getAssetProperties(assetId) </syntaxhighlight>

Parameters

  • assetId - The Asset ID for an image.

The fields returned for an image are:

  • subtype: the extension of the image, such as png or jpeg
  • name: the name of the file from which the asset originated
  • status: the status of the asset. Broken means the assetId is incorrect, and loading means the asset hasn't be fully loaded yet.
  • width: the width of the image
  • height: the height of the image