Spawnable Objects

Objects can be spawned from any script using the spawnObject() function. The string type in spawnObject() should be one of the following:

Spawning Custom Objects

Boards

  • backgammon_board
  • CardBot_Board
  • Checker_Board
  • Chess_Board
  • Chinese_Checkers_Board
  • Go_Board
  • Pachisi_Board
  • reversi_board

Containers

  • Bag
  • Bowl
  • Cup
  • go_game_bowl_black
  • go_game_bowl_white
  • Infinite_Bag

Custom

Figurines

  • Figurine_Card_Bot
  • Figurine_Kimi_Kat
  • Figurine_Knil
  • Figurine_Mara
  • Figurine_Sir_Loin
  • Figurine_Zeke
  • Figurine_Zomblor

Game Pieces

  • backgammon_piece_brown
  • backgammon_piece_white
  • BlockRectangle
  • BlockSquare
  • BlockTriangle
  • Card
  • Checker_black
  • Checker_red
  • Checker_white
  • Chess_Bishop
  • Chess_King
  • Chess_Knight
  • Chess_Pawn
  • Chess_Queen
  • Chess_Rook
  • Chinese_Checkers_Piece
  • Chip_10
  • Chip_50
  • Chip_100
  • Chip_500
  • Chip_1000
  • Deck
  • Die_4
  • Die_6
  • Die_6_Rounded
  • Die_8
  • Die_10
  • Die_12
  • Die_20
  • Die_Piecepack
  • Domino
  • go_game_piece_black
  • go_game_piece_white
  • Mahjong_Coin
  • Mahjong_Stick
  • Mahjong_Tile
  • Metal Ball
  • PiecePack_Arms
  • PiecePack_Crowns
  • PiecePack_Moons
  • PiecePack_Suns
  • PlayerPawn
  • Quarter
  • reversi_chip

RPG Figures

  • rpg_BARGHEST
  • rpg_BASILISK
  • rpg_BEAR
  • rpg_BLACK_DRAGON
  • rpg_CENTAUR
  • rpg_CERBERUS
  • rpg_CHIMERA
  • rpg_CRASC
  • rpg_CYCLOP
  • rpg_DARKNESS_WARLORD
  • rpg_DRAGONIDE
  • rpg_EVIL_WATCHER
  • rpg_GHOUL
  • rpg_GIANT_VIPER
  • rpg_GOBLIN
  • rpg_GOLEM
  • rpg_GRIFFON
  • rpg_HYDRA
  • rpg_KNIGHT
  • rpg_KOBOLD
  • rpg_LIZARD_WARRIOR
  • rpg_MAGE
  • rpg_MANTICORA
  • rpg_MUMMY
  • rpg_OGRE
  • rpg_ORC
  • rpg_RANGER
  • rpg_RAT
  • rpg_SKELETON_KNIGHT
  • rpg_TEMPLATE
  • rpg_THIEF
  • rpg_TREE_ENT
  • rpg_TROLL
  • rpg_VAMPIRE
  • rpg_WARRIOR
  • rpg_WEREWOLF
  • rpg_WYVERN

Tilesets

  • Tileset_Barrel
  • Tileset_Chair
  • Tileset_Chest
  • Tileset_Corner
  • Tileset_Floor
  • Tileset_Rock
  • Tileset_Table
  • Tileset_Tree
  • Tileset_Wall

Tools

  • Calculator
  • Counter
  • Digital_Clock
  • Notecard
  • Tablet

Triggers

  • ScriptingTrigger
  • FogOfWarTrigger

Spawning Custom Objects

Immediately after spawning a Custom Object, you should call setCustomObject() with the appropriate parameters as a Table for the type of Custom Object spawned.

For example, to spawn a Custom Model:


obj_parameters = {}
obj_parameters.type = ‘Custom_Model’
obj = spawnObject(obj_parameters)

custom = {}
custom.mesh = ‘http://example.com/model.obj’
custom.diffuse = ‘http://example.com/diffuse.png’
obj.setCustomObject(custom)

Custom Board

ParameterDescription
string imageThe image for the Custom Board. The Custom Board model will automatically scale to match the dimensions of the image.

Custom Dice

ParameterDescription
string imageThe image for the Custom Dice.
int type Optional. The type of Custom Dice. This is typically the number of sides on the Dice. Defaults to 6-sided Dice.

Dice TypeValue
4-Sided0
6-Sided1
8-Sided2
10-Sided3
12-Sided4
20-Sided5


Custom Figurine

ParameterDescription
string imageThe image for the Custom Figurine.
string image_secondaryOptional. The back image for the Custom Figurine.

Custom Model

ParameterDescription
string meshThe mesh URL for the Custom Model.
string diffuseThe diffuse image URL for the Custom Model.
string normalOptional. The normals image URL for the Custom Model.
string colliderOptional. The collider mesh URL for the Custom Model. Defaults to a box collider.
bool convexOptional. Is the Custom Model convex? Defaults to false.
int type Optional. The type of the Custom Model. Defaults to Generic.

TypeValue
Generic0
Figurine1
Dice2
Coin3
Board4
Chip5
Bag6
Infinite7
int material Optional. The material of the Custom Model. Defaults to Plastic.

MaterialValue
Plastic0
Wood1
Metal2
Cardboard3
float specular_intensityOptional. The specular intensity of the Custom Model. Defaults to 0.1.
Table specular_colorOptional. The specular color of the Custom Model. Color values are 0 to 1. Defaults to {1, 1, 1}.
float specular_sharpnessOptional. The specular sharpness of the Custom Model. Defaults to 3.
float fresnel_strengthOptional. The fresnel strength of the Custom Model. Defaults to 0.1.
bool cast_shadowsOptional. Should the Custom Model cast shadows? Defaults to true.

Custom Tile

ParameterDescription
string imageThe image for the Custom Tile.
int type Optional. The type of the Custom Tile. This is the shape of the Custom Tile. Defaults to rectangle.

Tile TypeValue
Box0
Hex1
Round2
string image_bottomOptional. The bottom image for the Custom Tile. Defaults to the top image.
float thicknessOptional. The thickness of the Custom Tile. Defaults to 0.5.
bool stackableOptional. Is this Custom Tile stackable? Defaults to false.

Custom Token

ParameterDescription
string imageThe image for the Custom Token.
float thicknessOptional. The thickness of the Custom Token. Defaults to 0.2.
float merge_distanceOptional. How accurate the edges of the Custom Token are to the image. Defaults to 15.
bool stackableOptional. Is this Custom Token stackable? Defaults to false.

Custom AssetBundle

ParameterDescription
string assetbundleThe assetbundle for the Custom AssetBundle.
string assetbundle_secondaryOptional. The secondary assetbundle for the Custom AssetBundle.
int type Optional. The type of the Custom AssetBundle. Defaults to Generic.

TypeValue
Generic0
Figurine1
Dice2
Coin3
Board4
Chip5
Bag6
Infinite7
int material Optional. The material of the Custom AssetBundle. Defaults to Plastic.

MaterialValue
Plastic0
Wood1
Metal2
Cardboard3