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

    Class ItemMessageModel

    Data Model for item cards.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    actor combat? config? item reference? subject? template

    Methods

    defineSchema migrateData pruneData

    Constructors

    Properties

    actor: string

    Actor UUID

    BUG?: Is this ever different from speaker?

    combat?: string

    Combat ID if this is message relates to any specific combat encounter.

    config?: object

    Arbitrary config object

    item: ItemMessageData

    Item Data

    reference?: string

    Reference to what triggered this message if anything.

    subject?: object

    Subject info object

    template: string

    Template UUID

    Methods

    • Returns {
          actor: StringField<
              DefaultOptions,
              AssignmentType<DefaultOptions>,
              InitializedType<DefaultOptions>,
              InitializedType<DefaultOptions>,
          >;
          combat: StringField<
              DefaultOptions,
              AssignmentType<DefaultOptions>,
              InitializedType<DefaultOptions>,
              InitializedType<DefaultOptions>,
          >;
          config: ObjectField<
              DefaultOptions,
              AssignmentType<DefaultOptions>,
              AnyObject,
              AnyObject,
          >;
          item: SchemaField<
              {
                  description: HTMLField<
                      DefaultOptions,
                      AssignmentType<DefaultOptions>,
                      string,
                      string,
                  >;
                  id: StringField<
                      DefaultOptions,
                      AssignmentType<DefaultOptions>,
                      InitializedType<DefaultOptions>,
                      InitializedType<DefaultOptions>,
                  >;
                  identified: BooleanField<
                      { initial: true },
                      AssignmentType<SimpleMerge<{ initial: true }, DefaultOptions>>,
                      InitializedType<SimpleMerge<{ initial: true }, DefaultOptions>>,
                      InitializedType<SimpleMerge<{ initial: true }, DefaultOptions>>,
                  >;
                  name: StringField<
                      DefaultOptions,
                      AssignmentType<DefaultOptions>,
                      InitializedType<DefaultOptions>,
                      InitializedType<DefaultOptions>,
                  >;
              },
              DefaultOptions,
              AssignmentType<
                  {
                      description: HTMLField<
                          DefaultOptions,
                          AssignmentType<DefaultOptions>,
                          string,
                          string,
                      >;
                      id: StringField<
                          DefaultOptions,
                          AssignmentType<DefaultOptions>,
                          InitializedType<DefaultOptions>,
                          InitializedType<DefaultOptions>,
                      >;
                      identified: BooleanField<
                          { initial: true },
                          AssignmentType<SimpleMerge<{ initial: true }, DefaultOptions>>,
                          InitializedType<SimpleMerge<{ initial: true }, DefaultOptions>>,
                          InitializedType<SimpleMerge<{ initial: true }, DefaultOptions>>,
                      >;
                      name: StringField<
                          DefaultOptions,
                          AssignmentType<DefaultOptions>,
                          InitializedType<DefaultOptions>,
                          InitializedType<DefaultOptions>,
                      >;
                  },
                  SimpleMerge<DefaultOptions, DefaultOptions>,
              >,
              {
                  description: string;
                  id: InitializedType<DefaultOptions>;
                  identified: InitializedType<
                      SimpleMerge<{ initial: true }, DefaultOptions>,
                  >;
                  name: InitializedType<DefaultOptions>;
              },
              {
                  description: string;
                  id: InitializedType<DefaultOptions>;
                  identified: InitializedType<
                      SimpleMerge<{ initial: true }, DefaultOptions>,
                  >;
                  name: InitializedType<DefaultOptions>;
              },
          >;
          notes: TypedObjectField<
              ArrayField<
                  SchemaField<
                      {
                          source: StringField<
                              { blank: false; required: false },
                              AssignmentType<{ blank: false; required: false }>,
                              InitializedType<{ blank: false; required: false }>,
                              InitializedType<{ blank: false; required: false }>,
                          >;
                          text: StringField<
                              { blank: false; required: false },
                              AssignmentType<{ blank: false; required: false }>,
                              InitializedType<{ blank: false; required: false }>,
                              InitializedType<{ blank: false; required: false }>,
                          >;
                      },
                      DefaultOptions,
                      AssignmentType<
                          {
                              source: StringField<
                                  { blank: false; required: false },
                                  AssignmentType<{ blank: false; required: false }>,
                                  InitializedType<{ blank: false; required: false }>,
                                  InitializedType<{ blank: false; required: false }>,
                              >;
                              text: StringField<
                                  { blank: false; required: false },
                                  AssignmentType<{ blank: false; required: false }>,
                                  InitializedType<{ blank: false; required: false }>,
                                  InitializedType<{ blank: false; required: false }>,
                              >;
                          },
                          SimpleMerge<DefaultOptions, DefaultOptions>,
                      >,
                      {
                          source: InitializedType<{ blank: false; required: false }>;
                          text: InitializedType<{ blank: false; required: false }>;
                      },
                      {
                          source: InitializedType<{ blank: false; required: false }>;
                          text: InitializedType<{ blank: false; required: false }>;
                      },
                  >,
                  DefaultOptions,
                  AssignmentType<
                      {
                          source: StringField<
                              { blank: false; required: false },
                              AssignmentType<{ blank: false; required: false }>,
                              InitializedType<{ blank: false; required: false }>,
                              InitializedType<{ blank: false; required: false }>,
                          >;
                          text: StringField<
                              { blank: false; required: false },
                              AssignmentType<{ blank: false; required: false }>,
                              InitializedType<{ blank: false; required: false }>,
                              InitializedType<{ blank: false; required: false }>,
                          >;
                      },
                      SimpleMerge<DefaultOptions, DefaultOptions>,
                  >,
                  {
                      source: InitializedType<{ blank: false; required: false }>;
                      text: InitializedType<{ blank: false; required: false }>;
                  },
                  AssignmentType<
                      AssignmentType<
                          {
                              source: StringField<
                                  { blank: false; required: false },
                                  AssignmentType<{ blank: false; required: false }>,
                                  InitializedType<{ blank: false; required: false }>,
                                  InitializedType<{ blank: false; required: false }>,
                              >;
                              text: StringField<
                                  { blank: false; required: false },
                                  AssignmentType<{ blank: false; required: false }>,
                                  InitializedType<{ blank: false; required: false }>,
                                  InitializedType<{ blank: false; required: false }>,
                              >;
                          },
                          SimpleMerge<DefaultOptions, DefaultOptions>,
                      >,
                      DefaultOptions,
                  >,
                  {
                      source: InitializedType<{ blank: false; required: false }>;
                      text: InitializedType<{ blank: false; required: false }>;
                  }[],
                  {
                      source: InitializedType<{ blank: false; required: false }>;
                      text: InitializedType<{ blank: false; required: false }>;
                  },
                  {
                      source: InitializedType<{ blank: false; required: false }>;
                      text: InitializedType<{ blank: false; required: false }>;
                  }[],
              >,
              DefaultOptions,
              AssignmentType<
                  ArrayField<
                      SchemaField<
                          {
                              source: StringField<
                                  { blank: false; required: false },
                                  AssignmentType<{ blank: false; required: false }>,
                                  InitializedType<{ blank: false; required: false }>,
                                  InitializedType<{ blank: false; required: false }>,
                              >;
                              text: StringField<
                                  { blank: false; required: false },
                                  AssignmentType<{ blank: false; required: false }>,
                                  InitializedType<{ blank: false; required: false }>,
                                  InitializedType<{ blank: false; required: false }>,
                              >;
                          },
                          DefaultOptions,
                          AssignmentType<
                              {
                                  source: StringField<
                                      { blank: false; required: false },
                                      AssignmentType<{ blank: false; required: false }>,
                                      InitializedType<{ blank: false; required: false }>,
                                      InitializedType<{ blank: false; required: false }>,
                                  >;
                                  text: StringField<
                                      { blank: false; required: false },
                                      AssignmentType<{ blank: false; required: false }>,
                                      InitializedType<{ blank: false; required: false }>,
                                      InitializedType<{ blank: false; required: false }>,
                                  >;
                              },
                              SimpleMerge<DefaultOptions, DefaultOptions>,
                          >,
                          {
                              source: InitializedType<{ blank: false; required: false }>;
                              text: InitializedType<{ blank: false; required: false }>;
                          },
                          {
                              source: InitializedType<{ blank: false; required: false }>;
                              text: InitializedType<{ blank: false; required: false }>;
                          },
                      >,
                      DefaultOptions,
                      AssignmentType<
                          {
                              source: StringField<
                                  { blank: false; required: false },
                                  AssignmentType<{ blank: false; required: false }>,
                                  InitializedType<{ blank: false; required: false }>,
                                  InitializedType<{ blank: false; required: false }>,
                              >;
                              text: StringField<
                                  { blank: false; required: false },
                                  AssignmentType<{ blank: false; required: false }>,
                                  InitializedType<{ blank: false; required: false }>,
                                  InitializedType<{ blank: false; required: false }>,
                              >;
                          },
                          SimpleMerge<DefaultOptions, DefaultOptions>,
                      >,
                      {
                          source: InitializedType<{ blank: false; required: false }>;
                          text: InitializedType<{ blank: false; required: false }>;
                      },
                      AssignmentType<
                          AssignmentType<
                              {
                                  source: StringField<
                                      { blank: false; required: false },
                                      AssignmentType<{ blank: false; required: false }>,
                                      InitializedType<{ blank: false; required: false }>,
                                      InitializedType<{ blank: false; required: false }>,
                                  >;
                                  text: StringField<
                                      { blank: false; required: false },
                                      AssignmentType<{ blank: false; required: false }>,
                                      InitializedType<{ blank: false; required: false }>,
                                      InitializedType<{ blank: false; required: false }>,
                                  >;
                              },
                              SimpleMerge<DefaultOptions, DefaultOptions>,
                          >,
                          DefaultOptions,
                      >,
                      {
                          source: InitializedType<{ blank: false; required: false }>;
                          text: InitializedType<{ blank: false; required: false }>;
                      }[],
                      {
                          source: InitializedType<{ blank: false; required: false }>;
                          text: InitializedType<{ blank: false; required: false }>;
                      },
                      {
                          source: InitializedType<{ blank: false; required: false }>;
                          text: InitializedType<{ blank: false; required: false }>;
                      }[],
                  >,
                  DefaultOptions,
              >,
              {
                  [key: string]: {
                      source: InitializedType<{ blank: false; required: false }>;
                      text: InitializedType<{ blank: false; required: false }>;
                  }[];
              },
              {
                  [key: string]: {
                      source: InitializedType<{ blank: false; required: false }>;
                      text: InitializedType<{ blank: false; required: false }>;
                  }[];
              },
          >;
          reference: StringField<
              { blank: boolean; initial: undefined; nullable: boolean },
              AssignmentType<{ blank: boolean; initial: undefined; nullable: boolean }>,
              InitializedType<{ blank: boolean; initial: undefined; nullable: boolean }>,
              InitializedType<{ blank: boolean; initial: undefined; nullable: boolean }>,
          >;
          subject: ObjectField<
              DefaultOptions,
              AssignmentType<DefaultOptions>,
              AnyObject,
              AnyObject,
          >;
          templates: SetField<
              StringField<
                  DefaultOptions,
                  AssignmentType<DefaultOptions>,
                  InitializedType<DefaultOptions>,
                  InitializedType<DefaultOptions>,
              >,
              DefaultOptions,
              AssignmentType<DefaultOptions>,
              InitializedType<DefaultOptions>,
              AssignmentType<AssignmentType<DefaultOptions>, DefaultOptions>,
              Set<InitializedType<DefaultOptions>>,
              InitializedType<DefaultOptions>,
              InitializedType<DefaultOptions>[],
          >;
      }

    • Parameters

      • source: any

      Returns any

    • Parameters

      • data: any

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods