getTableEntry: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(Created page with "{{MacroFunction |name=getTableEntry |proposed=false |deprecated= |trusted=true |version=1.5.4 |description= Retrieves the raw table data for the specified entry as a JSON obje...")
 
No edit summary
Line 9: Line 9:


|usage=
|usage=
<source lang="mtmacro" line>
<source lang="mtmacro">
getTableEntry(table, roll)
getTableEntry(table, roll)
</source>
</source>
Line 18: Line 18:
|example=
|example=
Get the entry from table "Critters" matching a roll of 4.
Get the entry from table "Critters" matching a roll of 4.
<source lang="mtmacro">
<source lang="mtmacro" line>
[r: getTableEntry("Critters", 4)]
[r: getTableEntry("Critters", 4)]
</source>
</source>
Returns:
Returns:
<source lang="javascript" line>
<source lang="javascript">
{"min":3, "max":5, "value": "duck", "assetid":""}
{"min":3, "max":5, "value": "duck", "assetid":""}
</source>
</source>

Revision as of 13:48, 17 August 2019

getTableEntry() Function

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

Introduced in version 1.5.4
Retrieves the raw table data for the specified entry as a JSON object. Returns an empty string if the entry doesn't exist. If no image is associated with the entry the {{code}assetid}} will be an empty string.

Usage

getTableEntry(table, roll)

Parameters

  • table - Name of table as a string.
  • roll - The entry to retrieve as if a roll of that value had been made.

Example

Get the entry from table "Critters" matching a roll of 4.
[r: getTableEntry("Critters", 4)]

Returns:

{"min":3, "max":5, "value": "duck", "assetid":""}

See Also