Class ClientIssues

A class responsible for tracking issues in the current world.

Index

Accessors

packageCompatibilityIssues usabilityIssues validationFailures

Methods

_countDocumentSubType _detectDocumentIssues _detectUsabilityIssues _detectWebGLIssues _onDeleteInvalid getAllSubTypeCounts getSubTypeCountsFor

Accessors

packageCompatibilityIssues

get packageCompatibilityIssues(): Record<string, PackageCompatibilityIssue>
Retrieve package compatibility issues.

Returns Record<string, PackageCompatibilityIssue>

usabilityIssues

get usabilityIssues(): Record<string, UsabilityIssue>
Retrieve the tracked usability issues.

Returns Record<string, UsabilityIssue>

validationFailures

get validationFailures(): {
    [documentName: string]: {
        [uuid: string]: { error: Error; name?: string };
    };
}
Retrieve the tracked validation failures.

Returns { [documentName: string]: { [uuid: string]: { error: Error; name?: string } } }

Methods

_countDocumentSubType

_countDocumentSubType(
    cls: typeof Document,
    source: object,
    options?: { decrement?: boolean },
): void
Internal
Add an invalid Document to the module-provided sub-type counts.
Parameters
- cls: typeof Document
  The Document class.
- source: object
  The Document's source data.
- Optionaloptions: { decrement?: boolean } = {}
  - Optionaldecrement?: boolean
    Decrement the counter rather than incrementing it.
Returns void

_detectDocumentIssues

_detectDocumentIssues(): void
Internal
Track all world document validation failures and failures of their embedded documents.

Returns void

_detectUsabilityIssues

_detectUsabilityIssues(): void
Internal
Detect and record certain usability error messages which are likely to result in the user having a bad experience.

Returns void

_detectWebGLIssues

_detectWebGLIssues(): void
Internal
Detect and display warnings for known performance issues which may occur due to the user's hardware or browser configuration.

Returns void

_onDeleteInvalid

_onDeleteInvalid(
    documentName: string,
    invalidIds: string[],
    context?: {
        pack?: string | null;
        parent?: Document<object, DocumentConstructionContext> | null;
    },
): void
Internal
Handle deletion of invalid documents.
Parameters
- documentName: string
  The Document name
- invalidIds: string[]
  The array of invalid IDs
- context: {
  pack?: string | null;
  parent?: Document<object, DocumentConstructionContext> | null;
  } = {}
  The context
  - Optionalpack?: string | null
    The Documents' compendium pack, if applicable
  - Optionalparent?: Document<object, DocumentConstructionContext> | null
    The Documents' parent, if any
Returns void

getAllSubTypeCounts

getAllSubTypeCounts(): Iterator<string, ModuleSubTypeCounts, any>
Retrieve all sub-type counts in the world.

Returns Iterator<string, ModuleSubTypeCounts, any>

getSubTypeCountsFor

getSubTypeCountsFor(module: any): ModuleSubTypeCounts
Get the Document sub-type counts for a given module.
Parameters
- module: any
  The module or its ID.
Returns ModuleSubTypeCounts