addTableEntry: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Conversion script moved page AddTableEntry to addTableEntry: Converting page titles to lowercase)
m (Text replacement - "source>" to "syntaxhighlight>")
Line 11: Line 11:
addTableEntry(tableName,rangeStart,rangeEnd,result)
addTableEntry(tableName,rangeStart,rangeEnd,result)
addTableEntry(tableName,rangeStart,rangeEnd,result,imageId)
addTableEntry(tableName,rangeStart,rangeEnd,result,imageId)
</source>
</syntaxhighlight>
'''Parameters'''
'''Parameters'''
{{param|tableName|A string containing the name of the Table.}}
{{param|tableName|A string containing the name of the Table.}}
Line 24: Line 24:
[r:addTableEntry("test",5,5,"alf", getTokenImage())]
[r:addTableEntry("test",5,5,"alf", getTokenImage())]
[r:setTableRoll("test","")]
[r:setTableRoll("test","")]
</source>
</syntaxhighlight>
|also=
|also=
{{func|setTableRoll}} {{func|table}} {{func|tableImage}} {{func|deleteTableEntry}}
{{func|setTableRoll}} {{func|table}} {{func|tableImage}} {{func|deleteTableEntry}}
}}
}}
[[Category:Table Function]]
[[Category:Table Function]]

Revision as of 17:01, 14 March 2023

addTableEntry() Function

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

Introduced in version 1.4.0.1
Adds a new row to the specified table. Note: adding a row to a table will not automatically change the table row value, so this should be updated to avoid possible errors (See setTableRoll() function).

Usage

<source lang="mtmacro" line> addTableEntry(tableName,rangeStart,rangeEnd,result) addTableEntry(tableName,rangeStart,rangeEnd,result,imageId) </syntaxhighlight> Parameters

  • tableName - A string containing the name of the Table.
  • rangeStart - An integer indicating the lowest value that will return this row.
  • rangeEnd - An integer indicating the highest value that will return this row.
  • result - A string containing the result returned by the table() function.
  • imageId - Optional and is the asset id of an image that will be returned by the tableImage() function.

Examples

<source lang="mtmacro" line>

[r:addTableEntry("test",1,3,"bert")] [r:addTableEntry("test",4,4,"fred")] [r:addTableEntry("test",5,5,"alf", getTokenImage())] [r:setTableRoll("test","")]

</syntaxhighlight>

See Also