Class Condition

A single condition entry in the Condition registry.

Hierarchy (View Summary)

RegistryEntry
- Condition

Index

Constructors

constructor

Properties

_id flags? hud journal mechanics name namespace showInAction showInBuffsTab showInDefense texture track

Accessors

Methods

_initialize localize prepareData toStatusEffect defineSchema

Constructors

constructor

new Condition(): Condition
Returns Condition
Inherited from RegistryEntry.constructor

Properties

_id

_id: string

`Optional`flags

flags?: object

hud

hud: { exclude: Set<string>; include: Set<string>; show: boolean }

Type declaration

exclude: Set<string>
Exclude from actors.

Has no effect if include set is defined
include: Set<string>
Show for actor types
show: boolean

journal

journal: string

mechanics

mechanics: { changes: object[]; contexts: Set<string>; flags: Set<string> }

name

name: string

namespace

namespace: string

showInAction

showInAction: boolean

showInBuffsTab

showInBuffsTab: boolean

showInDefense

showInDefense: boolean

texture

texture: string

track

track: null | (keyof readonly ["dying", "fear", "lethargy", "movement"])

Accessors

id

get id(): string
The unique key of the value.

Returns string
Inherited from RegistryEntry.id
- Defined in module/registry/base-registry.mjs:197

Methods

_initialize

_initialize(): void
Internal
Returns void
Inherited from RegistryEntry._initialize
- Defined in module/registry/base-registry.mjs:205

`Protected`localize

localize(): void
Protected
Localize fields

Returns void
Inherited from RegistryEntry.localize
- Defined in module/registry/base-registry.mjs:224

`Protected` `Abstract`prepareData

prepareData(): void
Protected
Prepares the data of the registry entry.

Returns void
Inherited from RegistryEntry.prepareData
- Defined in module/registry/base-registry.mjs:217

toStatusEffect

toStatusEffect(): object
Convert condition to format expected by CONFIG.statusEffects.

Returns object
- Base object
- Defined in module/registry/conditions.mjs:95

`Static`defineSchema

defineSchema(): {
    _id: any;
    flags: any;
    hud: any;
    journal: any;
    mechanics: any;
    name: any;
    namespace: any;
    showInAction: any;
    showInBuffsTab: any;
    showInDefense: any;
    texture: any;
    track: any;
}
Returns {
    _id: any;
    flags: any;
    hud: any;
    journal: any;
    mechanics: any;
    name: any;
    namespace: any;
    showInAction: any;
    showInBuffsTab: any;
    showInDefense: any;
    texture: any;
    track: any;
}
Overrides RegistryEntry.defineSchema
- Defined in module/registry/conditions.mjs:55

Class Condition

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns Condition

Properties

_id

Optionalflags

hud

Type declaration

exclude: Set<string>

include: Set<string>

show: boolean

journal

mechanics

name

namespace

showInAction

showInBuffsTab

showInDefense

texture

track

Accessors

id

Returns string

Methods

_initialize

Returns void

Protectedlocalize

Returns void

Protected AbstractprepareData

Returns void

toStatusEffect

Returns object

StaticdefineSchema

Returns { _id: any; flags: any; hud: any; journal: any; mechanics: any; name: any; namespace: any; showInAction: any; showInBuffsTab: any; showInDefense: any; texture: any; track: any;}

Settings

On This Page

`Optional`flags

`Protected`localize

`Protected` `Abstract`prepareData

`Static`defineSchema

Returns {
_id: any;
flags: any;
hud: any;
journal: any;
mechanics: any;
name: any;
namespace: any;
showInAction: any;
showInBuffsTab: any;
showInDefense: any;
texture: any;
track: any;
}