Class ThreeDDice

ThreeDDice Class

Hierarchy

ThreeDDice

Index

Properties

DICE_ON_TABLE_LIMIT DefaultConfig api? apiKey? canvas?

Constructors

Accessors

controlsEnabled height isDiceThrowing version width

Properties

`Static` DICE_ON_TABLE_LIMIT

DICE_ON_TABLE_LIMIT: number = 25

Limit of 3D dice to allow on table at any one time

`Static` DefaultConfig

DefaultConfig: IEngineConfig = ...

Default Config

`Optional` api

api?: ThreeDDiceAPI

API Connection

Available after calling connect

`Optional` apiKey

apiKey?: string

API Key

`Optional` canvas

canvas?: HTMLCanvasElement

Canvas

Constructors

constructor

new ThreeDDice(canvas?: HTMLCanvasElement, apiKey?: string, config?: Partial<IEngineConfig>): ThreeDDice
Construct and initialize the object
Parameters
- Optional canvas: HTMLCanvasElement
  
  Canvas element
- Optional apiKey: string
  
  Required if connecting to the dddice API
- Optional config: Partial<IEngineConfig>
  
  Optional configuration to change the look and feel of the renderer
Returns ThreeDDice

Methods

`Static` isWebGLAvailable

isWebGLAvailable(): boolean
Check if WebGL is available

Returns boolean

clear

clear(): void
Clear all dice from canvas

Returns void

connect

connect(roomSlug: string, roomPasscode?: string, userUuid?: string): ThreeDDice
Connect to the live server and begin listening to room events.

Note: Your user must be a participant in a room in order to listen to events, otherwise an error is thrown.
Parameters
- roomSlug: string
  
  Room slug to listen on
- Optional roomPasscode: string
  
  Private passcode to access room
- Optional userUuid: string
  
  Personal User UUID to listen to whispers
Returns ThreeDDice

disconnect

disconnect(): ThreeDDice
Connect to the live server and begin listening to room events.

Note: Your user must be a participant in a room in order to listen to events, otherwise an error is thrown.

Returns ThreeDDice

dispatch

dispatch(event: DiceEvent | ThreeDDiceRollEvent | RoomUpdated | AddDie, ...params: any[]): ThreeDDice
Manually trigger an event
Parameters
- event: DiceEvent | ThreeDDiceRollEvent | RoomUpdated | AddDie
  
  The event to dispatch
- Rest ...params: any[]
Returns ThreeDDice

getTheme

getTheme(themeId: string): ITheme
Return a loaded theme
Parameters
- themeId: string
Returns ITheme

getThemes

getThemes(): ITheme[]
Return all loaded themes

Returns ITheme[]

initialize

initialize(canvas?: HTMLCanvasElement, apiKey?: string, config?: Partial<IEngineConfig>, appName?: string): ThreeDDice
Initialize object if the default constructor had been called
Parameters
- Optional canvas: HTMLCanvasElement
  
  Canvas element
- Optional apiKey: string
  
  Required if connecting to the dddice API
- Optional config: Partial<IEngineConfig>
  
  Optional configuration to change the look and feel of the renderer
- Optional appName: string
  
  Optional name to identify which application is connecting to dddice
Returns ThreeDDice

loadTheme

loadTheme(theme: ITheme, overwriteTheme?: boolean, fetchPreviews?: boolean): ThreeDDice
Load a theme, including shaders, into the engine
Parameters
- theme: ITheme
- overwriteTheme: boolean = false
- fetchPreviews: boolean = true
Returns ThreeDDice

off

off(event: ThreeDDiceRollEvent | RoomUpdated): ThreeDDice
Remove callback from event
Parameters
- event: ThreeDDiceRollEvent | RoomUpdated
  
  The event to stop listening to
Returns ThreeDDice

on

on(event: DiceEvent, callback: DiceEventCallback): ThreeDDice
Listen for an event and execute a callback.
Parameters
- event: DiceEvent
  
  The event to listen on
