Class default`Abstract`

Hierarchy

Host<IStatusEffectEvents>
- default
  - default
  - default
  - default
  - default
  - default
  - default
  - default
  - default
  - default

Index

Constructors

Properties

Accessors

Constructors

constructor

new default(type: StatusType, entity?: default<unknown, number, unknown>): default
Parameters
- type: StatusType
- Optional entity: default<unknown, number, unknown>
Returns default
Overrides Host.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>
- 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
- 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
- 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
- Defined in src/game/game/entity/status/StatusEffect.ts:266

getBadness

getBadness(): StatusEffectBadness
Returns StatusEffectBadness
- Defined in src/game/game/entity/status/StatusEffect.ts:228

getDefaultRenderer

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

getDescription

getDescription(): default
Returns default
- Defined in src/game/game/entity/status/StatusEffect.ts:236

`Protected` getEffectRate

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

getHighlight

getHighlight(): undefined | IHighlight
Returns undefined | IHighlight
- Defined in src/game/game/entity/status/StatusEffect.ts:197

getIcon

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

getLevel

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

Returns number
- Defined in src/game/game/entity/status/StatusEffect.ts:224

getOptions

getOptions(): IGameOptionsStatusEffect
Returns IGameOptionsStatusEffect
- 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]
- Defined in src/game/game/entity/status/StatusEffect.ts:189

getRenderer

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

getTranslation

getTranslation(which?: Adjective | Name): default
Parameters
- Optional which: Adjective | Name
Returns default
- Defined in src/game/game/entity/status/StatusEffect.ts:232

isActive

isActive(): number
Returns number
- 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
- 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
- Defined in src/game/game/entity/status/StatusEffect.ts:264

refresh

refresh(): void
Returns void
- Defined in src/game/game/entity/status/StatusEffect.ts:241

register

register(): void
Returns void
- Defined in src/game/game/entity/status/StatusEffect.ts:148

remove

remove(reason?: StatusEffectChangeReason): default
Parameters
- reason: StatusEffectChangeReason = StatusEffectChangeReason.Passed
Returns default
- 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
- 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
- Defined in src/game/game/entity/status/StatusEffect.ts:217

`Static` update

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

Generated using TypeDoc