Test visibility of a target object or array of points for a specific vision source.
The vision source being tested
The detection mode configuration
The visibility test configuration
Is the test target visible?
Reset the state of this data instance back to mirror the contained source data, erasing any changes.
Clone a model, creating a new data model by combining current data with provided overrides.
The cloned Document instance
Validate the data contained in the document to check for type and content This function throws an error if data within the document is not valid
Optional parameters which customize how validation occurs.
An indicator for whether the document contains valid data
Update the DataModel locally by applying an object of changes to its source data. The provided changes are cleaned, validated, and stored to the source data object for this model. 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
An object containing the changed keys and values
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.
The extracted primitive object
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
Evaluate a single test point to confirm whether it is visible. Standard detection rules require that the test point be both within LOS and within range.
The vision source being tested
The detection mode configuration
The target object being tested
The test case being evaluated
Test whether the line-of-sight requirement for detection is satisfied. Always true if the detection mode bypasses walls, otherwise the test point must be contained by the LOS polygon. The result of is cached for the vision source so that later checks for other detection modes do not repeat it.
The vision source being tested
The detection mode configuration
The target object being tested
The test case being evaluated
Is the LOS requirement satisfied for this test?
Test whether the target is within the vision angle.
The vision source being tested
The detection mode configuration
The target object being tested
The test case being evaluated
Is the point within the vision angle?
Verify that a target is in range of a source.
The vision source being tested
The detection mode configuration
The target object being tested
The test case being evaluated
Is the target within range?
Configure the data model instance before validation and initialization workflows are performed.
Initialize 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
Migrated and cleaned source data which will be stored to the model instance
Initialize the instance by copying data from the source object to instance attributes. This mirrors the workflow of SchemaField#initialize but with some added functionality.
Define the data schema for documents of this type. The schema is populated the first time it is accessed and cached for future reuse.
Clean a data source object to conform to a specific provided schema.
The cleaned source data
Get an array of validation errors from the provided error structure
Evaluate 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
Create 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.
Model construction context
Create a DataModel instance using a provided serialized JSON string.
Serialized document data in string format
A constructed data model instance
Migrate 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, if necessary
Wrap data migration in a try/catch which attempts it safely
The candidate source data from which the model will be constructed
Migrated source data, if necessary
Take 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
Additional shimming options
Data with added backwards-compatible properties
A generator that orders the DataFields in the DataSchema into an expected initialization order.
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.
An optional filter to apply on the target when it is detected with this mode.
The type of the detection mode. If its sight based, sound based, etc. It is related to wall's WALL_RESTRICTION_TYPES
The identifier of the basic sight detection mode.
Define the data schema for this document instance.
Is the current state of this DataModel invalid? The model is invalid if there is any unresolved failure.
An array of validation failure instances which may have occurred when this instance was last validated.
The Data Schema for all instances of this DataModel.
Detection mode that see creatures in contact with the ground.