Class default

Hierarchy

default
- default

Index

Constructors

constructor

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

Properties

`Readonly` event

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

`Readonly` type

type: StatusType

Accessors

`Protected` entity

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

Methods

add

add(reason?: StatusEffectChangeReason, level?: number): default
Parameters
- reason: StatusEffectChangeReason = StatusEffectChangeReason.Gained
- level: number = 1
Returns default
Inherited from default.add
- Defined in src/game/game/entity/status/StatusEffect.ts:205

`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/StatusEffect.ts:276

`Protected` 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/StatusEffect.ts:266

getBadness

getBadness(): Neutral | Bad
Returns Neutral | Bad
Overrides default.getBadness
- Defined in src/game/game/entity/status/handler/Encumbered.ts:55

getDefaultRenderer

getDefaultRenderer(): undefined | default
Returns undefined | default
Inherited from default.getDefaultRenderer
- Defined in src/game/game/entity/status/StatusEffect.ts:177

getDescription

getDescription(): default
Returns default
Overrides default.getDescription
- Defined in src/game/game/entity/status/handler/Encumbered.ts:63

`Protected` getEffectRate

getEffectRate(): number
Returns number
Inherited from default.getEffectRate
- Defined in src/game/game/entity/status/StatusEffect.ts:245

getHighlight

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

getIcon

getIcon(): undefined | IStatusEffectIconDescription
Returns undefined | IStatusEffectIconDescription
Inherited from default.getIcon
- Defined in src/game/game/entity/status/StatusEffect.ts:193

getLevel

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

Returns 0 | WeightStatus
Overrides default.getLevel
- Defined in src/game/game/entity/status/handler/Encumbered.ts:43

getOptions

getOptions(): IGameOptionsStatusEffect
Returns IGameOptionsStatusEffect
Inherited from default.getOptions
- Defined in src/game/game/entity/status/StatusEffect.ts:138

getParticles

getParticles(_event: StatusEffectParticleEvent): undefined | [number, IRGB]
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: StatusEffectParticleEvent
  
  The event that could cause particles, IE turn or tick.
Returns undefined | [number, IRGB]
Inherited from default.getParticles
- Defined in src/game/game/entity/status/StatusEffect.ts:189

getRenderer

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

getTranslation

getTranslation(): default
Returns default
Overrides default.getTranslation
- Defined in src/game/game/entity/status/handler/Encumbered.ts:59

isActive

isActive(): number
Returns number
Inherited from default.isActive
- Defined in src/game/game/entity/status/StatusEffect.ts:201

`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/StatusEffect.ts:259

`Protected` 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/StatusEffect.ts:264

refresh

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

register

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

remove

remove(reason?: StatusEffectChangeReason): default
Parameters
- reason: StatusEffectChangeReason = StatusEffectChangeReason.Passed
Returns default
Inherited from default.remove
- Defined in src/game/game/entity/status/StatusEffect.ts:211

`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/StatusEffect.ts:252

toggle

toggle(has: boolean, reason?: StatusEffectChangeReason): default
Parameters
- has: boolean
- Optional reason: StatusEffectChangeReason
Returns default
Inherited from default.toggle
- Defined in src/game/game/entity/status/StatusEffect.ts:217

`Static` update

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

Class default

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

type: StatusType

Optional entity: default<unknown, number, unknown>

Returns default

Properties

Readonly event

Readonly type

Accessors

Protected entity

Returns default<unknown, number, unknown>

Methods

add

Parameters

reason: StatusEffectChangeReason = StatusEffectChangeReason.Gained

level: number = 1

Returns default

Protected createParticles

Particle tuple parameters:

Parameters

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

Returns void

Protected damageEntity

Parameters

damage: number

deathMessage: default

Optional blood: boolean

Returns undefined | number

getBadness

Returns Neutral | Bad

getDefaultRenderer

Returns undefined | default

getDescription

Returns default

Protected getEffectRate

Returns number

getHighlight

Returns IHighlight

getIcon

Returns undefined | IStatusEffectIconDescription

getLevel

Returns 0 | WeightStatus

getOptions

Returns IGameOptionsStatusEffect

getParticles

Returns

Particle tuple parameters:

Parameters

_event: StatusEffectParticleEvent

Returns undefined | [number, IRGB]

getRenderer

Returns undefined | default

getTranslation

Returns default

isActive

Returns number

Protected onPassed

Parameters

level: number

Returns void

Protected onTick

Returns void

refresh

Returns void

register

Returns void

remove

Parameters

reason: StatusEffectChangeReason = StatusEffectChangeReason.Passed

Returns default

Protected shouldPass

Returns boolean

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

`Readonly` event

`Readonly` type

`Protected` entity

`Protected` createParticles

`Protected` damageEntity

`Optional` blood: boolean

`Protected` getEffectRate

`Protected` onPassed

`Protected` onTick

`Protected` shouldPass

`Optional` reason: StatusEffectChangeReason

`Static` update