Class Renderer

Hierarchy

Host<IRendererEvents>
- Renderer

Properties

canvasContext

canvasContext: CanvasRenderingContext2D | GPUCanvasContext

context

context: IRendererContext

`Readonly` event

event: IEventEmitter<Renderer, IRendererEvents>

`Readonly` id

id: number

worldRenderer

worldRenderer: WorldRenderer

Accessors

fieldOfView

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

isFadingIn

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

isUpdatingThumbnail

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

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:318

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:326

notifier

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

particle

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

Methods

addOrUpdateOverlay

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

addZoomLevel

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

computeSpritesInViewport

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

createFadeIn

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

delete

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

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:572

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:505

getCameraPosition

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

getExactCameraPosition

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

getZoom

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

popState

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

pushState

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

reinitialize

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

removeOverlay

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

renderLoop

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

setOrigin

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

setViewportSize

setViewportSize(width: number, height: number, forceUpdate?: boolean): boolean
Parameters
- width: number
- height: number
- Optional forceUpdate: boolean
Returns boolean
- Defined in src/game/renderer/Renderer.ts:406

shouldUpdate

shouldUpdate(updateOrigin: undefined | IVector4 | `${number},${number}`, 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 | `${number},${number}`
- Optional flag: UpdateRenderFlag
Returns boolean
- Defined in src/game/renderer/Renderer.ts:517

start

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

stop

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

updateAmbientLightLevel

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

updateRender

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

updateThumbnail

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

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:587

updateZoomLevel

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

`Static` create

create(createCanvasElement: HTMLCanvasElement | (() => HTMLCanvasElement)): Promise<Renderer>
Parameters
- createCanvasElement: HTMLCanvasElement | (() => HTMLCanvasElement)
Returns Promise<Renderer>
- Defined in src/game/renderer/Renderer.ts:155

`Static` createWebGlContext

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

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

`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:777

Generated using TypeDoc