getTableImage: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Conversion script moved page GetTableImage to getTableImage: Converting page titles to lowercase)
No edit summary
Line 6: Line 6:
|description=
|description=
Gets the [[Asset ID|asset id]] for the image of the current row for the given table.  See {{func|setTableRoll}} to learn how to set the current row.
Gets the [[Asset ID|asset id]] for the image of the current row for the given table.  See {{func|setTableRoll}} to learn how to set the current row.
Returns the image [[Asset ID|asset id]] of Table represented in Tables Frame. For images in table entries see {{func|getTableRoll}}.


|usage=
|usage=
Line 12: Line 14:
</syntaxhighlight>
</syntaxhighlight>
'''Parameters'''
'''Parameters'''
* {{code|table}} - The name of the table for the row which has its image asset returned. If the given table doesn't exist or is inaccessible in the current context, the script aborts.
* {{code|table}} - Name of table in Tables Frame. If table doesn't exist or is inaccessible, then script aborts and an error is thrown. See {{func|getTableNames}} to get a list of visible tables.


|also=
|also=

Revision as of 23:00, 17 August 2023

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

getTableImage() Function

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

Introduced in version 1.5.0
Gets the asset id for the image of the current row for the given table. See setTableRoll() to learn how to set the current row. Returns the image asset id of Table represented in Tables Frame. For images in table entries see getTableRoll().

Usage

getTableImage(table)

Parameters

  • table - Name of table in Tables Frame. If table doesn't exist or is inaccessible, then script aborts and an error is thrown. See getTableNames() to get a list of visible tables.


See Also