Initial data provided to construct the Actor document
Optionalcontext: Context<TokenDocument>The document context, see foundry.abstract.Document
Internal_itemCached result of .itemTypes
InternalTemporary solution until Foundry v12 where visibility of AE no longer controls if it's temporary.
InternalRetrieve valid skill change targets for this actor.
InternalChange target paths for spellbooks on the actor.
Returns first active owner, favoring players and GM as fallback.
An array of all context note data for this actor.
All skill IDs relevant to this actor
Cached override
Actor's current race item.
Whether current user can see through this actor.
Spell Failure Percentage as number from 0 to 100.
The VisionSharingSheet instance for this actor
InternalComputes armor penalties for this actor.
The resulting penalties from armor.
InternalItem documents to clean links to.
InternalComputes encumbrance values for this actor.
The resulting penalties from encumbrance.
Protected Abstract_finalizeInternalHandle condition track toggling post active effect creation if there's still some issues.
Updated active effect documents
InternalParent document
Collection name
Created documents
Creation data for the documents
Create context options
Triggering user's ID
Rest...args: anyInternalCollection name
Document array
Document ID array
Delete context
User ID
Protected_prepareProtected_prepareProtected_prepareProtected Abstract_prepareProtected Abstract_prepareProtected_resetProtected_restingAdjust temporary hit points.
Value to add to temp HP
Optionaloptions: { Additonal optons
If true, the temporary hit points are set to the provide value instead of added to existing.
Converts currencies of the given category to the given currency type
Optionalcategory: "currency" | "altCurrency" = "currency"Currency category, altCurrency is for weightless
Optionaltype: Target currency.
Updated document or undefined if no update occurred.
Enable and configure a new spellbook.
Optionalcasting: { Book casting configuration
Spellcasting ability score ID
Has cantrips?
Class tag
Domain/School slots
Level offset
Casting progression type
Spell/spellcasting type
Spellbook type
Show defenses in chat
Optionaloptions: { Additional options
The roll mode to use for the roll; defaults to the user's current preference when null.
Relevant token if any.
Enrich context notes with item specific roll data.
Adds enriched array to each note object.
Context notes
OptionalrollData: objectRoll data instance
Optionaloptions: { Additional options
Handle rolls
Deletes expired temporary active effects and disables linked expired buffs.
Optionaloptions: { Additional options
Combat to expire data in, if relevant
Expiration event
Initiative based expiration marker
Time offset from world time
World time
Optionalcontext: DocumentModificationContext = {}Document update context
Generates an array with all the active context-sensitive notes for the given context on this actor.
The context to draw from.
Optionalall: boolean = trueRetrieve notes meant for all, such as notes targeting all skills.
Returns a list of already parsed context notes.
The context to draw notes from.
Optionaloptions: { Additional options
Option to pass to getContextNotes
Whether to roll inline rolls or not.
The resulting notes, already parsed.
Get total currency in category.
Optionalcategory: "currency" | "altCurrency" = "currency"Currency category.
Optionaloptions: { Additional options
Return result in lowest denomination. If false, returns gold instead.
ProtectedgetProtectedOptionaloptions: { Additional options
If false, damage resistances (DR, ER) are omitted.
If false, damage vulnerabilities are omitted.
Return feat counts.
An object with a property value which refers to the current used feats, and max which refers to the maximum available feats.
ProtectedgetAbstractgetProtectedgetCreate a new Token document, not yet saved to the database, which represents the Actor, and apply actor size to it.
Optionaldata: object = {}Additional data, such as x, y, rotation, etc. for the created token data
Optionaloptions: object = {}The options passed to the TokenDocument constructor
The created TokenDocument instance
Total coinage in both weighted and weightless.
Optionaloptions: { Additional options
Use copper for calculations and return.
ProtectedgetProtectedReturns Wound Threshold relevant data.
Optionaloptions: { Additional options
PC/NPC health config variant data
ProtectedgetProtectedReturns effective Wound Threshold multiplier with rules and overrides applied.
Optionaloptions: { Additional options
PC/NPC health config variant data
Multiplier
Test if actor is proficient with specified weapon.
Item to test
Optionaloptions: { Additional options
Allow item's proficiency override to influence the result.
ProtectedmodifyProtectedProtectedparsePerform all changes related to an actor resting, including restoring HP, ability scores, item uses, etc.
Options affecting an actor's resting
Updates applied to the actor, if resting was completed
ProtectedprepareCMBProtectedprepareProtectedprepareRecharge all owned items.
Optionaloptions: RechargeActorItemsOptions = {}Additional options
Restore spellbook used slots and spellpoints.
Optionaloptions: { Additional options
If false, return update data object instead of directly updating the actor.
Roll data
Result of update or the update data.
Roll an Ability Test Prompt the user for input regarding Advantage/Disadvantage and any Situational Bonus
The ability ID (e.g. "str")
Optionaloptions: object = {}Additional options
The chat message if one was created, or its data if not. void if the roll was cancelled.
Roll a generic attack
Optionaloptions: ActorRollOptions = {}Roll options
The chat message if one was created, or its data if not. void if the roll was cancelled.
Roll basic BAB check
Optionaloptions: ActorRollOptions = {}Additional options
The chat message if one was created, or its data if not. void if the roll was cancelled.
Roll a Caster Level check using a particular spellbook of this actor
Spellbook identifier
Optionaloptions: ActorRollOptions = {}Roll options
The chat message if one was created, or its data if not. void if the roll was cancelled.
Roll a concentration check using a particular spellbook of this actor
Spellbook identifier
Optionaloptions: ActorRollOptions = {}Roll options
The chat message if one was created, or its data if not. void if the roll was cancelled.
Roll initiative for one or multiple Combatants associated with this actor. If no combat exists, GMs have the option to create one. If viewing a full Actor document, all Tokens which map to that actor will be targeted for initiative rolls. If viewing a synthetic Token actor, only that particular Token will be targeted for an initiative roll.
Optionaloptions: { Options which configure how initiative is rolled
Formula for bonus to initiative
Create new Combatant entries for tokens associated with this actor.
Formula override for dice to roll
Options to pass to ()
Reroll initiative for existing Combatants
Roll mode override
Skip roll dialog
For which token this initiative roll is for
The updated Combat document in which initiative was rolled, or null if no initiative was rolled
Roll a specific saving throw
Identifier for saving throw type.
Optionaloptions: ActorRollOptions = {}Roll options.
The chat message if one was created, or its data if not. void if the roll was cancelled.
Roll a Skill Check
The skill id (e.g. "per", "prf.prf1", or "crf.alchemy")
Optionaloptions: ActorRollOptions = {}Options which configure how the skill check is rolled
The chat message if one was created, or its data if not. void if the roll was cancelled.
Easy way to set a condition.
A direct condition key, as per pf1.registry.conditions, such as shaken or dazed.
Whether to enable (true) the condition, or disable (false) it. Or object for merging into the active effect as part of enabling.
Optionalcontext: objectUpdate context
Condition ID to boolean mapping of actual updates.
Set state of multiple conditions. Also handles condition tracks to minimize number of updates.
Condition ID to boolean (or update data) mapping of new condition states. See ()
Optionalcontext: object = {}Update context
Condition ID to boolean mapping of actual updates.
Easy way to toggle a condition.
A direct condition key, as per pf1.registry.conditions, such as shaken or dazed.
OptionalaeData: objectExtra data to add to the AE if it's being enabled
Condition ID to boolean mapping of actual updates.
Synced with Foundry v12.328
Called by TokenHUD
Internalthe item to add to the actor's resources
Optionaloptions: { extra options
Skips warning if item tag already exists in dictionary flags
True if resources were set
InternalResize token sizes based on actor size.
Ignores tokens with static size set.
OptionalsizeKey: string = undefinedSize key to update to. If not provided, will use actor's current size.
Optionaloptions: object = {}Additional options
ProtectedupdateStatic_getInternalSource info
Static_onStaticapplyApply rolled dice damage to the token or tokens which are currently controlled. This allows for damage to be scaled by a multiplier to account for healing, critical hits, or resistance If Shift is held, will prompt for adjustments based on damage reduction and energy resistances
The amount of damage to deal.
Optionaloptions: { Object containing default settings for overriding
Marks the damage as non-lethal
Apply damage to wounds directly instead of vigor, as needed for Wounds & Vigor variant health rule.
Critical multiplier as needed for Wounds & Vigor variant health rule. Set to 0 for non-critical hits.
Is this dual dealing? If enabled, healing affects both normal health and nonlethal.
Triggering element, if any.
Triggering event, if any
Forces the opening of a Dialog as if Shift was pressed
Individual instances of damage. This is not processed currently.
Chat message reference if any. This is to help modules, the system does not use it.
Default value for Damage Reduction
Override the targets to apply damage to
StaticchatStaticgetStaticgetGet melee and reach maximum ranges.
Actor size as size key or number
Actor stature
StaticgetStaticget
Extend the base Actor class to implement additional game system logic.