Class Effect

Constructors

constructor

new Effect(type, quantity, operator, expression, effect_owner_instance, quantity_is_absolute, rate, chance, element, add_status, remove_buff, status_key_name, turns_quantity, variation_on_final_result, usage, on_caster, relative_to_property, sub_effect, custom_msg, show_msg, char): Effect
Parameters
- type: any
- quantity: any
- operator: any
- expression: any
- effect_owner_instance: any
- quantity_is_absolute: any
- rate: any
- chance: any
- element: any
- add_status: any
- remove_buff: any
- status_key_name: any
- turns_quantity: any
- variation_on_final_result: any
- usage: any
- on_caster: any
- relative_to_property: any
- sub_effect: any
- custom_msg: any
- show_msg: any
- char: any
Returns Effect
- Defined in base/Effect.ts:178

Properties

add_status

add_status: boolean

chance

chance: number

change

change: {
after: number;
before: number;
}

Type declaration

after: number
before: number

char

char: Player

custom_msg

custom_msg: string

effect_owner_instance

effect_owner_instance: Ability | Item

effect_owner_type

effect_owner_type: effect_owner_types

element

element: elements

expression

expression: string

on_caster

on_caster: boolean

operator

operator: effect_operators

quantity

quantity: number

quantity_is_absolute

quantity_is_absolute: boolean

rate

rate: number

relative_to_property

relative_to_property: string

remove_buff

remove_buff: boolean

show_msg

show_msg: boolean

status_key_name

status_key_name: permanent_status | temporary_status

sub_effect

sub_effect: {
    chance: number;
    element: elements;
    expression: string;
    on_caster: boolean;
    operator: effect_operators;
    quantity_is_absolute: boolean;
    rate: number;
    type: effect_types;
    usage: string;
    variation_on_final_result: boolean;
}

Type declaration

chance: number
element: elements
expression: string
on_caster: boolean
operator: effect_operators
quantity_is_absolute: boolean
rate: number
type: effect_types
usage: string
variation_on_final_result: boolean

turn_count

turn_count: number

The current turn number of this effect.

turns_quantity

turns_quantity: number

The total number of turns this effect last.

type

type: effect_types

usage

usage: string

variation_on_final_result

variation_on_final_result: boolean

Methods

apply_effect

apply_effect(direct_value?): {
    after?: number;
    all_elements?: boolean;
    before?: number;
    removed_effects?: Effect[];
}
Parameters
- Optional direct_value: any
Returns {
    after?: number;
    all_elements?: boolean;
    before?: number;
    removed_effects?: Effect[];
}
- Optional after?: number
- Optional all_elements?: boolean
- Optional before?: number
- Optional removed_effects?: Effect[]
- Defined in base/Effect.ts:457

`Private` apply_general_value

apply_general_value(property, direct_value?, sub_property?, relative_to_property?, store_diff?, append_value?): {
after: number;
before: number;
}
Parameters
- property: string
- Optional direct_value: number
- Optional sub_property: elements | main_stats
- Optional relative_to_property: string
- store_diff: boolean = false
- append_value: boolean = false
Returns {
after: number;
before: number;
}
- after: number
- before: number
- Defined in base/Effect.ts:260

`Private` apply_subeffect

apply_subeffect(property, value): any
Parameters
- property: string
- value: number
Returns any
- Defined in base/Effect.ts:327

`Private` check_caps

check_caps(current_prop, max_prop, min_value, result_obj): void
Parameters
- current_prop: any
- max_prop: any
- min_value: any
- result_obj: any
Returns void
- Defined in base/Effect.ts:373

`Private` elemental_stat_effect

elemental_stat_effect(property, element): {
after: number;
before: number;
}
Parameters
- property: elemental_stats
- element: elements
Returns {
after: number;
before: number;
}
- after: number
- before: number
- Defined in base/Effect.ts:429

`Private` init_sub_effect

init_sub_effect(): void
Returns void
- Defined in base/Effect.ts:250

`Private` main_stat_effect

