Class default

Hierarchy

Host<IMagicalPropertyManagerEvents>
- default

Index

Constructors

constructor

Properties

event

Constructors

constructor

new default(properties?: Partial<Record<MagicalPropertyType, AnyMagicalProperty>>): default
Parameters
- Optional properties: Partial<Record<MagicalPropertyType, AnyMagicalProperty>>
Returns default
Overrides EventEmitter.Host<IMagicalPropertyManagerEvents>.constructor
- Defined in src/game/game/magic/MagicalPropertyManager.ts:230

Properties

`Readonly` event

event: IEventEmitter<default, IMagicalPropertyManagerEvents>

Methods

all

all(): MagicalPropertyEntry[]
Returns
a list of all the magical properties on this object

Returns MagicalPropertyEntry[]
- Defined in src/game/game/magic/MagicalPropertyManager.ts:632
all(intersectionType: true): MagicalPropertyEntryIntersection[]
Returns
a list of all the magical properties on this object,
Parameters
- intersectionType: true
Returns MagicalPropertyEntryIntersection[]
- Defined in src/game/game/magic/MagicalPropertyManager.ts:636

clear

clear(): number
Removes any magical properties on this object

Returns
the number of magical properties removed

Returns number
- Defined in src/game/game/magic/MagicalPropertyManager.ts:498

count

count(): number
Returns
the number of magical properties on this object

Returns number
- Defined in src/game/game/magic/MagicalPropertyManager.ts:251

get

get<T>(type: T): undefined | number
Returns
a magical property on this object, if it exists
Type Parameters
- T extends MagicalNormalPropertyTypes
Parameters
- type: T
Returns undefined | number
- Defined in src/game/game/magic/MagicalPropertyManager.ts:323
get<T>(type: T, subType: MagicalPropertyTypeSubTypeMap[T]): undefined | number
Returns
a magical sub-property on this object, if it exists
Type Parameters
- T extends keyof MagicalPropertyTypeSubTypeMap
Parameters
- type: T
- subType: MagicalPropertyTypeSubTypeMap[T]
Returns undefined | number
- Defined in src/game/game/magic/MagicalPropertyManager.ts:327
get(...identity: MagicalPropertyIdentity<[]>): undefined | number
Parameters
- Rest ...identity: MagicalPropertyIdentity<[]>
Returns undefined | number
- Defined in src/game/game/magic/MagicalPropertyManager.ts:328

getInert

getInert<T>(type: T): undefined | number
Returns
a magical property on this object, if it exists
Type Parameters
- T extends MagicalNormalPropertyTypes
Parameters
- type: T
Returns undefined | number
- Defined in src/game/game/magic/MagicalPropertyManager.ts:297
getInert<T>(type: T, subType: MagicalPropertyTypeSubTypeMap[T]): undefined | number
Returns
a magical sub-property on this object, if it exists
Type Parameters
- T extends keyof MagicalPropertyTypeSubTypeMap
Parameters
- type: T
- subType: MagicalPropertyTypeSubTypeMap[T]
Returns undefined | number
- Defined in src/game/game/magic/MagicalPropertyManager.ts:301
getInert(...identity: MagicalPropertyIdentity<[]>): undefined | number
Parameters
- Rest ...identity: MagicalPropertyIdentity<[]>
Returns undefined | number
- Defined in src/game/game/magic/MagicalPropertyManager.ts:302

has

has(type: MagicalPropertyType): boolean
Returns
whether the given type of magical property is present on this object
Parameters
- type: MagicalPropertyType
Returns boolean
- Defined in src/game/game/magic/MagicalPropertyManager.ts:275
has<T>(type: T, subType: MagicalPropertyTypeSubTypeMap[T]): boolean
Returns
whether the given type of magical sub-property is present on this object
Type Parameters
- T extends keyof MagicalPropertyTypeSubTypeMap
Parameters
- type: T
- subType: MagicalPropertyTypeSubTypeMap[T]
Returns boolean
- Defined in src/game/game/magic/MagicalPropertyManager.ts:279
has(...identity: MagicalPropertyIdentity<[]>): boolean
Parameters
- Rest ...identity: MagicalPropertyIdentity<[]>
Returns boolean
- Defined in src/game/game/magic/MagicalPropertyManager.ts:280

hasAny

hasAny(): boolean
Returns
if this object has any magical properties

Returns boolean
- Defined in src/game/game/magic/MagicalPropertyManager.ts:262
hasAny(...types: MagicalPropertyIdentityFlat[]): boolean
Returns
if this object has any of the given magical property types
Parameters
- Rest ...types: MagicalPropertyIdentityFlat[]
Returns boolean
- Defined in src/game/game/magic/MagicalPropertyManager.ts:266

hash

hash(): string
Returns string
- Defined in src/game/game/magic/MagicalPropertyManager.ts:725

identities

identities(): MagicalPropertyIdentity<[]>[]
Returns
a list of all the magical property identities on this object [type, subtype?]

Returns MagicalPropertyIdentity<[]>[]
- Defined in src/game/game/magic/MagicalPropertyManager.ts:523

