Class FieldOfView

Hierarchy

Host<IFieldOfViewEvents>
- FieldOfView

Index

Constructors

Properties

blurEnabled computeOffset context disabled event maxRadius radius rendererPlatform transitionProgress

Accessors

Methods

compute delete getSubdivisions getTextureSize initialize resetTransitionProgress startTransition updateExplored updateRadius updateTransitionProgress canSeePosition getBounds getRadius

Constructors

constructor

new FieldOfView(context: IRendererContext, worldRenderer: WorldRenderer, radius: number, maxRadius: number, subdivisions?: number): FieldOfView
Parameters
- context: IRendererContext
- worldRenderer: WorldRenderer
- radius: number
- maxRadius: number
- subdivisions: number = 1
Returns FieldOfView
Overrides EventEmitter.Host<IFieldOfViewEvents>.constructor
- Defined in src/game/renderer/fieldOfView/FieldOfView.ts:191

Properties

blurEnabled

blurEnabled: boolean

computeOffset

computeOffset: default = Vector2.ZERO

`Protected` `Readonly` context

context: IRendererContext

disabled

disabled: boolean

`Readonly` event

event: IEventEmitter<FieldOfView, IFieldOfViewEvents>

maxRadius

maxRadius: number

radius

radius: number

`Readonly` rendererPlatform

rendererPlatform: IFieldOfViewPlatform

Marks a set of tiles as explored

transitionProgress

transitionProgress: number = 1

Accessors

`Static` instance

get instance(): IFieldOfViewCPP
Returns IFieldOfViewCPP
- Defined in src/game/renderer/fieldOfView/FieldOfView.ts:45

Methods

compute

compute(timeStamp: number, force?: boolean, skipTransition?: boolean): boolean
Parameters
- timeStamp: number
- Optional force: boolean
- Optional skipTransition: boolean
Returns boolean
- Defined in src/game/renderer/fieldOfView/FieldOfView.ts:306

delete

delete(): void
Returns void
- Defined in src/game/renderer/fieldOfView/FieldOfView.ts:211

getSubdivisions

getSubdivisions(): number
Returns number
- Defined in src/game/renderer/fieldOfView/FieldOfView.ts:247

getTextureSize

getTextureSize(): number
Returns number
- Defined in src/game/renderer/fieldOfView/FieldOfView.ts:243

initialize

initialize(): void
Returns void
- Defined in src/game/renderer/fieldOfView/FieldOfView.ts:217

resetTransitionProgress

resetTransitionProgress(): void
Returns void
- Defined in src/game/renderer/fieldOfView/FieldOfView.ts:275

startTransition

startTransition(timeStamp: number): void
Parameters
- timeStamp: number
Returns void
- Defined in src/game/renderer/fieldOfView/FieldOfView.ts:251

updateExplored

updateExplored(updateForGhosts?: boolean): void
Updates the explored tiles around players
Parameters
- updateForGhosts: boolean = false
  
  Update field of ghosts too
Returns void
- Defined in src/game/renderer/fieldOfView/FieldOfView.ts:353

updateRadius

updateRadius(player: default): void
Parameters
- player: default
Returns void
- Defined in src/game/renderer/fieldOfView/FieldOfView.ts:223

updateTransitionProgress

updateTransitionProgress(timeStamp: number): boolean
Parameters
- timeStamp: number
Returns boolean
- Defined in src/game/renderer/fieldOfView/FieldOfView.ts:258

`Static` canSeePosition

canSeePosition(origin: IFieldOfViewOrigin, type: CanASeeBType, islandId: `${number},${number}`, tileX: number, tileY: number, tileZ: number, fieldOfView?: undefined | FieldOfView, customRadius?: number): boolean
Note: CanASeeBType.ClientSide is used to skip adding a sync check for the result
Parameters
- origin: IFieldOfViewOrigin
- type: CanASeeBType
- islandId: `${number},${number}`
- tileX: number
- tileY: number
- tileZ: number
- fieldOfView: undefined | FieldOfView = renderer.fieldOfView
- Optional customRadius: number
Returns boolean
- Defined in src/game/renderer/fieldOfView/FieldOfView.ts:62

`Static` getBounds

getBounds(origin: IVector3, mapSize: number, radius: number): IBound3
Parameters
- origin: IVector3
- mapSize: number
- radius: number
Returns IBound3
- Defined in src/game/renderer/fieldOfView/FieldOfView.ts:127

`Static` getRadius

getRadius(fieldOfView: undefined | FieldOfView, human: undefined | default<unknown, number, NPC | Player>): number
Gets the field of view radius based on either the field of view object, player, or the default value
Parameters
- fieldOfView: undefined | FieldOfView
- human: undefined | default<unknown, number, NPC | Player>
Returns number
- Defined in src/game/renderer/fieldOfView/FieldOfView.ts:150

Generated using TypeDoc