Class HealthConfig

A generic application to render a settings modal.

Abstract

Hierarchy

AbstractSettingsApplication
- HealthConfig

Index

Constructors

constructor

new HealthConfig(): HealthConfig
Returns HealthConfig
Inherited from AbstractSettingsApplication.constructor

Properties

settings

settings: any

tabGroups

tabGroups: {
primary: string;
} = ...

Type declaration

primary: string

tabs

tabs: {
    primary: {
        base: {
            icon: string;
            label: string;
        };
        variant: {
            icon: string;
            label: string;
        };
    };
} = ...

Type declaration

primary: {
    base: {
        icon: string;
        label: string;
    };
    variant: {
        icon: string;
        label: string;
    };
}
- base: {
  icon: string;
  label: string;
  }
  - icon: string
  - label: string
- variant: {
  icon: string;
  label: string;
  }
  - icon: string
  - label: string

`Static` DEFAULT_OPTIONS

DEFAULT_OPTIONS: {
    configKey: string;
    model: typeof HealthConfigModel;
    phraseKey: string;
    window: {
        icon: string;
    };
} = ...

Type declaration

configKey: string
model: typeof HealthConfigModel
phraseKey: string
window: {
icon: string;
}
- icon: string

`Static` PARTS

PARTS: {
    footer: {
        template: string;
    };
    form: {
        template: string;
    };
    tabs: {
        template: string;
    };
} = ...

Type declaration

footer: {
template: string;
}
- template: string
form: {
template: string;
}
- template: string
tabs: {
template: string;
}
- template: string

`Static` settings

settings: any

Accessors

title

get title(): string
Returns string
Inherited from AbstractSettingsApplication.title
- Defined in module/applications/settings/abstract-settings.mjs:38

Methods

_initializeApplicationOptions

_initializeApplicationOptions(options): ApplicationConfiguration
Initialize the configuration for this application. Override the default ID to be unique to this settings app instance and tack on extra class.
Parameters
- options: ApplicationConfiguration
  The provided configuration options for the Application
Returns ApplicationConfiguration
The final configuration values for the application
Inherited from AbstractSettingsApplication._initializeApplicationOptions
- Defined in module/applications/settings/abstract-settings.mjs:52

_onChangeForm

_onChangeForm(formConfig, event): void
Internal
The event handler for changes to form input elements
Parameters
- formConfig: ApplicationFormConfiguration
  The configuration of the form being changed
- event: Event
  The triggering event
Returns void
Inherited from AbstractSettingsApplication._onChangeForm
- Defined in module/applications/settings/abstract-settings.mjs:141

_prepareContext

_prepareContext(options): Promise<{}>
Internal
Parameters
- options: RenderOptions
Returns Promise<{}>
Inherit Doc
Inherited from AbstractSettingsApplication._prepareContext
- Defined in module/applications/settings/abstract-settings.mjs:69

_preparePartContext

_preparePartContext(partId, context): Promise<ApplicationRenderContext>
Internal
Parameters
- partId: string
- context: ApplicationRenderContext
Returns Promise<ApplicationRenderContext>
Inherit Doc
Overrides AbstractSettingsApplication._preparePartContext
- Defined in module/applications/settings/health.mjs:135

`Static` _onFormReset

_onFormReset(event): Promise<void>
Internal
The event handler that is fired when the form is reset to its original values
Parameters
- event: Event
  The triggering event
Returns Promise<void>
Inherited from AbstractSettingsApplication._onFormReset
- Defined in module/applications/settings/abstract-settings.mjs:156

`Static` _save

_save(event, form, formData): Promise<void>
Internal
Update the game settings with the new configuration
Parameters
- event: SubmitEvent
  The originating form submission event
- form: HTMLFormElement
  The form element that was submitted
- formData: FormDataExtended
  Processed data for the submitted form
Returns Promise<void>
Inherited from AbstractSettingsApplication._save
- Defined in module/applications/settings/abstract-settings.mjs:175

Class HealthConfig

Abstract

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns HealthConfig

Properties

settings

tabGroups

Type declaration

primary: string

tabs

Type declaration

primary: { base: { icon: string; label: string; }; variant: { icon: string; label: string; }; }

base: { icon: string; label: string; }

icon: string

label: string

variant: { icon: string; label: string; }

icon: string

label: string

Static DEFAULT_OPTIONS

Type declaration

configKey: string

model: typeof HealthConfigModel

phraseKey: string

window: { icon: string; }

icon: string

Static PARTS

Type declaration

footer: { template: string; }

template: string

form: { template: string; }

template: string

tabs: { template: string; }

template: string

Static settings

Accessors

title

Returns string

Methods

_initializeApplicationOptions

Parameters

options: ApplicationConfiguration

Returns ApplicationConfiguration

_onChangeForm

Parameters

formConfig: ApplicationFormConfiguration

event: Event

Returns void

_prepareContext

Parameters

options: RenderOptions

Returns Promise<{}>

Inherit Doc

_preparePartContext

Parameters

partId: string

context: ApplicationRenderContext

Returns Promise<ApplicationRenderContext>

Inherit Doc

Static _onFormReset

Parameters

event: Event

Returns Promise<void>

Static _save

Parameters

event: SubmitEvent

form: HTMLFormElement

formData: FormDataExtended

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

primary: {
base: {
icon: string;
label: string;
};
variant: {
icon: string;
label: string;
};
}

base: {
icon: string;
label: string;
}

variant: {
icon: string;
label: string;
}

`Static` DEFAULT_OPTIONS

window: {
icon: string;
}

`Static` PARTS

footer: {
template: string;
}

form: {
template: string;
}

tabs: {
template: string;
}

`Static` settings

`Static` _onFormReset

`Static` _save