inherit

inherit(magic: default): default
Removes any magical properties on this object and replaces them with magical properties on the given object
Parameters
- magic: default
Returns default
- Defined in src/game/game/magic/MagicalPropertyManager.ts:511

normalTypes

normalTypes(): MagicalNormalPropertyTypes[]
Returns
a list of all the "normal" magical property types on this object — ie, the ones without subtypes

Returns MagicalNormalPropertyTypes[]
- Defined in src/game/game/magic/MagicalPropertyManager.ts:551

remove

remove(type: MagicalPropertyType): boolean
Removes a magical property on this object, if it exists

Returns
whether the magical property was removed — ie, if it existed
Parameters
- type: MagicalPropertyType
Returns boolean
- Defined in src/game/game/magic/MagicalPropertyManager.ts:442
remove<T>(type: T, subType: MagicalPropertyTypeSubTypeMap[T]): boolean
Removes a magical sub-property on this object, if it exists. If all sub-properties are removed, the super-property is too.

Returns
whether the magical sub-property was removed — ie, if it existed
Type Parameters
- T extends keyof MagicalPropertyTypeSubTypeMap
Parameters
- type: T
- subType: MagicalPropertyTypeSubTypeMap[T]
Returns boolean
- Defined in src/game/game/magic/MagicalPropertyManager.ts:447
remove(...identity: MagicalPropertyIdentity<[]>): boolean
Parameters
- Rest ...identity: MagicalPropertyIdentity<[]>
Returns boolean
- Defined in src/game/game/magic/MagicalPropertyManager.ts:448

set

set<T>(type: T, value: number): default
Sets a magical property on this object. Replaces any existing magical property of that type
Type Parameters
- T extends MagicalNormalPropertyTypes
Parameters
- type: T
- value: number
Returns default
- Defined in src/game/game/magic/MagicalPropertyManager.ts:352
set<T>(type: T, subType: MagicalPropertyTypeSubTypeMap[T], value: number): default
Sets a magical sub-property on this object. Replaces any existing magical sub-property of that type
Type Parameters
- T extends keyof MagicalPropertyTypeSubTypeMap
Parameters
- type: T
- subType: MagicalPropertyTypeSubTypeMap[T]
- value: number
Returns default
- Defined in src/game/game/magic/MagicalPropertyManager.ts:356

setInert

setInert(inert?: boolean): default
Parameters
- inert: boolean = true
Returns default
- Defined in src/game/game/magic/MagicalPropertyManager.ts:238

subProperties

subProperties<T>(type: T): readonly {
type: MagicalPropertyTypeSubTypeMap[T];
value: number;
}[]
Returns
a list of all the magical sub-properties for the given type on this object, if any
Type Parameters
- T extends keyof MagicalPropertyTypeSubTypeMap
Parameters
- type: T
Returns readonly {
type: MagicalPropertyTypeSubTypeMap[T];
value: number;
}[]
- Defined in src/game/game/magic/MagicalPropertyManager.ts:610

subTypes

subTypes(): readonly MagicalSubPropertyTypesResult[]
Returns
a list of all the magical sub-property types of the given supertype on this object

Returns readonly MagicalSubPropertyTypesResult[]
- Defined in src/game/game/magic/MagicalPropertyManager.ts:568
subTypes<T>(type: T): readonly MagicalPropertyTypeSubTypeMap[T][]
Returns
a list of all the magical sub-property types of the given supertype on this object
Type Parameters
- T extends keyof MagicalPropertyTypeSubTypeMap
Parameters
- type: T
Returns readonly MagicalPropertyTypeSubTypeMap[T][]
- Defined in src/game/game/magic/MagicalPropertyManager.ts:572

translate

translate(ender?: false | ListEnder, format?: default | ((...identity: MagicalPropertyIdentity<[]>) => default)): default
Translates a list of the magical properties on this object, including sub-properties
Parameters
- Optional ender: false | ListEnder
  
  The way to end this list translation, ie and/or
- Optional format: default | ((...identity: MagicalPropertyIdentity<[]>) => default)
  
  A formatting-translation to apply to each magical property
Returns default
- Defined in src/game/game/magic/MagicalPropertyManager.ts:664

types

types(): MagicalPropertyType[]
Returns
a list of all the magical property types on this object

Returns MagicalPropertyType[]
- Defined in src/game/game/magic/MagicalPropertyManager.ts:531

`Static` getDescription

getDescription(type: MagicalNormalPropertyTypes): default
Returns
a translation for a magical property type
Parameters
- type: MagicalNormalPropertyTypes
Returns default
- Defined in src/game/game/magic/MagicalPropertyManager.ts:698
getDescription<T>(type: T, subType: MagicalPropertyTypeSubTypeMap[T]): default
Returns
a translation for a magical sub-property type
Type Parameters
- T extends keyof MagicalPropertyTypeSubTypeMap
Parameters
- type: T
- subType: MagicalPropertyTypeSubTypeMap[T]
Returns default
- Defined in src/game/game/magic/MagicalPropertyManager.ts:702
getDescription(...identity: MagicalPropertyIdentity<[]>): default
Parameters
- Rest ...identity: MagicalPropertyIdentity<[]>
Returns default
- Defined in src/game/game/magic/MagicalPropertyManager.ts:703

