Class ExperienceDistributor

@augments{DragDropApplicationMixin<HandlebarsApplicationMixin>}

Hierarchy

any
- ExperienceDistributor

Index

Constructors

constructor

new ExperienceDistributor(options): ExperienceDistributor
Parameters
- options: any
Returns ExperienceDistributor
Overrides DragDropApplicationMixin(HandlebarsApplicationMixin(ApplicationV2)).constructor
- Defined in module/applications/experience-distributor.mjs:57

Properties

_actors

_actors: ExperienceDistributorActor[] = []

_bonusXP

_bonusXP: number = 0

`Static` DEFAULT_OPTIONS

DEFAULT_OPTIONS: {
    actions: {
        cancel: ((event) => Promise<void>);
        give: ((event) => Promise<void>);
        split: ((event) => Promise<void>);
    };
    classes: string[];
    dragDrop: {
        dragSelector: null;
        dropSelector: string;
    }[];
    form: {
        closeOnSubmit: boolean;
        handler: ((event) => Promise<void>);
        submitOnChange: boolean;
        submitOnClose: boolean;
    };
    position: {
        height: number;
        width: number;
    };
    sheetConfig: boolean;
    tag: string;
    window: {
        minimizable: boolean;
        resizable: boolean;
        title: string;
    };
} = ...

Type declaration

actions: {
    cancel: ((event) => Promise<void>);
    give: ((event) => Promise<void>);
    split: ((event) => Promise<void>);
}
- cancel: ((event) => Promise<void>)
  - - (event): Promise<void>
    - Internal
      Cancel distribution and close dialog
      Parameters
      event: any
      Returns Promise<void>
      Static
- give: ((event) => Promise<void>)
  - - (event): Promise<void>
    - Internal
      Give all XP to all actors
      Parameters
      event: any
      Returns Promise<void>
      Static
- split: ((event) => Promise<void>)
  - - (event): Promise<void>
    - Internal
      Distribute XP evenly between actors
      Parameters
      event: any
      Returns Promise<void>
      Static
classes: string[]
dragDrop: {
dragSelector: null;
dropSelector: string;
}[]
form: {
    closeOnSubmit: boolean;
    handler: ((event) => Promise<void>);
    submitOnChange: boolean;
    submitOnClose: boolean;
}
- closeOnSubmit: boolean
- handler: ((event) => Promise<void>)
  - - (event): Promise<void>
    - Internal
      Give all XP to all actors
      Parameters
      event: any
      Returns Promise<void>
      Static
- submitOnChange: boolean
- submitOnClose: boolean
position: {
height: number;
width: number;
}
- height: number
- width: number
sheetConfig: boolean
tag: string
window: {
    minimizable: boolean;
    resizable: boolean;
    title: string;
}
- minimizable: boolean
- resizable: boolean
- title: string

`Static` PARTS

PARTS: {
    footer: {
        template: string;
    };
    form: {
        scrollable: string[];
        template: string;
    };
} = ...

Type declaration

footer: {
template: string;
}
- template: string
form: {
scrollable: string[];
template: string;
}
- scrollable: string[]
- template: string

Accessors

characters

get characters(): ExperienceDistributorActor[]
Get PC actors

Returns ExperienceDistributorActor[]
- Defined in module/applications/experience-distributor.mjs:118

npcs

get npcs(): ExperienceDistributorActor[]
Get NPC actors

Returns ExperienceDistributorActor[]
- Defined in module/applications/experience-distributor.mjs:129

splitExperience

get splitExperience(): number
Split experience, as split across all characters.

Returns number
- Reward value
- Defined in module/applications/experience-distributor.mjs:296

totalExperience

get totalExperience(): number
Total experience the encounter is worth, including regular XP reward and bonus XP.

Returns number
- Total value
- Defined in module/applications/experience-distributor.mjs:284

Methods

_giveExperience

_giveExperience(splitEvenly?): void
Internal
Distributes experience to all PC actors
Parameters
- splitEvenly: boolean = false
  Should XP be split evenly?
Returns void
- Defined in module/applications/experience-distributor.mjs:202

_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
- Defined in module/applications/experience-distributor.mjs:173

`Protected` _onDrop

_onDrop(event): Promise<void>
Protected
Handle Drop Event
Parameters
- event: DragEvent
  The originating DragEvent
Returns Promise<void>
Async
- Defined in module/applications/experience-distributor.mjs:143

_prepareContext

