Custom

You can spawn custom Objects and then provide the custom content for them after spawning them by calling setCustomObject(). See setCustomObject for usage

You can also use setCustomObject along with reload() to modify an existing custom Object.

Custom AssetBundle

• Custom_Assetbundle

Custom Parameters

• parameters: A Table of parameters which determine the properties of the Object.
  • assetbundle: The path/URL for the AssetBundle.
  • assetbundle_secondary: The path/URL for the secondary AssetBundle property.
    • Optional, is not used by default.
  • type: An Int representing the Object's type.
    • Optional, defaults to 0.
      • 0: Generic
      • 1: Figurine
      • 2: Dice
      • 3: Coin
      • 4: Board
      • 5: Chip
      • 6: Bag
      • 7: Infinite bag
  • material: An Int representing the Object's material.
    • Optional, defaults to 0.
      • 0: Plastic
      • 1: Wood
      • 2: Metal
      • 3: Cardboard

Custom Board

• Custom_Board

Custom Parameters

• parameters: A Table of parameters which determine the properties of the Object.
  • image: The path/URL for the board.

Custom Card

• CardCustom

Custom Parameters

• parameters: A Table of parameters which determine the properties of the Object.
  • type: The card shape.
    • Optional, defaults to 0.
      • 0: Rectangle (Rounded)
      • 1: Rectangle
      • 2: Hex (Rounded)
      • 3: Hex
      • 4: Circle
  • face: The path/URL of the face image.
  • back: The path/URL of the back image.
  • sideways: If the card is horizontal, instead of vertical.
    • Optional, defaults to false.

Custom Deck

• DeckCustom

Custom Parameters

• parameters: A Table of parameters which determine the properties of the Object.
  • face: The path/URL of the face cardsheet.
  • back: The path/URL of the back cardsheet or card back.
  • unique_back: If each card has a unique card back (via a cardsheet).
    • Optional, defaults to false.
  • width: The number of columns on the cardsheet.
    • Optional, defaults to 10.
  • height: The number of rows on the cardsheet.
    • Optional, defaults to 7.
  • number: The number of cards on the cardsheet.
    • Optional, defaults to 52.
  • sideways: Whether the cards are horizontal, instead of vertical.
    • Optional, defaults to false.
  • back_is_hidden: Whether the card back should be used as the hidden image (instead of the last slot of the face image).
    • Optional, defaults to false.

Custom Dice

• Custom_Dice

Custom Parameters

• parameters: A Table of parameters which determine the properties of the Object.
  • image: The path/URL for the custom die.
  • type: The type of die, which determines its number of sides.
    • Optional, defaults to 1.
      • 0: 4-sided
      • 1: 6-sided
      • 2: 8-sided
      • 3: 10-sided
      • 4: 12-sided
      • 5: 20-sided

Custom Figurine

• Figurine_Custom

Custom Parameters

• parameters: A Table of parameters which determine the properties of the Object.
  • image: The path/URL for the custom figurine.
  • image_secondary: The path/URL for the custom figurine's back.
    • Optional, defaults to "image".

Custom Model

• Custom_Model

Custom Parameters

• parameters: A Table of parameters which determine the properties of the Object.
  • mesh: The path/URL for the .obj mesh used on the custom model.
  • diffuse: The path/URL for the diffuse image.
  • normal: The path/URL for the normals image.
    • Optional, is not used by default.
  • collider: The path/URL for the collider mesh.
    • Optional, defaults to a generic box collider.
  • convex: Whether the object model is convex.
    • Optional, defaults to false.
  • type: An Int representing the Object's type.
    • Optional, defaults to 0.
      • 0: Generic
      • 1: Figurine
      • 2: Dice
      • 3: Coin
      • 4: Board
      • 5: Chip
      • 6: Bag
      • 7: Infinite bag
  • material: An Int representing the Object's material.
    • Optional, defaults to 0.
      • 0: Plastic
      • 1: Wood
      • 2: Metal
      • 3: Cardboard
  • specular_intensity: The specular intensity.
    • Optional, defaults to 0.1.
  • specular_color: The specular Color.
    • Optional, defaults to {r=1, g=1, b=1}.
  • specular_sharpness: The specular sharpness.
    • Optional, defaults to 3.
  • freshnel_strength: The freshnel strength.
    • Optional, defaults to 0.1.
  • cast_shadows: Whether the Object casts shadows.
    • Optional, defaults to true.

Custom Tile

• Custom_Tile

Custom Parameters

• parameters: A Table of parameters which determine the properties of the Object.
  • image: The path/URL for the custom tile image.
  • type: Determines the shape of the tile.
    • Optional, defaults to 0.
      • 0: Square/Rectangle
      • 1: Hex
      • 2: Circle
  • image_bottom: The path/URL for the bottom-side image.
    • Optional, uses the top image by default.
  • thickness: How thick the tile is.
    • Optional, defaults to 0.5.
  • stackable: Whether these tiles stack together into a pile.
    • Optional, defaults to false.

Custom Token

• Custom_Token

Custom Parameters

• parameters: A Table of parameters which determine the properties of the Object.
  • image: The path/URL for the custom token image.
  • thickness: How thick the token is.
    • Optional, defaults to 0.2.
  • merge_distance: How accurately the token shape will trace image edge (in pixels).
    • Optional, defaults to 15.
  • stackable: Whether these tokens stack together into a pile.
    • Optional, defaults to false.