`Static` getNormalTypes

getNormalTypes(): MagicalNormalPropertyTypes[]
Returns MagicalNormalPropertyTypes[]
- Defined in src/game/game/magic/MagicalPropertyManager.ts:171

`Static` getSubTypes

getSubTypes(): (keyof MagicalPropertyTypeSubTypeMap)[]
Returns (keyof MagicalPropertyTypeSubTypeMap)[]
- Defined in src/game/game/magic/MagicalPropertyManager.ts:177

`Static` inherit

inherit(source: undefined | default | IHasMagic, target: IHasMagic, event?: boolean): void
Parameters
- source: undefined | default | IHasMagic
- target: IHasMagic
- event: boolean = false
Returns void
- Defined in src/game/game/magic/MagicalPropertyManager.ts:214

`Static` init

init(): void
Returns void
- Defined in src/game/game/magic/MagicalPropertyManager.ts:191

`Static` isNormalProperty

isNormalProperty(property: MagicalPropertyType): property is MagicalNormalPropertyTypes
Parameters
- property: MagicalPropertyType
Returns property is MagicalNormalPropertyTypes
- Defined in src/game/game/magic/MagicalPropertyManager.ts:183

`Static` isSubProperty

isSubProperty(property: MagicalPropertyType): property is keyof MagicalPropertyTypeSubTypeMap
Parameters
- property: MagicalPropertyType
Returns property is keyof MagicalPropertyTypeSubTypeMap
- Defined in src/game/game/magic/MagicalPropertyManager.ts:187

`Static` translate

translate(type: MagicalNormalPropertyTypes): default
Returns
a translation for a magical property type
Parameters
- type: MagicalNormalPropertyTypes
Returns default
- Defined in src/game/game/magic/MagicalPropertyManager.ts:685
translate<T>(type: T, subType: MagicalPropertyTypeSubTypeMap[T]): default
Returns
a translation for a magical sub-property type
Type Parameters
- T extends keyof MagicalPropertyTypeSubTypeMap
Parameters
- type: T
- subType: MagicalPropertyTypeSubTypeMap[T]
Returns default
- Defined in src/game/game/magic/MagicalPropertyManager.ts:689
translate(...identity: MagicalPropertyIdentity<[]>): default
Parameters
- Rest ...identity: MagicalPropertyIdentity<[]>
Returns default
- Defined in src/game/game/magic/MagicalPropertyManager.ts:690

Class default

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional properties: Partial<Record<MagicalPropertyType, AnyMagicalProperty>>

Returns default

Properties

Readonly event

Methods

all

Returns

Returns MagicalPropertyEntry[]

Returns

Parameters

intersectionType: true

Returns MagicalPropertyEntryIntersection[]

clear

Returns

Returns number

count

Returns

Returns number

get

Returns

Type Parameters

T extends MagicalNormalPropertyTypes

Parameters

type: T

Returns undefined | number

Returns

Type Parameters

T extends keyof MagicalPropertyTypeSubTypeMap

Parameters

type: T

subType: MagicalPropertyTypeSubTypeMap[T]

Returns undefined | number

Parameters

Rest ...identity: MagicalPropertyIdentity<[]>

Returns undefined | number

getInert

Returns

Type Parameters

T extends MagicalNormalPropertyTypes

Parameters

type: T

Returns undefined | number

Returns

Type Parameters

T extends keyof MagicalPropertyTypeSubTypeMap

Parameters

type: T

subType: MagicalPropertyTypeSubTypeMap[T]

Returns undefined | number

Parameters

Rest ...identity: MagicalPropertyIdentity<[]>

Returns undefined | number

has

Returns

Parameters

type: MagicalPropertyType

Returns boolean

Returns

Type Parameters

T extends keyof MagicalPropertyTypeSubTypeMap

Parameters

type: T

subType: MagicalPropertyTypeSubTypeMap[T]

Returns boolean

Parameters

Rest ...identity: MagicalPropertyIdentity<[]>

Returns boolean

hasAny

Returns

Returns boolean

Returns

`Optional` properties: Partial<Record<MagicalPropertyType, AnyMagicalProperty>>

`Readonly` event

`Rest` ...identity: MagicalPropertyIdentity<[]>

`Rest` ...identity: MagicalPropertyIdentity<[]>

`Rest` ...identity: MagicalPropertyIdentity<[]>

`Rest` ...types: MagicalPropertyIdentityFlat[]

`Rest` ...identity: MagicalPropertyIdentity<[]>

Returns readonly {
type: MagicalPropertyTypeSubTypeMap[T];
value: number;
}[]

`Optional` ender: false | ListEnder

`Optional` format: default | ((...identity: MagicalPropertyIdentity<[]>) => default)