Pathfinder 1e for Foundry VTT
    Preparing search index...

    Class DocumentLikeModel

    DataModel to mimic basic document-like behaviour.

    Calls () on initialization and on reset()

    Also handles _id nicely.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    _id name?

    Accessors

    id

    Methods

    _initialize _safePrepareData prepareData defineSchema

    Constructors

    Properties

    _id

    _id: string

    Pseudo-document ID

    Only used for data storage.

    name?: string

    Name

    Accessors

    • get id(): string

      Internal ID

      Returns string

    Methods

    Protected_initialize

    • _initialize(options?: object): void
      Protected

      Parameters

      • options: object = {}

        Constructor options

      Returns void

    _safePrepareData

    • _safePrepareData(): void
      Internal

      Safely prepare data

      Returns void

    • Protected

      Prepare data after initialization or reset.

      Returns void

    • Define the data schema for documents of this type. The schema is populated the first time it is accessed and cached for future reuse.

      Parameters

      • options: any

      Returns {
          _id: IDField;
          name: StringField<
              { blank: false; initial: any; nullable: false; required: true },
              string,
              string,
              string,
          >;
      }

      The returned value MUST be kept up to sync with the Schema type parameter.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods