Class BaseMessageModel

Hierarchy (View Summary)

any
- BaseMessageModel
  - ItemMessageModel
  - CheckMessageModel

Index

Constructors

constructor

new BaseMessageModel(): BaseMessageModel
Returns BaseMessageModel
Inherited from CompactingMixin(foundry.abstract.TypeDataModel).constructor

Properties

`Optional`combat

combat?: string

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

`Optional`config

config?: object

Arbitrary config object

`Optional`reference

reference?: string

Reference to what triggered this message if anything.

`Optional`subject

subject?: object

Subject info object

Methods

`Static`defineSchema

defineSchema(): {
    combat: StringField<
        DefaultOptions,
        AssignmentType<DefaultOptions>,
        InitializedType<DefaultOptions>,
        InitializedType<DefaultOptions>,
    >;
    config: ObjectField<
        DefaultOptions,
        AssignmentType<DefaultOptions>,
        AnyObject,
        AnyObject,
    >;
    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,
    >;
}
Returns {
    combat: StringField<
        DefaultOptions,
        AssignmentType<DefaultOptions>,
        InitializedType<DefaultOptions>,
        InitializedType<DefaultOptions>,
    >;
    config: ObjectField<
        DefaultOptions,
        AssignmentType<DefaultOptions>,
        AnyObject,
        AnyObject,
    >;
    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,
    >;
}
- Defined in module/models/chat/base-message.mjs:4

`Static`pruneData

pruneData(source: any): void
Parameters
- source: any
Returns void
- Defined in module/models/chat/base-message.mjs:23

Class BaseMessageModel

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns BaseMessageModel

Properties

`Optional`combat

`Optional`config

`Optional`reference

`Optional`subject

Methods

`Static`defineSchema

`Static`pruneData

Parameters

Returns void

Settings

On This Page

Class BaseMessageModel

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns BaseMessageModel

Properties

Optionalcombat

Optionalconfig

Optionalreference

Optionalsubject

Methods

StaticdefineSchema

StaticpruneData

Parameters

Returns void

Settings

On This Page

`Optional`combat

`Optional`config

`Optional`reference

`Optional`subject

`Static`defineSchema

`Static`pruneData