_prepareContext(): Promise<{
    actors: {
        characters: ExperienceDistributorActor[];
        npcs: ExperienceDistributorActor[];
    };
    bonusXP: number;
    buttons: {
        action: string;
        icon: string;
        label: string;
        type: string;
    }[];
    xp: {
        split: string;
        total: string;
    };
}>
Internal
Returns Promise<{
    actors: {
        characters: ExperienceDistributorActor[];
        npcs: ExperienceDistributorActor[];
    };
    bonusXP: number;
    buttons: {
        action: string;
        icon: string;
        label: string;
        type: string;
    }[];
    xp: {
        split: string;
        total: string;
    };
}>
Inherit Doc
Async
- Defined in module/applications/experience-distributor.mjs:83

`Static` _cancel

_cancel(event): Promise<void>
Internal
Cancel distribution and close dialog
Parameters
- event: any
Returns Promise<void>
Static
- Defined in module/applications/experience-distributor.mjs:272

`Static` _giveAll

_giveAll(event): Promise<void>
Internal
Give all XP to all actors
Parameters
- event: any
Returns Promise<void>
Static
- Defined in module/applications/experience-distributor.mjs:255

`Static` _shouldActorBeSelected

_shouldActorBeSelected(actor): boolean
Should the actor be selected by default.
Parameters
- actor: Actor
Returns boolean
- Defined in module/applications/experience-distributor.mjs:333

`Static` _split

_split(event): Promise<void>
Internal
Distribute XP evenly between actors
Parameters
- event: any
Returns Promise<void>
Static
- Defined in module/applications/experience-distributor.mjs:238

`Static` fromCombat

fromCombat(combat): ExperienceDistributor
Open XP distributor dialog based on passed combat instance.
Parameters
- combat: Combat
  Combat instance
Returns ExperienceDistributor
- Application instance
- Defined in module/applications/experience-distributor.mjs:352

`Static` `Protected` getActorData

getActorData(actor): ExperienceDistributorActor
Protected
Parameters
- actor: Actor
Returns ExperienceDistributorActor
- Defined in module/applications/experience-distributor.mjs:310

Class ExperienceDistributor

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: any

Returns ExperienceDistributor

Properties

_actors

_bonusXP

Static DEFAULT_OPTIONS

Type declaration

actions: { cancel: ((event) => Promise<void>); give: ((event) => Promise<void>); split: ((event) => Promise<void>); }

cancel: ((event) => Promise<void>)

Parameters

event: any

Returns Promise<void>

Static

give: ((event) => Promise<void>)

Parameters

event: any

Returns Promise<void>

Static

split: ((event) => Promise<void>)

Parameters

event: any

Returns Promise<void>

Static

classes: string[]

dragDrop: { dragSelector: null; dropSelector: string; }[]

form: { closeOnSubmit: boolean; handler: ((event) => Promise<void>); submitOnChange: boolean; submitOnClose: boolean; }

closeOnSubmit: boolean

handler: ((event) => Promise<void>)

Parameters

event: any

Returns Promise<void>

Static

submitOnChange: boolean

submitOnClose: boolean

position: { height: number; width: number; }

height: number

width: number

sheetConfig: boolean

tag: string

window: { minimizable: boolean; resizable: boolean; title: string; }

minimizable: boolean

resizable: boolean

title: string

Static PARTS

Type declaration

footer: { template: string; }

template: string

form: { scrollable: string[]; template: string; }

scrollable: string[]

template: string

Accessors

characters

Returns ExperienceDistributorActor[]

npcs

Returns ExperienceDistributorActor[]

splitExperience

Returns number

totalExperience

Returns number

Methods

_giveExperience

Parameters

splitEvenly: boolean = false

Returns void

_onChangeForm

Parameters

formConfig: ApplicationFormConfiguration

event: Event

Returns void

Protected _onDrop

`Static` DEFAULT_OPTIONS

actions: {
cancel: ((event) => Promise<void>);
give: ((event) => Promise<void>);
split: ((event) => Promise<void>);
}

dragDrop: {
dragSelector: null;
dropSelector: string;
}[]

form: {
closeOnSubmit: boolean;
handler: ((event) => Promise<void>);
submitOnChange: boolean;
submitOnClose: boolean;
}

position: {
height: number;
width: number;
}

window: {
minimizable: boolean;
resizable: boolean;
title: string;
}

`Static` PARTS

footer: {
template: string;
}

form: {
scrollable: string[];
template: string;
}

`Protected` _onDrop

Returns Promise<{
actors: {
characters: ExperienceDistributorActor[];
npcs: ExperienceDistributorActor[];
};
bonusXP: number;
buttons: {
action: string;
icon: string;
label: string;
type: string;
}[];
xp: {
split: string;
total: string;
};
}>

`Static` _cancel

`Static` _giveAll

`Static` _shouldActorBeSelected

`Static` _split

`Static` fromCombat

`Static` `Protected` getActorData