Construct a Vision Mode using provided configuration parameters and callback functions.
Data which fulfills the model defined by the VisionMode schema.
Optionaloptions: object = {}Additional options passed to the DataModel constructor.
The source data object for this DataModel instance. Once constructed, the source object is sealed such that no keys may be added nor removed.
A flag for whether this vision source is animated
An immutable reverse-reference to a parent DataModel to which this model belongs.
Static Internal_schemaThe defined and cached Data Schema for all instances of this DataModel.
StaticLIGHTING_The lighting illumination levels which are supported.
StaticLIGHTING_Flags for how each lighting channel should be rendered for the currently active vision modes:
StaticLOCALIZATION_A set of localization prefix paths which are used by this DataModel. This provides an alternative to defining the
label and hint property of each field by having foundry map the labels to a structure inside the path
provided by the prefix.
JavaScript class definition and localization call.
class MyDataModel extends foundry.abstract.DataModel {
static defineSchema() {
return {
foo: new foundry.data.fields.StringField(),
bar: new foundry.data.fields.NumberField()
};
}
static LOCALIZATION_PREFIXES = ["MYMODULE.MYDATAMODEL"];
}
Hooks.on("i18nInit", () => {
// Foundry will attempt to automatically localize models registered for a document subtype, so this step is only
// needed for other data model usage, e.g. for a Setting.
Localization.localizeDataModel(MyDataModel);
});
JSON localization file
{
"MYMODULE": {
"MYDATAMODEL": {
"FIELDS" : {
"foo": {
"label": "Foo",
"hint": "Instructions for foo"
},
"bar": {
"label": "Bar",
"hint": "Instructions for bar"
}
}
}
}
}
Is the current state of this DataModel invalid? The model is invalid if there is any unresolved failure.
Does this vision mode enable light sources? True unless it disables lighting entirely.
Define the data schema for this document instance.
An array of validation failure instances which may have occurred when this instance was last validated.
StaticschemaThe Data Schema for all instances of this DataModel.
Abstract_activateSpecial activation handling that could be implemented by VisionMode subclasses
Activate this VisionMode for a specific source
Abstract_deactivateSpecial deactivation handling that could be implemented by VisionMode subclasses
Deactivate this VisionMode for a specific source
Special handling which is needed when this Vision Mode is activated for a PointVisionSource.
Activate this VisionMode for a specific source
An animation function which runs every frame while this Vision Mode is active.
The deltaTime passed by the PIXI Ticker
Clone a model, creating a new data model by combining current data with provided overrides.
Optionaldata: object = {}Additional data which overrides current document data at the time of creation
Optionalcontext: DataModelConstructionContext = {}Context options passed to the data model constructor
The cloned instance
Special handling which is needed when this Vision Mode is deactivated for a PointVisionSource.
Deactivate this VisionMode for a specific source
Reset the state of this data instance back to mirror the contained source data, erasing any changes.
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.
Optionalsource: boolean = trueDraw values from the underlying data source rather than transformed values
The extracted primitive object
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. If changes are provided, missing types are added to it before cleaning and validation. This mutates the provided changes. This function throws an error if data within the document is not valid.
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_configureProtectedConfigure the data model instance before validation and initialization workflows are performed.
Optionaloptions: object = {}Additional options modifying the configuration
Protected_initializeProtectedInitialize 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_initializeProtectedInitialize 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: object = {}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
StaticcleanClean a data source object to conform to a specific provided schema.
Optionalsource: object = {}The source data object
Optionaloptions: object = {}Additional options which are passed to field cleaning methods
The cleaned source data, which is the same object as the source argument
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;
}
}
StaticfromJSONCreate 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 is presumed to be trustworthy and is not strictly validated.
Initial document data which comes from a trusted source.
Optionalcontext: Omit<DataModelConstructionContext, "strict"> & DataModelFromSourceOptions = {}Model construction context
StaticmigrateMigrate candidate source data for this DataModel which may require initial cleaning or transformations.
The candidate source data from which the model will be constructed
Migrated source data, which is the same object as the source argument
StaticmigrateWrap data migration in a try/catch which attempts it safely
The candidate source data from which the model will be constructed
Migrated source data, which is the same object as the source argument
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
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_initializationProtectedA generator that orders the DataFields in the DataSchema into an expected initialization order.
A Vision Mode which can be selected for use by a Token. The selected Vision Mode alters the appearance of various aspects of the canvas while that Token is the POV.