Class default

Hierarchy

default
- default

Index

Constructors

constructor

new default(type: StatusType, entity?: default<unknown, number, EntityReferenceTypes, unknown>): default
Parameters
- type: StatusType
- Optional entity: default<unknown, number, EntityReferenceTypes, unknown>
Returns default
Inherited from default.constructor
- Defined in src/game/game/entity/status/Status.ts:126

Properties

`Readonly` event

event: IEventEmitter<default, IStatusEvents>

`Readonly` type

type: StatusType

Accessors

context

get context(): default
Returns default
Inherited from Status.context
- Defined in src/game/game/entity/status/Status.ts:122

description

get description(): undefined | IStatusDescription
Returns undefined | IStatusDescription
Inherited from Status.description
- Defined in src/game/game/entity/status/Status.ts:135

entity

get entity(): default<unknown, number, EntityReferenceTypes, unknown>
Returns default<unknown, number, EntityReferenceTypes, unknown>
Inherited from Status.entity
- Defined in src/game/game/entity/status/Status.ts:139

Methods

add

add(reason?: StatusChangeReason, level?: number, force?: boolean, oldLevel?: number): default
Parameters
- reason: StatusChangeReason = StatusChangeReason.Gained
- level: number = 1
- force: boolean = false
- oldLevel: number = ...
Returns default
Inherited from default.add
- Defined in src/game/game/entity/status/Status.ts:208

`Protected` createParticles

createParticles(__namedParameters?: [number, IRGB] | [0]): void
Creates particle events from the 2-value tuple provided.

Particle tuple parameters:
Parameters
- __namedParameters: [number, IRGB] | [0] = ...
Returns void
Inherited from default.createParticles
- Defined in src/game/game/entity/status/Status.ts:328

damageEntity

damageEntity(damage: number, deathMessage: default, blood?: boolean): undefined | number
Parameters
- damage: number
- deathMessage: default
- Optional blood: boolean
Returns undefined | number
Inherited from default.damageEntity
- Defined in src/game/game/entity/status/Status.ts:312

getEffects

getEffects(): StatusEffectList
Returns StatusEffectList
Overrides default.getEffects
- Defined in src/game/game/entity/status/handler/Starving.ts:63

getHighlight

getHighlight(): IHighlight
Returns IHighlight
Overrides default.getHighlight
- Defined in src/game/game/entity/status/handler/Starving.ts:37

getIcon

getIcon(): undefined | IStatusIconDescription
Returns undefined | IStatusIconDescription
Inherited from default.getIcon
- Defined in src/game/game/entity/status/Status.ts:195

getInterval

getInterval(): number
Returns number
Inherited from default.getInterval
- Defined in src/game/game/entity/status/Status.ts:290

getLevel

getLevel(): HungerLevel
Returns the "level" of this status effect. Higher levels mean greater effects. A level of 0 means no effect.

Returns HungerLevel
Overrides default.getLevel
- Defined in src/game/game/entity/status/handler/Starving.ts:50

getOptions

getOptions(): IGameOptionsStatus
Returns IGameOptionsStatus
Inherited from default.getOptions
- Defined in src/game/game/entity/status/Status.ts:148

getParticles

getParticles(event: StatusParticleEvent): undefined | StatusParticle
Gets the particle events for the given

Returns
A 2-value tuple describing the particle effect, or undefined if there should be no particles.

Particle tuple parameters:
Parameters
- event: StatusParticleEvent
  
  The event that could cause particles, IE turn or tick.
Returns undefined | StatusParticle
Inherited from default.getParticles
- Defined in src/game/game/entity/status/Status.ts:191

getRenderer

getRenderer(): undefined | default
Returns undefined | default
Inherited from default.getRenderer
- Defined in src/game/game/entity/status/Status.ts:179

getThreatLevel

getThreatLevel(): StatusThreatLevel
Returns StatusThreatLevel
Inherited from default.getThreatLevel
- Defined in src/game/game/entity/status/Status.ts:257

getTranslation

getTranslation(which?: StatusTranslation): undefined | default
Parameters
- Optional which: StatusTranslation
Returns undefined | default
Inherited from default.getTranslation
- Defined in src/game/game/entity/status/Status.ts:267