main_stat_effect(): {
    after: number;
    before: number;
} | {
    removed_effects: Effect[];
}
Returns {
    after: number;
    before: number;
} | {
    removed_effects: Effect[];
}
- Defined in base/Effect.ts:400

`Private` remove_char_buffs

remove_char_buffs(type, element?): {
removed_effects: Effect[];
}
Parameters
- type: effect_types
- Optional element: elements
Returns {
removed_effects: Effect[];
}
- removed_effects: Effect[]
- Defined in base/Effect.ts:387

`Static` add_status_to_player

add_status_to_player(effect_obj, caster, target, ability, magnitude): Effect
Parameters
- effect_obj: any
- caster: Enemy | MainChar
- target: Enemy | MainChar
- ability: Ability
- magnitude: number
Returns Effect
- Defined in base/Effect.ts:575

`Static` apply_operator

apply_operator(a, b, operator): number
Parameters
- a: number
- b: number
- operator: effect_operators
Returns number
- Defined in base/Effect.ts:237

`Static` parse_effect_custom_msg

parse_effect_custom_msg(msg, target_name?, caster_name?): string
Parameters
- msg: string
- Optional target_name: string
- Optional caster_name: string
Returns string
- Defined in base/Effect.ts:701

`Static` preview_value_applied

preview_value_applied(effect_obj, base_value): any
Parameters
- effect_obj: any
- base_value: any
Returns any
- Defined in base/Effect.ts:351

`Static` remove_status_from_player

remove_status_from_player(effect_obj, target): {
removed_effects: Effect[];
status_removed: (permanent_status | temporary_status)[];
}
Parameters
- effect_obj: any
- target: Player
Returns {
removed_effects: Effect[];
status_removed: (permanent_status | temporary_status)[];
}
- removed_effects: Effect[]
- status_removed: (permanent_status | temporary_status)[]
- Defined in base/Effect.ts:655

Class Effect

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Effect

Properties

add_status

chance

change

Type declaration

after: number

before: number

char

custom_msg

effect_owner_instance

effect_owner_type

element

expression

on_caster

operator

quantity

quantity_is_absolute

rate

relative_to_property

remove_buff

show_msg

status_key_name

sub_effect

Type declaration

chance: number

element: elements

expression: string

on_caster: boolean

operator: effect_operators

quantity_is_absolute: boolean

rate: number

type: effect_types

usage: string

variation_on_final_result: boolean

turn_count

turns_quantity

type

usage

variation_on_final_result

Methods

apply_effect

Parameters

Returns { after?: number; all_elements?: boolean; before?: number; removed_effects?: Effect[]; }

Optional after?: number

Optional all_elements?: boolean

Optional before?: number

Optional removed_effects?: Effect[]

Private apply_general_value

Parameters

Returns { after: number; before: number; }

after: number

before: number

Private apply_subeffect

Parameters

Returns any

Private check_caps

Parameters

Returns void

Private elemental_stat_effect

Parameters

Returns { after: number; before: number; }

after: number

before: number

Private init_sub_effect

Returns void

Private main_stat_effect

Returns { after: number; before: number; } | { removed_effects: Effect[]; }

Private remove_char_buffs

Parameters

Returns { removed_effects: Effect[]; }

removed_effects: Effect[]

Returns {
after?: number;
all_elements?: boolean;
before?: number;
removed_effects?: Effect[];
}

`Optional` after?: number

`Optional` all_elements?: boolean

`Optional` before?: number

`Optional` removed_effects?: Effect[]

`Private` apply_general_value

Returns {
after: number;
before: number;
}

`Private` apply_subeffect

`Private` check_caps

`Private` elemental_stat_effect

Returns {
after: number;
before: number;
}

`Private` init_sub_effect

`Private` main_stat_effect

Returns {
after: number;
before: number;
} | {
removed_effects: Effect[];
}

`Private` remove_char_buffs

Returns {
removed_effects: Effect[];
}

`Static` add_status_to_player

`Static` apply_operator

`Static` parse_effect_custom_msg

`Static` preview_value_applied

`Static` remove_status_from_player

Returns {
removed_effects: Effect[];
status_removed: (permanent_status | temporary_status)[];
}