setTableEntry: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(Created page with "{{MacroFunction |name=setTableEntry |version=1.4.0.1 |description= Sets the result for a specified roll value. Returns {{true}} if update successful and {{false}} if not. May...")
 
No edit summary
 
(6 intermediate revisions by 3 users not shown)
Line 2: Line 2:
|name=setTableEntry
|name=setTableEntry
|version=1.4.0.1
|version=1.4.0.1
|trusted=true
|description=
|description=
Sets the result for a specified roll value. Returns {{true}} if update successful and {{false}} if not. May only be used by GM or a trusted macro.
Sets the result for a specified roll value. Returns {{true}} if update successful and {{false}} if not.  
|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
setTableEntry(tableName, roll, result)
setTableEntry(tableName, roll, result)
</source>
setTableEntry(tableName, roll, result, imageId)
</syntaxhighlight>
'''Parameters'''
'''Parameters'''
{{param|tableName|A string containing the name of the Table.}}
{{param|tableName|A string containing the name of the Table.}}
{{param|roll|Whether or not the table can be seen by players in the Table Window, {{true}} or {{false}}.}}
{{param|roll|A value to select the desired table entry.}}
{{param|result|A string containing the result returned by the '''table()''' function.}}
{{param|result|A string containing the result returned by the '''table()''' function.}}
{{param|imageId|Optional and is the asset id of an image that will be returned by the '''tableImage()''' function.}}
|also=
|also=
[[table (function)|table()]]
[[table (function)|table()]]
}}
}}
[[Category:Table Function]]
[[Category:Table Function]]

Latest revision as of 23:59, 14 March 2023

setTableEntry() Function

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

Introduced in version 1.4.0.1
Sets the result for a specified roll value. Returns true(1) if update successful and false(0) if not.

Usage

setTableEntry(tableName, roll, result)
setTableEntry(tableName, roll, result, imageId)

Parameters

  • tableName - A string containing the name of the Table.
  • roll - A value to select the desired table entry.
  • 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.


See Also