createTable: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Conversion script moved page CreateTable to createTable: Converting page titles to lowercase)
m (Text replacement - "source>" to "syntaxhighlight>")
Line 9: Line 9:
createTable(tableName, visible, accessible)
createTable(tableName, visible, accessible)
createTable(tableName, visible, accessible, imageId)
createTable(tableName, visible, accessible, imageId)
</source>
</syntaxhighlight>
'''Parameters'''
'''Parameters'''
{{param|tableName|A string containing the name of the Table. '''Warning: if a table with that name already exists it will be cleared.'''}}
{{param|tableName|A string containing the name of the Table. '''Warning: if a table with that name already exists it will be cleared.'''}}
Line 20: Line 20:
[r:createTable("tableY",1,1,getTableImage("tableZ"))]
[r:createTable("tableY",1,1,getTableImage("tableZ"))]


</source>
</syntaxhighlight>
|also=
|also=
{{func|addTableEntry}} {{func|setTableRoll}} {{func|deleteTable}}
{{func|addTableEntry}} {{func|setTableRoll}} {{func|deleteTable}}
}}
}}
[[Category:Table Function]]
[[Category:Table Function]]

Revision as of 17:02, 14 March 2023

createTable() Function

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

Introduced in version 1.4.0.1
Creates an empty table, specifying its access levels and optional image.

Usage

<source lang="mtmacro" line> createTable(tableName, visible, accessible) createTable(tableName, visible, accessible, imageId) </syntaxhighlight> Parameters

  • tableName - A string containing the name of the Table. Warning: if a table with that name already exists it will be cleared.
  • visible - Whether or not the table can be seen by players in the Table Window, true(1) or false(0).
  • accessible - Whether or not the table can be used by players to lookup values, true(1) or false(0).
  • imageId - Optional and is the asset id of an image that will be used for the table in the Table Window. If an invalid or missing asset id is used, the table will display a red "X".

Examples

<source lang="mtmacro" line>

[r:createTable("tableX",1,1)] [r:createTable("tableY",1,1,getTableImage("tableZ"))]

</syntaxhighlight>

See Also