- callback: DiceEventCallback
  
  The function to execute when the event is fired
Returns ThreeDDice
on(event: RoomUpdated, callback: RoomEventCallback): ThreeDDice
Parameters
- event: RoomUpdated
- callback: RoomEventCallback
Returns ThreeDDice
on(event: ThreeDDiceRollEvent, callback: RollEventCallback): ThreeDDice
Parameters
- event: ThreeDDiceRollEvent
- callback: RollEventCallback
Returns ThreeDDice

pause

pause(): void
Pause camera controls

Returns void

pickUpRoll

pickUpRoll(roll: IRoll | IRoll[], uuids?: string[]): Promise<IApiResponse<"roll[]", IRoll[]>>
Pick up dice

This clears certain dice from the board and updates the API

Returns
void

Throws
APIError if connect not called previously
Parameters
- roll: IRoll | IRoll[]
  
  single roll or array of rolls
- uuids: string[] = []
  
  Optional array of dice uuids
Returns Promise<IApiResponse<"roll[]", IRoll[]>>

loadThemeResources

loadThemeResources(id: string, processQueue?: boolean): string[]
Load assets for a loaded theme

This loads all meshes, textures, and sounds for a dice theme. Calling this multiple times will debounce the loading processing for 50ms

Returns a list of items to be queued
Parameters
- id: string
- processQueue: boolean = true
Returns string[]

resetCamera

resetCamera(): void
Reset camera frame

After disabling camera controls, this can be used to reset the camera view to a top-down angle

Returns void

resize

resize(width: number, height: number): ThreeDDice
Resize canvas
Parameters
- width: number
  
  Width of canvas in pixels
- height: number
  
  Height of canvas in pixels
Returns ThreeDDice

resume

resume(): void
Resume camera controls

Returns void

roll

roll(dice: IDiceRoll[], options?: IDiceRollOptions): Promise<IApiResponse<"roll", IRoll>>
Roll dice using the dddice API. This method submits the roll to the server to be distributed to all room participants.

Throws
APIError if connect not called previously
Parameters
- dice: IDiceRoll[]
- Optional options: IDiceRollOptions
Returns Promise<IApiResponse<"roll", IRoll>>

screenshot

screenshot(mimeType: string): undefined | string
Screenshot the canvas

Returns
screenshot as a DataURI
Parameters
- mimeType: string
  
  image format mime type of the generated screenshot.
Returns undefined | string

setConfig

setConfig(config: Partial<IEngineConfig>): void
Set configuration
Parameters
- config: Partial<IEngineConfig>
Returns void

start

start(): ThreeDDice
Start the renderer

Returns ThreeDDice

stop

stop(): ThreeDDice
Stop the renderer

Returns ThreeDDice

unhideRoll

unhideRoll(roll: IRoll, uuids?: string[]): Promise<IApiResponse<"roll", IRoll>>
Change the hidden state of a roll

Optionally pass the uuids of specific dice to only unhide those dice, otherwise all dice in the roll will be revealed.

Returns
void

Throws
APIError if connect not called previously
Parameters
- roll: IRoll
  
  IRoll Roll to unhide
- uuids: string[] = []
  
  Optional array of dice uuids
Returns Promise<IApiResponse<"roll", IRoll>>

Accessors

controlsEnabled

get controlsEnabled(): boolean
Get mouse/pointer controls enabled

Returns boolean
set controlsEnabled(enabled: boolean): void
Set mouse/pointer controls enabled
Parameters
- enabled: boolean
Returns void

height

get height(): number
Canvas Height

Returns number

isDiceThrowing

get isDiceThrowing(): boolean
Get if a roll is currently animating

Returns boolean

version

get version(): string
Get the current version of dddice

Returns string

width

get width(): number
Canvas width

Returns number

Generated using TypeDoc