isActive

isActive(): boolean
Returns boolean
Inherited from default.isActive
- Defined in src/game/game/entity/status/Status.ts:203

`Protected` onPassed

onPassed(level: number): void
Event handler for when the status effect passes.
Parameters
- level: number
Returns void
Inherited from default.onPassed
- Defined in src/game/game/entity/status/Status.ts:305

`Protected` `Optional` onTick

onTick(): void
Event handler for every tick that the human has the status effect.

Returns void
Inherited from default.onTick
- Defined in src/game/game/entity/status/Status.ts:310

refresh

refresh(): void
Returns void
Overrides default.refresh
- Defined in src/game/game/entity/status/handler/Starving.ts:45

register

register(): void
Returns void
Overrides default.register
- Defined in src/game/game/entity/status/handler/Starving.ts:32

remove

remove(reason?: StatusChangeReason): default
Parameters
- reason: StatusChangeReason = StatusChangeReason.Passed
Returns default
Inherited from default.remove
- Defined in src/game/game/entity/status/Status.ts:227

`Protected` shouldPass

shouldPass(): boolean
Whether the status effect should pass (be removed from the human).

Returns boolean
Inherited from default.shouldPass
- Defined in src/game/game/entity/status/Status.ts:298

toggle

toggle(level: number, reason?: StatusChangeReason): default
Parameters
- level: number
- Optional reason: StatusChangeReason
Returns default
Inherited from default.toggle
- Defined in src/game/game/entity/status/Status.ts:242
toggle(has: boolean, reason?: StatusChangeReason): default
Parameters
- has: boolean
- Optional reason: StatusChangeReason
Returns default
Inherited from default.toggle
- Defined in src/game/game/entity/status/Status.ts:243

`Static` getOptions

getOptions(type: StatusType, entity?: default<unknown, number, EntityReferenceTypes, unknown>): IGameOptionsStatus
Parameters
- type: StatusType
- entity: default<unknown, number, EntityReferenceTypes, unknown> = localPlayer
Returns IGameOptionsStatus
Inherited from default.getOptions
- Defined in src/game/game/entity/status/Status.ts:71

`Static` update

update(status: default): void
Parameters
- status: default
Returns void
Inherited from default.update
- Defined in src/game/game/entity/status/Status.ts:81

Class default

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

type: StatusType

Optional entity: default<unknown, number, EntityReferenceTypes, unknown>

Returns default

Properties

Readonly event

Readonly type

Accessors

context

Returns default

description

Returns undefined | IStatusDescription

entity

Returns default<unknown, number, EntityReferenceTypes, unknown>

Methods

add

Parameters

reason: StatusChangeReason = StatusChangeReason.Gained

level: number = 1

force: boolean = false

oldLevel: number = ...

Returns default

Protected createParticles

Particle tuple parameters:

Parameters

__namedParameters: [number, IRGB] | [0] = ...

Returns void

damageEntity

Parameters

damage: number

deathMessage: default

Optional blood: boolean

Returns undefined | number

getEffects

Returns StatusEffectList

getHighlight

Returns IHighlight

getIcon

Returns undefined | IStatusIconDescription

getInterval

Returns number

getLevel

Returns HungerLevel

getOptions

Returns IGameOptionsStatus

getParticles

Returns

Particle tuple parameters:

Parameters

event: StatusParticleEvent

Returns undefined | StatusParticle

getRenderer

Returns undefined | default

getThreatLevel

Returns StatusThreatLevel

getTranslation

Parameters

Optional which: StatusTranslation

Returns undefined | default

isActive

Returns boolean

Protected onPassed

Parameters

level: number

Returns void

Protected Optional onTick

Returns void

refresh

Returns void

register

Returns void

`Optional` entity: default<unknown, number, EntityReferenceTypes, unknown>

`Readonly` event

`Readonly` type

`Protected` createParticles

`Optional` blood: boolean

`Optional` which: StatusTranslation

`Protected` onPassed

`Protected` `Optional` onTick

`Protected` shouldPass

`Optional` reason: StatusChangeReason

`Optional` reason: StatusChangeReason

`Static` getOptions

`Static` update