Skip to content

Tables

Tables is a global which provides the ability to interact with the Table object.

Function Summary

Function Name Description Return  
getCustomURL()
getCustomURL()
Returns the image URL of the current Custom Table, or nil if the current table is not a Custom Table.  
getTable()
getTable()
Returns the current Table's name i.e. equivalent to getTableObject().name.  
getTableObject()
getTableObject()
Returns the current Table object.  
setCustomURL(
setCustomURL(...)
url)
Sets the image URL for the current Custom Table. Has no effect if the current Table is not a Custom Table.  
setTable( name) Replaces the current Table with the Table matching the specified name.

Table Names

getTable() will return one of the following table names. setTable(...) will also accept these names in addition to human-readable names.

  • Table_Circular
  • Table_Custom
  • Table_Custom_Square
  • Table_Glass
  • Table_Hexagon
  • Table_None
  • Table_Octagon
  • Table_Plastic
  • Table_Poker
  • Table_RPG
  • Table_Square

Function Details

setTable(...)

Replaces the current Table with the Table matching the specified name.

setTable(name)

Human-Readable Names

In addition to the table names listed above, setTable(...) will also accept the following human-readable names:

  • Custom Rectangle
  • Custom Square
  • Hexagon
  • None
  • Octagon
  • Poker
  • Rectangle
  • Round
  • Round Glass
  • Round Plastic
  • Square

Example

Replace the current Table with the Poker Table.

Tables.setTable("Poker")