Optionaldata: Partial<RegionData> = {}Initial data used to construct the data object. The provided object will be owned by the constructed model instance and may be mutated.
Optionaloptions: DocumentConstructionContext = {}Context and data validation options which affects initial model construction.
The source data object for this DataModel instance. Once constructed, the source object is sealed such that no keys may be added nor removed.
An immutable reverse-reference to a parent DataModel to which this model belongs.
ReadonlytokensThe tokens inside this region.
Static Internal_The defined and cached Data Schema for all instances of this DataModel.
StaticLOCALIZATION_StaticmetadataDefault metadata which applies to each instance of this Document type.
The area of this Region.
Alias for this.polygonTree.area.
The bounds of this Region.
The value of this property must not be mutated.
Alias for this.polygonTree.bounds.
The Clipper paths of this Region.
The value of this property must not be mutated.
Alias for this.polygonTree.clipperPaths.
The Clipper polygon tree of this Region.
The value of this property must not be mutated.
AbstractcompendiumA reference to the Compendium Collection containing this Document, if any, and otherwise null.
The canonical identifier for this Document.
Is this document in a compendium?
Is the current state of this DataModel invalid? The model is invalid if there is any unresolved failure.
Is this document embedded within a parent document?
Does this Region have a single shape that is not a hole?
The polygons of this Region.
The value of this property must not be mutated.
Alias for this.polygonTree.polygons.
The polygon tree of this Region.
The value of this property must not be mutated.
Define the data schema for this document instance.
The triangulation of this Region.
The value of this property must not be mutated.
Alias for this.polygonTree.triangulation.
A Universally Unique Identifier (uuid) for this Document instance.
An array of validation failure instances which may have occurred when this instance was last validated.
StaticbaseThe base document definition that this document class extends from.
StaticcollectionThe named collection to which this Document belongs.
StaticdatabaseThe database backend used to execute operations and handle results.
StaticdocumentThe canonical name of this Document type, for example "Actor".
StatichasDoes this Document support additional subtypes?
StatichierarchyThe Embedded Document hierarchy for this Document.
StaticimplementationReturn a reference to the configured subclass of this base Document type.
StaticschemaEnsure that all Document classes share the same schema of their base declaration.
StaticTYPESThe allowed types which may exist for this Document class.
InternalUpdate the point sources of this Region document.
Optionalchanges: object = {}The changes that will be applied to this Region.
The computed shape constraint for each shape, if restricted/possible.
InternalCreate the Clipper polygon tree for this Region.
InternalIdentify the collection in a parent Document that this Document belongs to, if any.
OptionalparentCollection: string | nullAn explicitly provided parent collection name.
Post-process a creation operation for a single Document instance. Post-operation events occur for all connected clients.
The initial data object provided to the document creation request
Additional options which modify the creation request
The id of the User requesting the document update
Post-process a deletion operation for a single Document instance. Post-operation events occur for all connected clients.
Additional options which modify the deletion request
The id of the User requesting the document update
InternalCalled when the scene's grid is changed.
The changes to the grid.
Post-process an update operation for a single Document instance. Post-operation events occur for all connected clients.
The differential data that was changed relative to the documents prior values
Additional options which modify the update request
The id of the User requesting the document update
InternalTrigger the Region event.
The event name
The event data
Perform the second step of the DataModel#_updateSource workflow which applies the prepared diff to the model.
The prepared copy of source data with changes applied
The differential changes that were applied to source
Options which determine how the new data is merged
Data cleaning state which might include instructions for final commit
Perform the first step of the DataModel#_updateSource workflow which applies changes to a copy of model source data and records the resulting diff.
A mutable copy of model source data
New values which should be applied to the data model
Options which determine how the new data is merged
Data cleaning state
The resulting difference applied to source data
Test whether a given User has permission to perform some action on this Document
The User attempting modification
The attempted action
Optionaldata: object = {}Data involved in the attempted action
Does the User have permission?
Clamp the given elevation (of a token with a depth) to the elevation range of this Region.
The elevation is clamped such that the head of the token is in the range if possible, but the feet are never outside of the range.
The elevation (of the token)
Optionaldepth: number = 0The depth of the token
The clamped elevation
Clone a document, creating a new document by combining current data with provided overrides. The cloned document is ephemeral and not yet saved to the database.
Additional data which overrides current document data at the time of creation
Additional context options passed to the create method
The cloned Document instance
Create multiple embedded Document instances within this parent Document using provided input data.
The name of the embedded Document type
An array of data objects used to create multiple documents
Optionaloperation: DatabaseCreateOperation = {}Parameters of the database creation workflow
An array of created Document instances
Delete this Document, removing it from the database.
Optionaloperation: Partial<Omit<DatabaseDeleteOperation, "ids">> = {}Parameters of the deletion operation
The deleted Document instance, or undefined if not deleted
Delete multiple embedded Document instances within a parent Document using provided string ids.
The name of the embedded Document type
An array of string ids for each Document to be deleted
Optionaloperation: DatabaseDeleteOperation = {}Parameters of the database deletion workflow
An array of deleted Document instances
Obtain a reference to the Array of source data within the data object for a certain embedded Document name
The name of the embedded Document type
The Collection instance of embedded Documents of the requested type
Get an embedded document by its id from a named collection in the parent document.
The name of the embedded Document type
The id of the child document to retrieve
Optionaloptions: { invalid?: boolean; strict?: boolean } = {}Additional options which modify how embedded documents are retrieved
Optionalinvalid?: booleanAllow retrieving an invalid Embedded Document.
Optionalstrict?: booleanThrow an Error if the requested id does not exist. See Collection#get
The retrieved embedded Document instance, or undefined
Traverse the data model instance, obtaining the DataField definition for a field of a particular property.
A property key like ["abilities", "strength"] or "abilities.strength"
The corresponding DataField definition for that field, or undefined
Get the value of a "flag" for this document See the setFlag method for more details on flags
The flag scope which namespaces the key
The flag key
The flag value
For Documents which include game system data, migrate the system data object to conform to its latest data model. The data model is defined by the template.json specification included by the game system.
The migrated system data object
Present a Dialog form to confirm the removal of a shape.
The shape or shape index.
Optionaloptions: object = {}Additional options passed to DialogV2.confirm
Reset the state of this data instance back to mirror the contained source data, erasing any changes.
Split the movement path into its segments.
The waypoints of movement.
The points relative to the waypoints that are tested. Whenever one of them is inside the region, the moved object is considered to be inside the region.
The movement split into its segments.
Assign a "flag" to this document. Flags represent key-value type data which can be used to store flexible or arbitrary data required by either the core software, game systems, or user-created modules.
Each flag should be set using a scope which provides a namespace for the flag to help prevent collisions.
Flags set by the core software use the "core" scope. Flags set by game systems or modules should use the canonical name attribute for the module Flags set by an individual world should "world" as the scope.
Flag values can assume almost any data type. Setting a flag value to null will delete that flag.
The flag scope which namespaces the key
The flag key
The flag value
A Promise resolving to the updated document
Spawn Tokens into this Region.
The current User must be an owner of the Token Documents and have the TOKEN_CREATE permission
in order to spawn them.
This function can work ephemeral (non-persisted) Region documents.
The data of tokens or Token documents to spawn.
Optionaloptions: {Additional options.
OptionalavoidOccupied?: booleanAvoid occupied grid spaces when placing randomly with snapping.
Default: true.
OptionalcreateOptions?: Partial<Omit<DatabaseCreateOperation, "parent">>Additional create options.
Optionallevel?: stringThe destination Level ID, which must be a Level this Region is in. Default: the Level of the Region if it is in only one Level.
Optionaloffset?: PointThe relative offset position. Default: true.
Optionalplacement?: "center" | "relative" | "random"The placement. Default: "random".
Optionalsnap?: booleanAttempt to spawn the tokens to a snapped position. Default: true.
The array of Token Documents that where created, which might be less than request the creation was disallowed by a preCreate handler
If the current User doesn't have the necessary permissions, the Token Document could not be created or there's no valid placement.
ui.notifications.info("Choose the placement for the spawn area.");
const spawnArea = await canvas.regions.placeRegion({
name: "Spawn Area",
shapes: [{
type: "circle",
x: 0,
y: 0,
radius: canvas.dimensions.distancePixels * 30
}],
restriction: {enabled: true},
levels: [canvas.level.id]
}, {create: false});
if ( spawnArea ) {
const {count: numTokensToSpawn=0} = await foundry.applications.api.DialogV2.input({
window: {
title: "How many tokens to you want to spawn?"
},
content: `<input type="number" name="count" min="0" step="1" value="10">`
}) ?? {};
const actors = game.actors.contents;
const tokensToSpawn = [];
for ( let i = 0; i < numTokensToSpawn; i++ ) {
const actor = actors[Math.floor(Math.random() * actors.length)];
const token = await actor.getTokenDocument({
rotation: Math.random() * 360
}, {parent: spawnArea.parent});
tokensToSpawn.push(token);
}
const spawnedTokens = await spawnArea.spawnTokens(tokensToSpawn);
}
Teleport a Token into this Region.
The Token may be in the same Scene as this Region, or in a different Scene.
The current User must be an owner of the Token Document in order to teleport it.
For teleportation to a different Scene the current User requires TOKEN_CREATE and
TOKEN_DELETE permissions. If the Token is teleported to different Scene, it is deleted
and a new Token Document in the other Scene is created.
This function can work with ephemeral (non-persisted) Region documents.
An existing Token Document to teleport.
Optionaloptions: {Additional options.
OptionalavoidOccupied?: booleanAvoid occupied grid spaces when placing randomly with snapping.
Default: true.
Optionaloffset?: PointThe relative offset position.
Optionalpan?: boolean | { duration?: number; transitionType?: string }Pan the canvas (with transition animation) to the destination if the token is controlled? Default: true.
Optionalplacement?: "center" | "relative" | "random"The placement. Default: "random".
Optionalsnap?: booleanAttempt to teleport the tokens to a snapped position. Default: true.
OptionalupdateData?: Partial<TokenData>Additonal Token update data.
The same Token Document if teleported within the same Scene, or a new Token Document if teleported to a different Scene
Teleport Tokens into this Region.
The Tokens may be in the same Scene as this Region, or in a different Scene.
The current User must be an owner of the Token Documents in order to teleport them.
For teleportation to a different Scene the current User requires TOKEN_CREATE and
TOKEN_DELETE permissions. If a Token is teleported to different Scene, it is deleted
and a new Token Document in the other Scene is created.
This function can work ephemeral (non-persisted) Region documents.
Existing Token Documents to teleport.
Optionaloptions: {Additional options.
OptionalavoidOccupied?: booleanAvoid occupied grid spaces when placing randomly with snapping.
Default: true.
Optionallevel?: stringThe destination Level ID, which must be a Level this Region is in. Default: the Level of the Region if it is in only one Level.
Optionaloffset?: PointThe relative offset position.
Optionalpan?: boolean | { duration?: number; force?: boolean; transitionType?: string }Pan the canvas (with transition animation) to the destination if the token is controlled? Default: true.
Optionalplacement?: "center" | "relative" | "random"The placement. Default: "random".
Optionalsnap?: booleanAttempt to teleport the tokens to a snapped position. Default: true.
OptionalupdateData?: Map<TokenDocument, Partial<TokenData>>Additonal update data.
The mapping of deleted to created Token Documents.
Test whether the given point (at the given elevation) is inside this Region.
The point.
Is the point inside this Region?
Test whether a certain User has a requested permission level (or greater) over the Document
The User being tested
The permission level from DOCUMENT_OWNERSHIP_LEVELS to test
Additional options involved in the permission test
Optionalexact?: booleanRequire the exact permission level requested?
Does the user have this permission level over the Document?
Extract the source data for the DataModel into a simple object format that can be serialized.
The document source data expressed as a plain object
Copy and transform the DataModel into a plain object. Draw the values of the extracted object from the data source (by default) otherwise from its transformed values.
Draw values from the underlying data source rather than transformed values
The extracted primitive object
Remove a flag assigned to the document.
The flag scope which namespaces the key
The flag key
The updated document instance
Update this Document using incremental data, saving it to the database.
Optionaldata: object = {}Differential update data which modifies the existing values of this document
Optionaloperation: Partial<Omit<DatabaseUpdateOperation, "updates">> = {}Parameters of the update operation
The updated Document instance, or undefined not updated
Update multiple embedded Document instances within a parent Document using provided differential data.
The name of the embedded Document type
An array of differential data objects, each used to update a single Document
Optionaloperation: DatabaseUpdateOperation = {}Parameters of the database update workflow
An array of updated Document instances
Update the shape constraints of this Region if the current User is designated for it.
Optionaloptions: { save?: boolean } = {}Additional options
Optionalsave?: booleanPersist the shape constraints changes? Default: false.
Update the DataModel locally by applying an object of changes to its source data. The provided changes are expanded, cleaned, validated, and stored to the source data object for this model. The provided changes argument is mutated in this process. The source data is then re-initialized to apply those changes to the prepared data. The method returns an object of differential changes which modified the original data.
New values which should be applied to the data model
Options which determine how the new data is merged
An object containing differential keys and values that were changed
Validate the data contained in the document to check for type and content. This method is intended to validate complete model records, verifying both individual field validation as well as joint model validity.
For validating sets of partial model changes, it is preferred to call DataModel#updateSource as a dryRun. This
method provides a convenience alias for such a workflow if changes are provided.
Warning: if fallback handling is allowed, this process will mutate provided changes or model source data.
Options which modify how the model is validated
Whether the data source or proposed change is reported as valid. A boolean is always returned if validation is non-strict.
Protected_ProtectedCompute the shape constraint for the given origin and config.
The origin of the constraint.
The config of the constraint.
The shape constraint.
Protected_ProtectedInitialize the instance by copying data from the source object to instance attributes. This mirrors the workflow of SchemaField#initialize but with some added functionality.
Optionaloptions: object = {}Options provided to the model constructor
Protected_ProtectedInitialize the source data for a new DataModel instance. One-time migrations and initial cleaning operations are applied to the source data.
The candidate source data from which the model will be constructed
Optionaloptions: DocumentConstructionContext = {}Options provided to the model constructor
Migrated and cleaned source data which will be stored to the model instance,
which is the same object as the data argument
Protected_ProtectedCalled when the polygon tree of the Region has changed.
Protected_ProtectedPre-process a creation operation for a single Document instance. Pre-operation events only occur for the client which requested the operation.
Modifications to the pending Document instance must be performed using updateSource.
The initial data object provided to the document creation request
Additional options which modify the creation request
The User requesting the document creation
Return false to exclude this Document from the creation operation
Protected_ProtectedPre-process a deletion operation for a single Document instance. Pre-operation events only occur for the client which requested the operation.
Additional options which modify the deletion request
The User requesting the document deletion
A return value of false indicates the deletion operation should be cancelled.
Protected_ProtectedPrepare the state object that is transacted through an updateSource operation.
New values which should be applied to the data model
Options which determine how the new data is merged
Data model update state
Static_InternalActivate the Socket event listeners.
The active game socket
Static_InternalDefine a simple migration from one field name to another. The value of the data can be transformed during the migration by an optional application function.
The data object being migrated
The old field name
The new field name
Optionalapply: (data: object) => anyAn application function, otherwise the old value is applied
Whether a migration was applied.
Static_InternalA reusable helper for adding a migration shim The value of the data can be transformed during the migration by an optional application function.
The data object being shimmed
The old field name
The new field name
Optionaloptions: { value?: any; warning?: string } = {}Options passed to foundry.utils.logCompatibilityWarning
Optionalvalue?: anyThe value of the shim
Optionalwarning?: stringThe deprecation message
Static_InternalA reusable helper for adding migration shims.
The data object being shimmed
The mapping of old keys to new keys
Optionaloptions: { value?: any; warning?: string }Options passed to foundry.utils.logCompatibilityWarning
Optionalvalue?: anyThe value of the shim
Optionalwarning?: stringThe deprecation message
Static_InternalClear the fields from the given Document data recursively.
The (partial) Document data
The fields that are cleared
Optionaloptions: { callback?: RecursiveFieldClearCallback } = {}Optionalcallback?: RecursiveFieldClearCallbackA callback that is invoked on each field in order to clear it.
Static_InternalLog a compatbility warning for the data field migration.
The old field name
The new field name
Optionaloptions: object = {}Options passed to foundry.utils.logCompatibilityWarning
Static_InternalMigrate MeasuredTemplate data to Region data.
The MeasuredTemplate data
Optionalcontext: {The migration context
OptionalconeTemplateType?: "flat" | "round"The cone curvature
Optionalgrid?: BaseGrid<GridCoordinates2D, GridCoordinates3D>The grid
OptionalgridTemplates?: booleanGrid-shaped?
Optionalusers?: UserData[]The users
The Region data
Static_Post-process a creation operation, reacting to database changes which have occurred. Post-operation events occur for all connected clients.
This batch-wise workflow occurs after individual _onCreate workflows.
The Document instances which were created
Parameters of the database creation operation
The User who performed the creation operation
Static_Static_Static_Apply preliminary model-specific cleaning rules or alter cleaning options or initial state. Subclass models may implement this function to configure the cleaning workflow. Any mutations to data, options, or _state parameters are performed inplace.
The provided input data for cleaning
Options which define how cleaning should be performed
The data cleaning state
Static_Pre-process a creation operation, potentially altering its instructions or input data. Pre-operation events only occur for the client which requested the operation.
This batch-wise workflow occurs after individual _preCreate workflows and provides a final pre-flight check before a database operation occurs.
Modifications to pending documents must mutate the documents array or alter individual document instances using updateSource.
Pending document instances to be created
Parameters of the database creation operation
The User requesting the creation operation
Return false to cancel the creation operation entirely
Static_Pre-process an update operation, potentially altering its instructions or input data. Pre-operation events only occur for the client which requested the operation.
This batch-wise workflow occurs after individual _preUpdate workflows and provides a final pre-flight check before a database operation occurs.
Modifications to the requested updates are performed by mutating the data array of the operation.
Document instances to be updated
Parameters of the database update operation
The User requesting the update operation
Return false to cancel the update operation entirely
StaticcanStaticcleanClean a data source object to conform to a specific provided schema.
Optionaldata: object = {}Provided model data that requires cleaning
Optionaloptions: DataModelCleaningOptions = {}Options that configure how data cleaning is performed
Optional_state: Partial<data.types.DataModelUpdateState> = {}Internal options used during cleaning recursion
Cleaned data which is suitable for validation and usage
StaticcreateCreate a new Document using provided input data, saving it to the database.
Optionaldata: Initial data used to create this Document, or a Document instance to persist.
Optionaloperation: Partial<Omit<DatabaseCreateOperation, "data">> = {}Parameters of the creation operation
The created Document instance(s)
const data = [{name: "Special Sword", type: "weapon"}];
const created = await Item.implementation.create(data);
StaticcreateCreate multiple Documents using provided input data. Data is provided as an array of objects where each individual object becomes one new Document.
An array of data objects or existing Documents to persist.
Optionaloperation: Partial<Omit<DatabaseCreateOperation, "data">> = {}Parameters of the requested creation operation
An array of created Document instances
const data = [{name: "New Actor", type: "character", img: "path/to/profile.jpg"}];
const created = await Actor.implementation.createDocuments(data);
const data = [{name: "Tim", type: "npc"], [{name: "Tom", type: "npc"}];
const created = await Actor.implementation.createDocuments(data);
StaticcreateCreate an emanation Region for the Token and attach it to the Token.
The Token to attach the emanation Region to
The range of the emanation in grid units
The Region data of the emanation
Optionaloptions: any = {}Additional options
The created Region document unless the creation was prevented
StaticdefineDefine the data schema for models of this type. The schema is populated the first time it is accessed and cached for future reuse.
The schema, through its fields, provide the essential cleaning, validation, and initialization methods to turn the _source values into direct properties of the data model. The schema is a static property of the model and is reused by all instances to perform validation.
The schemas defined by the core software in classes like foundry.documents.BaseActor are validated by the
server, where user code does not run. However, almost all documents have a flags field to store data, and many
have a system field that can be configured to be a foundry.abstract.TypeDataModel instance. Those models
are not constructed on the server and rely purely on client-side code, which means certain extra-sensitive fields
must be also be registered through your package manifest. foundry.packages.types.ServerSanitizationFields
class SomeModel extends foundry.abstract.DataModel {
static defineSchema() {
return {
foo: new foundry.data.fields.StringField()
}
}
}
class AnotherModel extends SomeModel {
static defineSchema() {
// Inheritance and object oriented principles apply to schema definition
const schema = super.defineSchema()
schema.bar = new foundry.data.fields.NumberField()
return schema;
}
}
StaticdeleteDelete one or multiple existing Documents using an array of provided ids. Data is provided as an array of string ids for the documents to delete.
An array of string ids for the documents to be deleted
Optionaloperation: Partial<Omit<DatabaseDeleteOperation, "ids">> = {}Parameters of the database deletion operation
An array of deleted Document instances
const tim = game.actors.getName("Tim");
const deleted = await Actor.implementation.deleteDocuments([tim.id]);
const tim = game.actors.getName("Tim");
const tom = game.actors.getName("Tom");
const deleted = await Actor.implementation.deleteDocuments([tim.id, tom.id]);
StaticfromCreate a DataModel instance using a provided serialized JSON string.
Serialized document data in string format
A constructed data model instance
StaticfromCreate a new instance of this DataModel from a source record. The source data is presumed trustworthy and is not strictly validated unless explicitly requested.
Initial document data which comes from a trusted source.
Optionalcontext: Omit<DataModelConstructionContext, "strict"> & DataModelFromSourceOptions = {}Model construction context
StaticgetGet a World-level Document of this type by its id.
The Document ID
Optionaloperation: DatabaseGetOperation = {}Parameters of the get operation
The retrieved Document, or null
StaticgetA compatibility method that returns the appropriate name of an embedded collection within this Document.
An existing collection name or a document name.
The provided collection name if it exists, the first available collection for the document name provided, or null if no appropriate embedded collection could be found.
StaticmigrateMigrate candidate source data for this DataModel which may require initial cleaning or transformations.
Candidate source data for the module, before further cleaning
Optionaloptions: Readonly<DataModelCleaningOptions>Additional options for how the field is cleaned
Optional_state: data.types.DataModelUpdateStateInternal state variables which are used during recursion
Migrated source data, ready for further cleaning
StaticmigrateWrap data migration in a try/catch which attempts it safely.
Candidate source data for the module, before further cleaning
Optionaloptions: Readonly<DataModelCleaningOptions> = {}Additional options for how the field is cleaned
Migrated source data, ready for further cleaning
StaticshimTake data which conforms to the current data schema and add backwards-compatible accessors to it in order to support older code which uses this data.
Data which matches the current schema
Optionaloptions: { embedded?: boolean } = {}Additional shimming options
Optionalembedded?: booleanApply shims to embedded models?
Data with added backwards-compatible properties, which is the same object as
the data argument
StaticupdateUpdate multiple Document instances using provided differential data. Data is provided as an array of objects where each individual object updates one existing Document.
An array of differential data objects, each used to update a single Document
Optionaloperation: Partial<Omit<DatabaseUpdateOperation, "updates">> = {}Parameters of the database update operation
An array of updated Document instances
const updates = [{_id: "12ekjf43kj2312ds", name: "Timothy"}];
const updated = await Actor.implementation.updateDocuments(updates);
const updates = [{_id: "12ekjf43kj2312ds", name: "Timothy"}, {_id: "kj549dk48k34jk34", name: "Thomas"}]};
const updated = await Actor.implementation.updateDocuments(updates);
StaticvalidateEvaluate joint validation rules which apply validation conditions across multiple fields of the model. Field-specific validation rules should be defined as part of the DataSchema for the model. This method allows for testing aggregate rules which impose requirements on the overall model.
Candidate data for the model
Protected Static_ProtectedApply final custom model-specific cleaning rules after data schema fields are cleaned. Subclass models can implement this function as an ideal place to apply custom imputation or cleaning. Cleaning must be done in-place rather than returning a different object.
The provided input data for cleaning
Options which define how cleaning was performed
The data cleaning state
The original data object, with cleaning performed inplace
Protected Static_ProtectedPre-process a deletion operation, potentially altering its instructions or input data. Pre-operation events only occur for the client which requested the operation.
This batch-wise workflow occurs after individual _preDelete workflows and provides a final pre-flight check before a database operation occurs.
Modifications to the requested deletions are performed by mutating the operation object. updateSource.
Document instances to be deleted
Parameters of the database update operation
The User requesting the deletion operation
Return false to cancel the deletion operation entirely
The client-side Region document which extends the common BaseRegion model.
Mixes
CanvasDocumentMixin
See