Per-target options from apply damage dialog to be passed to ActorPF#applyDamage fucntion.
Called just before the apply damage dialog passes
Post attack roll hook fired after evaluating attack roll.
Health Delta render hook
Allows altering scrolling text rendered for health changes.
Pre-attack roll hook fired before rolling an attack.
Action triggering the attack roll
Attack configuration
Roll data
Options to be passed to D20RollPF
Individual Roll parts added to formula
The Changes applicable to this attack before they're reduced to the highest bonus of each type
Pre-attack roll hook fired before rolling an attack.
Action triggering the attack roll
Roll data
Individual DamageParts added to formula (only the first's extra is used)
The Changes applicable to this attack before they're reduced to the highest bonus of each type
Token HUD quick action render.
Token HUD
Token placeable
HTML document fragment before being added to DOM.
A hook event fired by the system when an action is to be used. This hook fires before any updates are applied to the actor/item, like ammo or spell slots, and before any attacks are rolled.
A hook event fired by the system when an action has been successfully used. This hook fires after the action has been used and after any chat .
A hook event fired by the system when an action is to be used. This hook fires before any updates are applied to the actor/item, like ammo or spell slots and includes all of the action's rolled attacks.
A hook event fired by the system when an action is used, before the chat message is created.
A hook event fired by the system after an actor has rested.
The actor who has rested.
The options passed to the method's call. Mutating this data will not affect the system's calculations, as they are finished when this hook is fired. This data can be used to base different rest calculations on, however.
The data the resting actor was updated with.
An array of item updates applied to the resting actor.
A hook event fired by the system when an ActorPF gains XP.
A hook event fired by the system when an actor's ActorPF.performRest is called.
The actor who is resting.
The options passed to the method's call. Mutating this data will not affect the system's calculations, as they are finished when this hook is fired. This data can be used to base different rest calculations on, however.
The data the resting actor will be updated with. This data object can be mutated to affect the update (e.g. the number of hit points).
An array of item updates to be applied to the resting actor. This array can be mutated to affect the update (e.g. which item's uses are restored).
Explicitly return false to prevent the actor from resting.
A hook event fired by the system when an ActorPF's base data is prepared. This happens whenever an actor is updated, and the preparation process is expected to be synchronous. Data added or mutated asynchronously might not be factored in at all.
A hook event fired by the system when an ActorPF's derived data is prepared. This happens whenever an actor is updated, and the preparation process is expected to be synchronous. Data added or mutated asynchronously might not be factored in at all.
A hook event fired by the system when pf1.models.item.BuffModel#active has changed in an item embedded in an actor has changed.
This is also fired when a buff with its active state already set to true is added to an actor.
A hook event fired by the system when one or more of an actor's conditions have changed.
The conditions object can be found in actor.system.conditions.
The actor whose conditions have changed.
The name of the condition that has changed as per CONFIG.PF1.conditionTypes.
The new state of the condition.
A hook event fired by the system after an ActorPF rolled an ability check.
The actor who rolled an ability check
The roll result, either as ChatMessage if one was created, or as object containing data that would have been used to create one.
The key of the ability that was rolled
A hook event fired by the system after an ActorPF rolled their BAB.
A hook event fired by the system after an ActorPF rolled a caster level check.
The actor who rolled a caster level check
The roll result, either as ChatMessage if one was created, or as object containing data that would have been used to create one.
The key of the spellbook whose caster level was rolled
A hook event fired by the system after an ActorPF rolled a concentration check.
The actor who rolled a concentration check
The roll result, either as ChatMessage if one was created, or as object containing data that would have been used to create one.
The key of the spellbook whose concentration was rolled
A hook event fired by the system after an ActorPF rolled a save.
The actor who rolled a save
The roll result, either as ChatMessage if one was created, or as object containing data that would have been used to create one.
The key of the save that was rolled
A hook event fired by the system after an ActorPF rolled a skill.
The actor who rolled a skill
The roll result, either as ChatMessage if one was created, or as object containing data that would have been used to create one.
The ID of the skill that was rolled
A hook event fired by the system when an ActorPF rolls an ability check.
The actor rolling an ability check
Additional options for the roll
The key of the ability being rolled
Explicitly return false to prevent the actor from rolling the ability check.
A hook event fired by the system when an ActorPF rolls their BAB.
The actor rolling their BAB
Additional options for the roll
Explicitly return false to prevent the actor from rolling their BAB.
A hook event fired by the system when an ActorPF rolls a caster level check.
The actor rolling a caster level check
Additional options for the roll
The key of the spellbook whose caster level is rolled
Explicitly return false to prevent the actor from rolling the caster level check.
A hook event fired by the system when an ActorPF rolls a concentration check.
The actor rolling a concentration check
Additional options for the roll
The key of the spellbook whose concentration is rolled
Explicitly return false to prevent the actor from rolling the concentration check.
A hook event fired by the system when an ActorPF rolls a save.
The actor rolling a save
Additional options for the roll
The key of the save being rolled
Explicitly return false to prevent the actor from rolling the save.
A hook event fired by the system when an ActorPF rolls a skill.
The actor rolling a skill
Additional options for the roll
The ID of the skill being rolled
Explicitly return false to prevent the actor from rolling the skill.
Extended tooltip render hook just before tooltip is activated.
Linked sheet
Tooltip ID
HTML document fragment providing live DOM to the tooltip.
A hook event fired by the system when an actor's data is prepared and the system adds inherent/default Changes.
A hook event fired by the system when the system determines which data fields a change target should affect, i.e. flattens the change target to target data fields. This is called for every Change on every actor for every data preparation, so callbacks should be efficient.
An array of target data fields.
The change target as per the change's target property,
see Change#target and change targets.
The change type as per the change's modifier property,
see Change#type and change types.
The numerical change value, if any.
The actor the change is being applied to.
// Add a change target
Hooks.once("init", () => {
CONFIG.PF1.buffTargets.gp = {
label: "Gold Pieces",
category: "misc",
};
});
// Define the correct data field for the change to target
Hooks.on("pf1GetChangeFlat", (result, target, modifierType, value, actor) => {
if (target === "gp") {
result.push("system.currency.gp");
}
});
Hook event fired when turns are skipped in combat.
Relevant combat instance
Set of combatants whose turn was passed over.
Combat update context object.
A hook event fired by the system when a pf1.dice.d20Roll is rolled. Primarily used by actor non-attack rolls (e.g. skills, attributes, etc).
The roll object, before it's evaluated
Options used to create the roll
Explicitly return false to prevent the roll.
A hook event fired by the system when it has finished its own init phase.
A hook event fired by the system when it has finished its own ready phase.
As the system's ready hook is asynchronous, this is the only hook that guarantees that the system is ready.
The default ready hook includes no such guarantee.
A hook event fired by the system when it has finished its own setup phase.
A hook event fired by the system when the level of a class item is changed.
The actor whose class item's level is being changed.
The class item whose level is being changed.
The current level of the class item.
The new level of the class item.
A hook event fired by the system when an item's chat card is to be displayed.
The item whose chat card is being displayed.
Data related to the item's use.
The data passed to ChatMessage.create (excluding content from the rendered template)
The path of the template used to render the chat card
The data to be passed to the foundry.utils.renderTemplate call. The contents of this object can change unexpectedly, as each change to the system's chat card template or item data will affect it.
Explicitly return false to prevent the item's chat card from being displayed.
A hook event fired by the system after an item link is created.
A hook event fired by the system after an item link is deleted.
A hook event fired by the system when it has finished its migration.
A hook event fired by the system when it starts its migration.
Party rest hook fired after all actors have rested and time has been passed.
Rest configuration object
Party rest hook fired just before the configuration is used to rest the actors and pass time.
Rest configuration object
Explicitly return false to prevent party resting.
A hook event fired by the system when roll data is created. The hook is fired at the end of the system's roll data creation process.
The document or component whose roll data is to be created.
The created roll data that can be modified.
A hook event fired by the system when data is dropped onto an ContainerSheetPF.
The container item the sheet belongs to.
The container item's sheet.
The data that was dropped.
Explicitly return false to prevent the drop event from being handled.
Pre-apply damage
A hook fired just before apply damage starts processing the provided information.