Class ModifyMovementCostRegionBehaviorType

The data model for a behavior that allows to modify the movement cost within the Region.

Hierarchy (View Summary)

Constructors

constructor

Properties

_source events parent _schema events LOCALIZATION_PREFIXES

Accessors

behavior invalid region scene schema validationFailures schema

Methods

_getTerrainEffects _onUpdate _preCreate clone prepareBaseData prepareDerivedData reset toEmbed toJSON toObject updateSource validate _configure _handleRegionEvent _initialize _initializeSource _onCreate _onDelete _preDelete _preUpdate cleanData defineSchema fromJSON fromSource migrateData migrateDataSafe shimData validateJoint _createEventsField _initializationOrder

Constructors

constructor

Properties

_source

_source: object

The source data object for this DataModel instance. Once constructed, the source object is sealed such that no keys may be added nor removed.

events

events: Set<string> = ...

The events that are handled by the behavior.

parent

parent: null | DataModel<object, DataModelConstructionContext>

An immutable reverse-reference to a parent DataModel to which this model belongs.

Static Internal_schema

_schema: SchemaField

The defined and cached Data Schema for all instances of this DataModel.

Staticevents

events: {
    behaviorUnviewed: (
        ...this: any,
        event: RegionBehaviorUnviewedEvent,
    ) => Promise<void>;
    behaviorViewed: (
        ...this: any,
        event: RegionBehaviorViewedEvent,
    ) => Promise<void>;
    regionBoundary: (
        ...this: any,
        event: RegionRegionBoundryEvent,
    ) => Promise<void>;
} = ...

Type declaration

StaticLOCALIZATION_PREFIXES

LOCALIZATION_PREFIXES: string[] = ...

Accessors

behavior

invalid

  • get invalid(): boolean

    Is the current state of this DataModel invalid? The model is invalid if there is any unresolved failure.

    Returns boolean

region

  • get region(): null | RegionDocument

    A convenience reference to the RegionDocument which contains this behavior sub-type.

    Returns null | RegionDocument

scene

  • get scene(): null | documents.Scene

    A convenience reference to the Scene which contains this behavior sub-type.

    Returns null | documents.Scene

schema

  • get schema(): SchemaField

    Define the data schema for this document instance.

    Returns SchemaField

validationFailures

Staticschema

Methods

_getTerrainEffects

  • _getTerrainEffects(
        token: any,
        segment: any,
    ): { difficulty: any; name: string }[]

    Parameters

    • token: any
    • segment: any

    Returns { difficulty: any; name: string }[]

_onUpdate

  • _onUpdate(changed: any, options: any, userId: any): void

    Called by ClientDocumentMixin#_onUpdate.

    Parameters

    • changed: any

      The differential data that was changed relative to the documents prior values

    • options: any

      Additional options which modify the update request

    • userId: any

      The id of the User requesting the document update

    Returns void

_preCreate

  • _preCreate(
        data: object,
        options: object,
        user: BaseUser,
    ): Promise<boolean | void>
    Internal

    Called by ClientDocument#_preCreate.

    Parameters

    • data: object

      The initial data object provided to the document creation request

    • options: object

      Additional options which modify the creation request

    • user: BaseUser

      The User requesting the document creation

    Returns Promise<boolean | void>

    Return false to exclude this Document from the creation operation

clone

prepareBaseData

  • prepareBaseData(): void

    Prepare data related to this DataModel itself, before any derived data (including Active Effects) is computed. This is especially useful for initializing numbers, arrays, and sets you expect to be modified by active effects.

    Called before ClientDocument#prepareBaseData in ClientDocument#prepareData.

    Returns void

    Example

    prepareBaseData() {
      // Ensures an active effect of `system.encumbrance.max | ADD | 10` doesn't produce `NaN`
      this.encumbrance = {
        max: 0
      }
      // If you need to access the owning Document, `this.parent` provides a reference for properties like the name
      // or embedded collections, e.g. `this.parent.name` or `this.parent.items`
    }

prepareDerivedData

  • prepareDerivedData(): void

    Apply transformations or derivations to the values of the source data object. Compute data fields whose values are not stored to the database.

    Called before ClientDocument#prepareDerivedData in ClientDocument#prepareData.

    Returns void

    Example

    prepareDerivedData() {
      this.hp.bloodied = Math.floor(this.hp.max / 2);

      // this.parent accesses the Document, allowing access to embedded collections
      this.encumbrance.value = this.parent.items.reduce((total, item) => {
        total += item.system.weight;
        return total;
      }, 0)
    }

reset

  • reset(): void

    Reset the state of this data instance back to mirror the contained source data, erasing any changes.

    Returns void

toEmbed

  • toEmbed(config: DocumentHTMLEmbedConfig, options?: any): Promise<any>

    Convert this Document to some HTML display for embedding purposes.

    Parameters

    • config: DocumentHTMLEmbedConfig

      Configuration for embedding behavior.

    • Optionaloptions: any = {}

      The original enrichment options for cases where the Document embed content also contains text that must be enriched.

    Returns Promise<any>

toJSON

  • toJSON(): object

    Extract the source data for the DataModel into a simple object format that can be serialized.

    Returns object

    The document source data expressed as a plain object

