Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IGameConfig

Game configuration.

Hierarchy

  • IGameConfig

Index

Properties

Optional assetOptions

assetOptions: IAssetOptions

Asset library initialization options

Optional collisionMatrix

collisionMatrix: never[]

For internal use.

Optional customJointTextureLayouts

customJointTextureLayouts: ICustomJointTextureLayout[]

GPU instancing options

Optional debugMode

debugMode: 0 | 1 | 2 | 3 | 4 | 5 | 6

Set debug mode, only valid in non-browser environment. Possible values: 0 - No message will be printed. 1 - errorassertwarnlog will print in console. 2 - errorassertwarn will print in console. 3 - errorassert will print in console. 4 - errorassertwarnlog will print on canvas, available only on web. 5 - errorassertwarn will print on canvas, available only on web. 6 - errorassert will print on canvas, available only on web.

Optional exposeClassName

exposeClassName: undefined | false | true

Expose class name to chrome debug tools, the class intantiate performance is a little bit slower when exposed.

Optional frameRate

frameRate: undefined | number

Set the wanted frame rate for your game, but the real fps depends on your game implementation and the running environment.

Optional groupList

groupList: any[]

For internal use.

Optional id

id: string | HTMLElement

Sets the id of your canvas element on the web page, it's useful only on web.

Optional jsList

jsList: string[]

For internal use.

Optional physics

physics: IPhysicsConfig

Physics system config

Optional registerSystemEvent

registerSystemEvent: undefined | false | true

For internal use.

Optional renderMode

renderMode: 0 | 1 | 2

Sets the renderer type, only useful on web:

  • 0 - Automatically chosen by engine.
  • 1 - Forced to use canvas renderer.
  • 2 - Forced to use WebGL renderer, but this will be ignored on mobile browsers.

Optional renderPipeline

renderPipeline: undefined | string

Render pipeline resources

Optional scenes

scenes: ISceneInfo[]

Include available scenes in the current bundle.

Optional showFPS

showFPS: undefined | false | true

Left bottom corner fps information will show when "showFPS" equals true, otherwise it will be hide.

Generated using TypeDoc