Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Effect

Hierarchy

  • Effect

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Effect(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): 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

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?: any): { 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[]

Private apply_general_value

  • apply_general_value(property: string, direct_value?: number, sub_property?: elements | main_stats, relative_to_property?: string, store_diff?: boolean, append_value?: boolean): { 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

Private apply_subeffect

  • apply_subeffect(property: string, value: number): any

Private check_caps

  • check_caps(current_prop: any, max_prop: any, min_value: any, result_obj: any): void

  • Parameters

    • current_prop: any
    • max_prop: any
    • min_value: any
    • result_obj: any

    Returns void

Private elemental_stat_effect

Private init_sub_effect

  • init_sub_effect(): void

Private main_stat_effect

  • main_stat_effect(): { after: number; before: number } | { removed_effects: Effect[] }

Private remove_char_buffs

Static add_status_to_player

Static apply_operator

Static parse_effect_custom_msg

  • parse_effect_custom_msg(msg: string, target_name?: string, caster_name?: string): string

  • Parameters

    • msg: string
    • Optional target_name: string
    • Optional caster_name: string

    Returns string

Static preview_value_applied

  • preview_value_applied(effect_obj: any, base_value: any): any

Static remove_status_from_player

Generated using TypeDoc