-
Notifications
You must be signed in to change notification settings - Fork 232
Hooks
Fires before an ability test is rolled. Returning false
will prevent the normal rolling process.
Name | Type | Description |
---|---|---|
actor | Actor5e | Actor for which the ability test is being rolled. |
config | D20RollConfiguration | Configuration data for the pending roll. |
abilityId | string | ID of the ability being rolled as defined in DND5E.abilities . |
Fires after an ability test has been rolled.
Name | Type | Description |
---|---|---|
actor | Actor5e | Actor for which the ability test has been rolled. |
roll | D20Roll | The resulting roll. |
abilityId | string | ID of the ability being rolled as defined in DND5E.abilities . |
Fires before an ability save is rolled. Returning false
will prevent the normal rolling process.
Name | Type | Description |
---|---|---|
actor | Actor5e | Actor for which the ability save is being rolled. |
config | D20RollConfiguration | Configuration data for the pending roll. |
abilityId | string | ID of the ability being rolled as defined in DND5E.abilities . |
Fires after an ability save has been rolled.
Name | Type | Description |
---|---|---|
actor | Actor5e | Actor for which the ability save has been rolled. |
roll | D20Roll | The resulting roll. |
abilityId | string | ID of the ability that was rolled as defined in DND5E.abilities . |
Fires before a death saving throw is rolled. Returning false
will prevent the normal rolling process.
Name | Type | Description |
---|---|---|
actor | Actor5e | Actor for which the death saving throw is being rolled. |
config | D20RollConfiguration | Configuration data for the pending roll. |
Fires after a death saving throw has been rolled, but before updates have been performed. Returning false
will prevent updates from being performed.
Name | Type | Description |
---|---|---|
actor | Actor5e | Actor for which the death saving throw has been rolled. |
roll | D20Roll | The resulting roll. |
details | object | |
details.updates | object | Updates that will be applied to the actor as a result of this save. |
details.chatString | string | Localizable string displayed in the create chat message. If not set, then no chat message will be displayed. |
Fires before a skill check is rolled. Returning false
will prevent the normal rolling process.
Name | Type | Description |
---|---|---|
actor | Actor5e | Actor for which the skill check is being rolled. |
config | D20RollConfiguration | Configuration data for the pending roll. |
skillId | string | ID of the skill being rolled as defined in DND5E.skills . |
Fires after a skill check has been rolled.
Name | Type | Description |
---|---|---|
actor | Actor5e | Actor for which the skill check has been rolled. |
roll | D20Roll | The resulting roll. |
skillId | string | ID of the skill that was rolled as defined in DND5E.skills . |
Fires before a hit die is rolled. Returning false
will prevent the normal rolling process.
Name | Type | Description |
---|---|---|
actor | Actor5e | Actor for which the hit die is to be rolled. |
config | DamageRollConfiguration | Configuration data for the pending roll. |
denomination | string | Size of hit die to be rolled. |
Fires after a hit die has been rolled, but before updates have been applied. Returning false
will prevent updates from being performed.
Name | Type | Description |
---|---|---|
actor | Actor5e | Actor for which the hit die has been rolled. |
roll | DamageRoll | The resulting roll. |
updates | object | |
updates.actor | object | Updates that will be applied to the actor. |
updates.class | object | Updates that will be applied to the class. |
Fires before hit points are rolled for a character's class.
Name | Type | Description |
---|---|---|
actor | Actor5e | Actor for which the hit points are being rolled. |
item | Item5e | The class item whose hit dice will be rolled. |
rollData | object | |
rollData.formula | string | The string formula to parse. |
rollData.data | object | The data object against which to parse attributes within the formula. |
messageData | object | The data object to use when creating the message. |
Fires before a short rest is started. Returning false
will prevent the rest from being performed.
Name | Type | Description |
---|---|---|
actor | Actor5e | The actor that is being rested. |
config | RestConfiguration | Configuration options for the rest. |
Fires before a long rest is started. Returning false
will prevent the rest from being performed.
Name | Type | Description |
---|---|---|
actor | Actor5e | The actor that is being rested. |
config | RestConfiguration | Configuration options for the rest. |
Fires after rest result is calculated, but before any updates are performed. Returning false
will prevent updates from being performed.
Name | Type | Description |
---|---|---|
actor | Actor5e | The actor that is being rested. |
result | RestResult | Details on the rest to be completed. |
Fires when the actor completes a short or long rest.
Name | Type | Description |
---|---|---|
actor | Actor5e | The actor that just completed resting. |
result | RestResult | Details on the completed rest. |
Fires just before a new actor is created during the transform process.
Name | Type | Description |
---|---|---|
actor | Actor5e | The original actor before transformation. |
target | Actor5e | The target actor being transformed into. |
data | object | The merged data that will be used to create the newly-transformed actor. |
options | TransformationOptions | Options that determine how the transformation is performed. |
Fires when an AdvancementManager
is about to be processed. Returning false
will prevent the normal rendering process.
Name | Type | Description |
---|---|---|
advancementManager | AdvancementManager | The advancement manager about to be rendered. |
Name | Type | Description |
---|---|---|
advancementManager | AdvancementManager | The advancement manager. |
actorUpdates | object | Updates to the actor. |
toCreate | object[] | Items that will be created on the actor. |
toUpdate | object[] | Items that will be updated on the actor. |
toDelete | string[] | IDs of items that will be deleted on the actor. |
Fires when an AdvancementManager
is done modifying an actor.
Name | Type | Description |
---|---|---|
advancementManager | AdvancementManager | The advancement manager that just completed. |
All of the normal 'pre' and 'post' hook events for document modification when an advancement manager flow finishes (Actor Update, Item Creation, Item Update, and Item Deletion) have a custom flag on them: isAdvancement
. This allows a hook listener to react differently to advancement-created hook events vs normal ones.
Hooks.on('updateActor', (actor, change, options) => {
if ( options.isAdvancement ) {
// do something special
}
})
Fires before an item usage is configured. Returning false
will prevent item from being used.
Name | Type | Description |
---|---|---|
item | Item5e | Item being used. |
config | ItemUseConfiguration | Configuration data for the item usage being prepared. |
options | ItemUseOptions | Additional options used for configuring item usage. |
Fires before an item's resource consumption has been calculated. Returning false
will prevent item from being used.
Name | Type | Description |
---|---|---|
item | Item5e | Item being used. |
config | ItemUseConfiguration | Configuration data for the item usage being prepared. |
options | ItemUseOptions | Additional options used for configuring item usage. |
Fires after an item's resource consumption has been calculated but before any changes have been made. Returning false
will prevent item from being used.
Name | Type | Description |
---|---|---|
item | Item5e | Item being used. |
config | ItemUseConfiguration | Configuration data for the item usage being prepared. |
options | ItemUseOptions | Additional options used for configuring item usage. |
usage | object | |
usage.actorUpdates | object | Updates that will be applied to the actor. |
usage.itemUpdates | object | Updates that will be applied to the item being used. |
usage.resourceUpdates | object[] | Updates that will be applied to other items on the actor. |
Fires before an item chat card is created.
Name | Type | Description |
---|---|---|
item | Item5e | Item for which the chat card is being displayed. |
chatData | object | Data used to create the chat message. |
options | ItemUseOptions | Options which configure the display of the item chat card. |
Fires after an item chat card is created.
Name | Type | Description |
---|---|---|
item | Item5e | Item for which the chat card is being displayed. |
card | ChatMessage|object | The created ChatMessage instance or ChatMessageData depending on whether options.createMessage was set to true . |
Fires when an item is used, after the measured template has been created if one is needed.
Name | Type | Description |
---|---|---|
item | Item5e | Item being used. |
config | ItemUseConfiguration | Configuration data for the roll. |
options | ItemUseOptions | Additional options for configuring item usage. |
Fires before an attack is rolled for an Item. Returning false
will prevent the attack from being rolled.
Name | Type | Description |
---|---|---|
item | Item5e | Item for which the roll is being performed. |
config | D20RollConfiguration | Configuration data for the pending roll. |
Fires after an attack has been rolled for an Item.
Name | Type | Description |
---|---|---|
item | Item5e | Item for which the roll was performed. |
roll | D20Roll | The resulting roll. |
Fires before a damage is rolled for an Item. Returning false
will prevent the damage from being rolled.
Name | Type | Description |
---|---|---|
item | Item5e | Item for which the roll is being performed. |
config | DamageRollConfiguration | Configuration data for the pending roll. |
Fires after a damage has been rolled for an Item.
Name | Type | Description |
---|---|---|
item | Item5e | Item for which the roll was performed. |
roll | DamageRoll | The resulting roll. |
Fires before the other formula is rolled for an Item. Returning false
will prevent the formula from being rolled.
Name | Type | Description |
---|---|---|
item | Item5e | Item for which the roll is being performed. |
config | object | Configuration data for the pending roll. |
config.formula | string | Formula that will be rolled. |
config.data | object | Data used when evaluating the roll. |
config.chatMessage | boolean | Should a chat message be created for this roll? |
Fires after the other formula has been rolled for an Item.
Name | Type | Description |
---|---|---|
item | Item5e | Item for which the roll was performed. |
roll | Roll | The resulting roll. |
Fires before the Item is rolled to recharge. Returning false
will prevent the recharge from being rolled.
Name | Type | Description |
---|---|---|
item | Item5e | Item for which the roll is being performed. |
config | object | Configuration data for the pending roll. |
config.formula | string | Formula that will be used to roll the recharge. |
config.data | object | Data used when evaluating the roll. |
config.target | number | Total required to be considered recharged. |
config.chatMessage | boolean | Should a chat message be created for this roll? |
Fires after the Item has rolled to recharge, but before any changes have been performed. Returning false
will prevent the changes from being performed.
Name | Type | Description |
---|---|---|
item | Item5e | Item for which the roll was performed. |
roll | Roll | The resulting roll. |
Fires before a tool check is rolled for an Item. Returning false
will prevent the tool check from being rolled.
Name | Type | Description |
---|---|---|
item | Item5e | Item for which the roll is being performed. |
config | D20RollConfiguration | Configuration data for the pending roll. |
Fires after a tool check has been rolled for an Item.
Name | Type | Description |
---|---|---|
item | Item5e | Item for which the roll was performed. |
roll | D20Roll | The resulting roll. |
Fires when some useful data is dropped onto an ItemSheet5e
. Returning false
will prevent the normal drop handling.
Name | Type | Description |
---|---|---|
item | Item5e | The Item5e. |
sheet | ItemShee5e | The ItemSheet5e application. |
data | object | The data that has been dropped onto the sheet. |