getTableImage: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
mNo edit summary
m (removed extra/old text)
 
(7 intermediate revisions by 3 users not shown)
Line 5: Line 5:
|trusted=true
|trusted=true
|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.
Returns the image [[Asset ID|asset id]] of Table represented in Tables Frame. For images in table entries see {{func|getTableEntry}}.


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
getTableImage(table)
getTableImage(table)
</source>
</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.


|example=
|also=
 
{{func|setTableImage}} {{func|table}}


}}
}}
[[Category:Table Function]]
[[Category:Table Function]]

Latest revision as of 19:07, 18 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
Returns the image asset id of Table represented in Tables Frame. For images in table entries see getTableEntry().

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