Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GameConfig

Interface describing the 3D Game Configuration object, with configuration relevant to 3D Games

Hierarchy

Index

Properties

Methods

Properties

Optional Readonly backgroundColor

backgroundColor?: Color

Background Color for the Game; default value is black

Optional Readonly canvasDimensions

canvasDimensions?: Vec2

Dimensions of the Canvas; default value is (window.innerWidth, window.innerHeight)

Optional Readonly canvasId

canvasId?: string

ID of the Canvas; a Canvas will be created if not provided

Optional Readonly canvasParent

canvasParent?: string | HTMLElement

ID or HTMLElement of the container to place an automatically-created Canvas within

Optional Readonly controlScheme

controlScheme?: ControlScheme

Game Control Scheme; default value is 'keyboard'

Optional Readonly debugMode

debugMode?: boolean

Debug Mode, enabling game stat display; default value is false

Optional Readonly hideCursor

hideCursor?: boolean

Whether or not to hide the cursor on the game canvas

Optional Readonly shaders

shaders?: ShaderProgram[]

Shaders to register on init; overrides the default set if provided

Optional Readonly sounds

sounds?: { filePath: string; name: string }[]

Sounds to load on game init

Optional Readonly states

states?: State[]

3D State configuration

Optional Readonly text

text?: Omit<TextConfig, "renderer">

3D Text configuration; defaults to the built-in font + charset

Optional Readonly ui

ui?: Omit<UIConfig, "renderer">

3D UI configuration

Optional Readonly world

world?: { camera?: Partial<Omit<CameraConfig, "name">>; dimensions?: Vec3; textureAtlas?: TextureAtlas }

3D World configuration

Type declaration

Methods

Optional Readonly init

  • init(): void

  • Game init function; none is provided by default

    Returns void