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

    Class ContextNote

    Hierarchy

    • DataModel
      • ContextNote
    Index

    Constructors

    Properties

    Methods

    Constructors

    • Parameters

      • ...args: ConstructorArgs<any, null, any>

      Returns ContextNote

    Properties

    target: string
    text: string

    Methods

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

      Returns {
          target: StringField<
              { blank: true; initial: ""; nullable: false },
              AssignmentType<{ blank: true; initial: ""; nullable: false }>,
              InitializedType<{ blank: true; initial: ""; nullable: false }>,
              InitializedType<{ blank: true; initial: ""; nullable: false }>,
          >;
          text: StringField<
              { blank: true; initial: ""; nullable: false },
              AssignmentType<{ blank: true; initial: ""; nullable: false }>,
              InitializedType<{ blank: true; initial: ""; nullable: false }>,
              InitializedType<{ blank: true; initial: ""; nullable: false }>,
          >;
      }

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

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

      Parameters

      • source: any

        The candidate source data from which the model will be constructed

      Returns AnyMutableObject

      Migrated source data, if necessary