toObject

  • toObject(source?: boolean): 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.

    Parameters

    • Optionalsource: boolean = true

      Draw values from the underlying data source rather than transformed values

    Returns object

    The extracted primitive object

updateSource

  • updateSource(changes?: object, options?: DataModelUpdateOptions): 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.

    Parameters

    • changes: object = {}

      New values which should be applied to the data model

    • options: DataModelUpdateOptions = {}

      Options which determine how the new data is merged

    Returns object

    An object containing differential keys and values that were changed

    Throws

    An error if the requested data model changes were invalid

validate

  • validate(options?: DataModelValidationOptions): boolean

    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.

    Parameters

    Returns boolean

    Whether the data source or proposed change is reported as valid. A boolean is always returned if validation is non-strict.

    Throws

    An error thrown if validation is strict and a failure occurs.

Protected_configure

  • _configure(options?: object): void
    Protected

    Configure the data model instance before validation and initialization workflows are performed.

    Parameters

    • Optionaloptions: object = {}

      Additional options modifying the configuration

    Returns void

Protected_handleRegionEvent

Protected_initialize

  • _initialize(options?: object): void
    Protected

    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.

    Parameters

    • Optionaloptions: object = {}

      Options provided to the model constructor

    Returns void

Protected_initializeSource

  • _initializeSource(
        data: object | DataModel<object, DataModelConstructionContext>,
        options?: object,
    ): object
    Protected

    Initialize the source data for a new DataModel instance. One-time migrations and initial cleaning operations are applied to the source data.

    Parameters

    • data: object | DataModel<object, DataModelConstructionContext>

      The candidate source data from which the model will be constructed

    • Optionaloptions: object = {}

      Options provided to the model constructor

    Returns object

    Migrated and cleaned source data which will be stored to the model instance, which is the same object as the data argument

Protected_onCreate

  • _onCreate(data: object, options: object, userId: string): void
    Protected

    Called by ClientDocument#_onCreate.

    Parameters

    • data: object

      The initial data object provided to the document creation request

    • options: object

      Additional options which modify the creation request

    • userId: string

      The id of the User requesting the document update

    Returns void

Protected_onDelete

  • _onDelete(options: object, userId: string): void
    Protected

    Called by ClientDocumentMixin#_onDelete.

    Parameters

    • options: object

      Additional options which modify the deletion request

    • userId: string

      The id of the User requesting the document update

    Returns void

Protected_preDelete

  • _preDelete(options: object, user: BaseUser): Promise<boolean | void>
    Protected

    Called by ClientDocumentMixin#_preDelete.

    Parameters

    • options: object

      Additional options which modify the deletion request

    • user: BaseUser

      The User requesting the document deletion

    Returns Promise<boolean | void>

    A return value of false indicates the deletion operation should be cancelled.

Protected_preUpdate

  • _preUpdate(
        changes: object,
        options: object,
        user: BaseUser,
    ): Promise<boolean | void>
    Protected

    Called by ClientDocumentMixin#_preUpdate.

    Parameters

    • changes: object

      The candidate changes to the Document

    • options: object

      Additional options which modify the update request

    • user: BaseUser

      The User requesting the document update

    Returns Promise<boolean | void>

    A return value of false indicates the update operation should be cancelled.

StaticcleanData

  • cleanData(source?: object, options?: object): object

    Clean a data source object to conform to a specific provided schema.

    Parameters

    • Optionalsource: object = {}

      The source data object

    • Optionaloptions: object = {}

      Additional options which are passed to field cleaning methods

    Returns object

    The cleaned source data, which is the same object as the source argument

StaticdefineSchema

StaticfromJSON

StaticfromSource

StaticmigrateData

  • migrateData(source: object): object

    Migrate candidate source data for this DataModel which may require initial cleaning or transformations.

    Parameters

    • source: object

      The candidate source data from which the model will be constructed

    Returns object

    Migrated source data, which is the same object as the source argument

StaticmigrateDataSafe

  • migrateDataSafe(source: object): object

    Wrap data migration in a try/catch which attempts it safely

    Parameters

    • source: object

      The candidate source data from which the model will be constructed

    Returns object

    Migrated source data, which is the same object as the source argument

StaticshimData

  • shimData(data: object, options?: { embedded?: boolean }): object

    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.

    Parameters

    • data: object

      Data which matches the current schema

    • Optionaloptions: { embedded?: boolean } = {}

      Additional shimming options

      • Optionalembedded?: boolean

        Apply shims to embedded models?

    Returns object

    Data with added backwards-compatible properties, which is the same object as the data argument

StaticvalidateJoint

  • validateJoint(data: object): void

    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.

    Parameters

    • data: object

      Candidate data for the model

    Returns void

    Throws

    An error if a validation failure is detected

Protected Static_createEventsField

  • _createEventsField(
        options?: { events?: string[]; initial?: string[] },
    ): SetField
    Protected

    Create the events field.

    Parameters

    • options: { events?: string[]; initial?: string[] } = {}

      Options which configure how the events field is declared

      • Optionalevents?: string[]

        The event names to restrict to.

      • Optionalinitial?: string[]

        The initial set of events that should be default for the field

    Returns SetField

Protected Static_initializationOrder

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods