Class default

Hierarchy

Host<IRendererEvents>
- default

Constructors

constructor

new default(canvasElement: HTMLCanvasElement): default
Parameters
- canvasElement: HTMLCanvasElement
Returns default
Overrides Host.constructor
- Defined in src/game/renderer/Renderer.ts:145

Properties

`Readonly` event

event: IEventEmitter<default, IRendererEvents> = ...

`Readonly` id

id: number

worldRenderer

worldRenderer: default

Accessors

fieldOfView

get fieldOfView(): default
Returns default
- Defined in src/game/renderer/Renderer.ts:243

isFadingIn

get isFadingIn(): boolean
Returns boolean
- Defined in src/game/renderer/Renderer.ts:255

isUpdatingThumbnail

get isUpdatingThumbnail(): boolean
Returns boolean
- Defined in src/game/renderer/Renderer.ts:259

island

get island(): undefined | default
The island the renderer is rendering. Could be undefined if the renderer has not had it's origin set.

Returns undefined | default
- Defined in src/game/renderer/Renderer.ts:267

islandId

get islandId(): undefined | `${number},${number}`
The island id the renderer is rendering. Could be undefined if the renderer has not had it's origin set.

Returns undefined | `${number},${number}`
- Defined in src/game/renderer/Renderer.ts:275

notifier

get notifier(): default
Returns default
- Defined in src/game/renderer/Renderer.ts:247

particle

get particle(): default
Returns default
- Defined in src/game/renderer/Renderer.ts:251

Methods

addOrUpdateOverlay

addOrUpdateOverlay(tile: default, overlay: IOverlayInfo): void
Parameters
- tile: default
- overlay: IOverlayInfo
Returns void
- Defined in src/game/renderer/Renderer.ts:535

addZoomLevel

addZoomLevel(amount: number): void
Parameters
- amount: number
Returns void
- Defined in src/game/renderer/Renderer.ts:376

computeSpritesInViewport

computeSpritesInViewport(): void
Returns void
- Defined in src/game/renderer/Renderer.ts:588

createFadeIn

createFadeIn(duration?: number): void
Parameters
- duration: number = defaultFadeInTime
Returns void
- Defined in src/game/renderer/Renderer.ts:431

delete

delete(reinitializing?: boolean): Promise<boolean>
Parameters
- Optional reinitializing: boolean
Returns Promise<boolean>
- Defined in src/game/renderer/Renderer.ts:200

getAmbientLightLevel

getAmbientLightLevel(z: number): number
Note: Don't inject here. This gets called ten million times. If you want to override this functionality, use calculateAmbientLightLevel
Parameters
- z: number
Returns number
- Defined in src/game/renderer/Renderer.ts:504

getBlackness

getBlackness(timeStamp: number): number
Returns
a value between 0 and 1. 0 being full black
Parameters
- timeStamp: number
Returns number
- Defined in src/game/renderer/Renderer.ts:442

getCameraPosition

getCameraPosition(timeStamp: number): IVector2
Parameters
- timeStamp: number
Returns IVector2
- Defined in src/game/renderer/Renderer.ts:409

getExactCameraPosition

getExactCameraPosition(timeStamp: number): default
Parameters
- timeStamp: number
Returns default
- Defined in src/game/renderer/Renderer.ts:425

getZoom

getZoom(): number
Returns number
- Defined in src/game/renderer/Renderer.ts:372

popState

popState(): void
Returns void
- Defined in src/game/renderer/Renderer.ts:299

pushState

pushState(): void
Returns void
- Defined in src/game/renderer/Renderer.ts:288

reinitialize

reinitialize(): Promise<void>
Returns Promise<void>
- Defined in src/game/renderer/Renderer.ts:160

removeOverlay

removeOverlay(tile: default, overlay: IOverlayInfo): void
Parameters
- tile: default
- overlay: IOverlayInfo
Returns void
- Defined in src/game/renderer/Renderer.ts:539

`Protected` renderLoop

renderLoop(timeStamp: number, viewportOffsetX: number): void
Parameters
- timeStamp: number
- viewportOffsetX: number
Returns void
- Defined in src/game/renderer/Renderer.ts:653

setOrigin

setOrigin(origin: IRendererOrigin): void
Parameters
- origin: IRendererOrigin
Returns void
- Defined in src/game/renderer/Renderer.ts:313

setViewportSize

setViewportSize(width: number, height: number): void
Parameters
- width: number
- height: number
Returns void
- Defined in src/game/renderer/Renderer.ts:355

shouldUpdate

shouldUpdate(updateOrigin: undefined | IVector4, flag?: UpdateRenderFlag): boolean
Determines if the renderer cares about an update based on the position of the update vs renderer origin
Parameters
- updateOrigin: undefined | IVector4
- Optional flag: UpdateRenderFlag
Returns boolean
- Defined in src/game/renderer/Renderer.ts:454

start

start(): void
Returns void
- Defined in src/game/renderer/Renderer.ts:279

stop

stop(): void
Returns void
- Defined in src/game/renderer/Renderer.ts:283

update

update(timeStamp: number): void
Parameters
- timeStamp: number
Returns void
- Defined in src/game/renderer/Renderer.ts:584

updateAmbientLightLevel

updateAmbientLightLevel(z: number): number
Parameters
- z: number
Returns number
- Defined in src/game/renderer/Renderer.ts:508

updateRender

updateRender(source: RenderSource, flag: UpdateRenderFlag): void
Parameters
- source: RenderSource
- flag: UpdateRenderFlag
Returns void
- Defined in src/game/renderer/Renderer.ts:488

updateThumbnail

updateThumbnail(): Promise<undefined | string>
Returns Promise<undefined | string>
- Defined in src/game/renderer/Renderer.ts:543

updateView

updateView(source: RenderSource, updateFov: boolean | FieldOfView | FieldOfViewSkipTransition): void
Parameters
- source: RenderSource
- updateFov: boolean | FieldOfView | FieldOfViewSkipTransition
Returns void
- Defined in src/game/renderer/Renderer.ts:519

updateZoomLevel

updateZoomLevel(): void
Returns void
- Defined in src/game/renderer/Renderer.ts:387

`Static` createWebGlContext

createWebGlContext(canvas: HTMLCanvasElement, desiredWebGlVersion?: number, desiredPowerPreference?: WebGLPowerPreference): Promise<default>
Creates a WebGl context that can be used for rendering the game

Returns
Parameters
- canvas: HTMLCanvasElement
  
  The canvas
- desiredWebGlVersion: number = webGlVersion
  
  Desired webgl version. Defaults to 2
- Optional desiredPowerPreference: WebGLPowerPreference
  
  Desired power preference
Returns Promise<default>
- Defined in src/game/renderer/Renderer.ts:73

`Static` `Protected` gameRenderLoop

gameRenderLoop(timeStamp: number): void
Game render loop. Not executed for the host in dedicated servers. Only executed for the primary renderer.
Parameters
- timeStamp: number
Returns void
- Defined in src/game/renderer/Renderer.ts:725

Generated using TypeDoc