Foundry Virtual Tabletop

https://foundryvtt.com/api/v14
Admin
Foundry Virtual Tabletop is a web-based platform for online tabletop gaming that provides a complete...
Tokens:1,873,347
Snippets:17,846
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Dialog Example

Source: https://foundryvtt.com/api/v14/classes/foundry.appv1.api.Dialog.html

Example of how to construct and render a custom dialog instance with multiple button options.

```javascript
let d = new Dialog({
  title: "Test Dialog",
  content: "<p>You must choose either Option 1, or Option 2</p>",
  buttons: {
    one: {
      icon: '<i class="fa-solid fa-check"></i>',
      label: "Option One",
      callback: () => console.log("Chose One")
    },
    two: {
      icon: '<i class="fa-solid fa-xmark"></i>',
      label: "Option Two",
      callback: () => console.log("Chose Two")
    }
  },
  default: "two",
  render: html => console.log("Register interactivity in the rendered dialog"),
  close: html => console.log("This always is logged no matter which option is chosen")
});
d.render(true);
```

--------------------------------

### Starting and Stopping Particle Effects

Source: https://foundryvtt.com/api/v14/classes/foundry.canvas.animation.ParticleGenerator.html

Demonstrates how to start and stop a particle generator after it has been configured.

```APIDOC
## ParticleGenerator Methods

### start()

#### Description
Starts the particle generator, beginning the emission of particles according to its configuration.

### stop()

#### Description
Stops the particle generator, ceasing the emission of new particles. Existing particles will continue their animation until they expire or are otherwise removed.
```

--------------------------------

### setupGame

Source: https://foundryvtt.com/api/v14/classes/foundry.Game.html

Fully sets up the game state, including documents, UI, and canvas, and triggers setup and ready hooks.

```APIDOC
## setupGame

### Description
Fully set up the game state, initializing Documents, UI applications, and the Canvas. Triggers the hookEvents.setup and hookEvents.ready events.

### Method
setupGame(): Promise<void>

### Returns
Promise<void>
```

--------------------------------

### Filter Journal Entries

Source: https://foundryvtt.com/api/v14/classes/foundry.documents.collections.Journal.html

Filter the Collection to return an Array of entries that match a functional condition. This example filters for entries starting with 'A'.

```javascript
let c = new Collection([["a", "AA"], ["b", "AB"], ["c", "CC"]]); 
let hasA = c.filters(entry => entry.slice(0) === "A");
```

--------------------------------

### ready()

Source: https://foundryvtt.com/api/v14/functions/hookEvents.ready.html

Fires once when the game is fully ready. This hook runs after the 'setup' hook.

```APIDOC
## ready()

### Description
A hook event that fires once when the game is fully ready. Runs after `setup`.

### Method
`ready()`

### Returns
void
```

--------------------------------

### Retrieve an existing Actor by its id

Source: https://foundryvtt.com/api/v14/classes/foundry.documents.collections.Actors.html

This example demonstrates how to get a specific Actor document from the game.actors collection using its unique ID.

```APIDOC
## Retrieve an existing Actor by its id

### Description
This example demonstrates how to get a specific Actor document from the game.actors collection using its unique ID.

### Method
GET

### Endpoint
`game.actors.get(actorId)`

### Parameters
#### Path Parameters
- **actorId** (string) - Required - The unique identifier of the Actor to retrieve.

### Response
#### Success Response (200)
- **Actor** (foundry.documents.Actor) - The retrieved Actor document.

#### Response Example
```json
{
  "example": "actorDocument"
}
```
```

--------------------------------

### SetupTour Methods

Source: https://foundryvtt.com/api/v14/classes/foundry.nue.tours.SetupTour.html

Provides methods for controlling and interacting with the SetupTour.

```APIDOC
## Methods
### complete
  * complete(): Promise<any>

Advance the tour to a completed state.

### Returns
Promise<any>

### exit
  * exit(): void

Exit the tour at the current step.

### Returns
void

### next
  * next(): Promise<any>

Progress the Tour to the next step.

### Returns
Promise<any>

### previous
  * previous(): Promise<any>

Rewind the Tour to the previous step.

### Returns
Promise<any>

### progress
  * progress(stepIndex: number): Promise<any>

Progresses to a given Step

### Parameters
    * stepIndex: number
      The step to progress to

### Returns
Promise<any>

### reset
  * reset(): Promise<any>

Reset the Tour to an un-started state.

### Returns
Promise<any>

### start
  * start(): Promise<any>

Start the Tour at its current step, or at the beginning if the tour has not yet been started.

### Returns
Promise<any>
```

--------------------------------

### Create and Evaluate a PoolTerm

Source: https://foundryvtt.com/api/v14/classes/foundry.dice.terms.PoolTerm.html

Instantiate a PoolTerm with multiple dice expressions and modifiers, then evaluate it to get the results. This example demonstrates keeping the highest die from each of the three specified rolls.

```javascript
let pool = new PoolTerm({
  terms: ["4d6", "3d8 - 1", "2d10 + 3"],
  modifiers: ["kh"]
});
pool.evaluate();
```

--------------------------------

### SetupTour Constructor

Source: https://foundryvtt.com/api/v14/classes/foundry.nue.tours.SetupTour.html

Constructs a new SetupTour instance. It requires a TourConfig object and accepts optional configuration options.

```APIDOC
## constructor
  * new SetupTour(
config: TourConfig,
options?: { id?: string; namespace?: string },
): SetupTour

Construct a Tour by providing a configuration.

### Parameters
    * config: TourConfig
      The configuration of the Tour
    * `Optional`options: { id?: string; namespace?: string } = {}
      Additional options for configuring the tour
      * ##### `Optional`id?: string
        A tour ID that supercedes TourConfig#id
      * ##### `Optional`namespace?: string
        A tour namespace that supercedes TourConfig#namespace

### Returns
SetupTour
```

--------------------------------

### Define Schema and Localization Prefixes for DataModel

Source: https://foundryvtt.com/api/v14/classes/foundry.abstract.TypeDataModel.html

Example of defining a schema for a custom DataModel and setting localization prefixes. This setup allows Foundry to automatically localize field labels and hints based on a provided JSON structure.

```javascript
class MyDataModel extends foundry.abstract.DataModel {
  static defineSchema() {
    return {
      foo: new foundry.data.fields.StringField(),
      bar: new foundry.data.fields.NumberField()
    };
  }
  static LOCALIZATION_PREFIXES = ["MYMODULE.MYDATAMODEL"];
}

Hooks.on("i18nInit", () => {
  // Foundry will attempt to automatically localize models registered for a document subtype, so this step is only
  // needed for other data model usage, e.g. for a Setting.
  Localization.localizeDataModel(MyDataModel);
});
```

--------------------------------

### get

Source: https://foundryvtt.com/api/v14/classes/foundry.abstract.SingletonEmbeddedCollection.html

Get a document from the EmbeddedCollection by its ID.

```APIDOC
## get

### Description
Get a document from the EmbeddedCollection by its ID.

### Parameters
#### id
- string - The ID of the Embedded Document to retrieve.
#### options
- { invalid?: boolean; strict?: boolean } - Optional. Additional options to configure retrieval.
  - invalid?: boolean - Allow retrieving an invalid Embedded Document.
  - strict?: boolean - Throw an Error if the requested Embedded Document does not exist.

### Returns
any - The retrieved document instance, or undefined

### Throws
If strict is true and the Embedded Document cannot be found.
```

--------------------------------

### initialize

Source: https://foundryvtt.com/api/v14/classes/foundry.canvas.sources.BaseLightSource.html

Initialize the light source with data.

```APIDOC
## initialize

### Description
Initialize the light source with data.

### Method
`_initialize(data: any): void`

### Parameters
#### Path Parameters
- **data** (any) - Description not available
```

--------------------------------

### initialize

Source: https://foundryvtt.com/api/v14/classes/foundry.documents.collections.Playlists.html

Perform one-time initialization to begin playback of audio.

```APIDOC
## initialize

### Description
Perform one-time initialization to begin playback of audio.

### Method
`initialize(): Promise<void>`

### Returns
- **Promise<void>**
```

--------------------------------

### get

Source: https://foundryvtt.com/api/v14/classes/foundry.abstract.EmbeddedCollection.html

Get a document from the EmbeddedCollection by its ID.

```APIDOC
## get

### Description
Get a document from the EmbeddedCollection by its ID.

### Method
get

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the Embedded Document to retrieve.
#### Query Parameters
- **options** (object) - Optional - Additional options to configure retrieval.
  - **invalid** (boolean) - Optional - Allow retrieving an invalid Embedded Document.
  - **strict** (boolean) - Optional - Throw an Error if the requested Embedded Document does not exist.

### Returns
TDocument - The retrieved document instance, or undefined

### Throws
If strict is true and the Embedded Document cannot be found.
```

--------------------------------

### _onConfigure

Source: https://foundryvtt.com/api/v14/classes/foundry.applications.apps.av.CameraViews.html

Handles spawning the AV configuration dialog.

```APIDOC
## _onConfigure

### Description
Handle spawning the AV configuration dialog.

### Method
Internal

### Signature
_onConfigure(event: PointerEvent, target: HTMLElement): Promise<AVConfig>

### Parameters
#### Path Parameters
- **event** (PointerEvent) - The triggering event.
- **target** (HTMLElement) - The action target.

### Returns
Promise<AVConfig>
```

--------------------------------

### get

Source: https://foundryvtt.com/api/v14/classes/foundry.documents.collections.Playlists.html

Get a Playlist document from the collection by its ID.

```APIDOC
## get

### Description
Get a Playlist document from the collection by its ID.

### Method
get

### Parameters
#### Path Parameters
* id (string) - Required - The ID of the Document to retrieve.
* options (object) - Optional - Additional options to configure retrieval.
  * invalid (boolean) - Optional - Allow retrieving an invalid Document.
  * strict (boolean) - Optional - Throw an Error if the requested Document does not exist.

### Returns
documents.Playlist

### Throws
If strict is true and the Document cannot be found.
```

--------------------------------

### initialize

Source: https://foundryvtt.com/api/v14/classes/foundry.nue.NewUserExperienceManager.html

Initializes the new user experience, generating introductory chat messages for new worlds.

```APIDOC
## initialize

### Description
Initialize the new user experience. Currently, this generates some chat messages with hints for getting started if we detect this is a new world.

### Method
initialize(): void

### Parameters
#### Path Parameters
* None

#### Query Parameters
* None

#### Request Body
* None

### Returns
* **void**
```

--------------------------------

### get

Source: https://foundryvtt.com/api/v14/classes/foundry.documents.Combatant.html

Retrieves a World-level Combatant Document by its ID. Supports optional database get operations.

```APIDOC
## Static get

### Description
Get a World-level Document of this type by its id.

### Method
`Static` get

### Parameters
* **documentId** (string) - Required - The Document ID
* **operation** (DatabaseGetOperation) - Optional - Parameters of the get operation

### Returns
Document<object, DocumentConstructionContext> | null - The retrieved Document, or null
```

--------------------------------

### initialize

Source: https://foundryvtt.com/api/v14/classes/foundry.canvas.sources.GlobalLightSource.html

Initializes and configures the light source with provided data and optional settings. This method sets up the source for use in the scene.

```APIDOC
## initialize

### Description
Initialize and configure the source using provided data.

### Method
`initialize(data?: any, options?: { reset?: boolean }): GlobalLightSource`

### Parameters
#### Path Parameters
* **data** (any) - Optional - Provided data for configuration
* **options** (object) - Optional - Additional options which modify source initialization
  * **reset** (boolean) - Optional - Should source data be reset to default values before applying changes?

### Returns GlobalLightSource
```

--------------------------------

### initialize

Source: https://foundryvtt.com/api/v14/classes/foundry.av.clients.SimplePeerAVClient.html

Initializes the SimplePeerAVClient.

```APIDOC
## initialize
* initialize(): Promise<void>
#### Returns Promise<void>
```

--------------------------------

### get

Source: https://foundryvtt.com/api/v14/classes/foundry.documents.BaseActor.html

Retrieves a World-level Document of this type by its ID. Allows for optional database get operations.

```APIDOC
## get

### Description
Get a World-level Document of this type by its id.

### Method
Static

### Signature
`get(documentId: string, operation?: DatabaseGetOperation): Document<object, DocumentConstructionContext> | null`

### Parameters
#### Path Parameters
- **documentId** (string) - Required - The Document ID
- **operation** (DatabaseGetOperation) - Optional - Parameters of the get operation

### Returns
- **Document<object, DocumentConstructionContext> | null** - The retrieved Document, or null
```

--------------------------------

### get

Source: https://foundryvtt.com/api/v14/classes/foundry.documents.BaseActorDelta.html

Retrieves a World-level Document of this type by its ID. Supports optional database get operations.

```APIDOC
## Static get

### Description
Get a World-level Document of this type by its id.

### Method
`Static` get

### Parameters
#### Path Parameters
* **documentId** (string) - Required - The Document ID
* **operation** (DatabaseGetOperation) - Optional - Parameters of the get operation

### Returns
Document<object, DocumentConstructionContext> | null - The retrieved Document, or null
```

--------------------------------

### setup()

Source: https://foundryvtt.com/api/v14/functions/hookEvents.setup.html

A hook event that fires once when Foundry has finished initializing but before the game state has been set up. Fires after all Documents are initialized, including Settings (you cannot read settings prior to this hook), but before the UI applications or Canvas have been initialized. Runs after `i18nInit` but before `ready`.

```APIDOC
## setup()

### Description
A hook event that fires once when Foundry has finished initializing but before the game state has been set up. Fires after all Documents are initialized, including Settings (you cannot read settings prior to this hook), but before the UI applications or Canvas have been initialized. Runs after `i18nInit` but before `ready`.

### Returns
void
```

--------------------------------

### initialize

Source: https://foundryvtt.com/api/v14/classes/foundry.canvas.containers.DoorMesh.html

Configures and initializes the DoorMesh, optionally updating it after construction.

```APIDOC
## initialize

### Description
Configure and initialize the DoorMesh. This is called automatically upon construction, but may be called manually later to update the DoorMesh.

### Method
`initialize(animation: DoorAnimationConfiguration): void`

### Parameters
* **animation** (DoorAnimationConfiguration) - The animation configuration for the door.

### Returns
void
```

--------------------------------

### Die Class Example

Source: https://foundryvtt.com/api/v14/classes/foundry.dice.terms.Die.html

Example of how to create and evaluate a Die instance to roll four six-sided dice.

```APIDOC
## Example Usage

### Description
Roll four six-sided dice.

### Code
```javascript
let die = new Die({faces: 6, number: 4}).evaluate();
```
```

--------------------------------

### initialize

Source: https://foundryvtt.com/api/v14/classes/foundry.canvas.sources.RenderedEffectSource.html

Initializes and configures the source using provided data and options. Returns the initialized source.

```APIDOC
## initialize

### Description
Initialize and configure the source using provided data.

### Method
Public

### Parameters
#### Path Parameters
- **data** (Partial<TSourceData>) - Optional. Provided data for configuration.
- **options** (object) - Optional. Additional options which modify source initialization.
  - **reset** (boolean) - Optional. Should source data be reset to default values before applying changes?

### Returns
- RenderedEffectSource<TSourceData, TSourceShape> - The initialized source
```

--------------------------------

### QuickstartManifestData Interface

Source: https://foundryvtt.com/api/v14/interfaces/foundry.packages.types.QuickstartManifestData.html

This interface defines the structure for quickstart manifest data, including adventures to import and optional world configuration.

```APIDOC
## Interface QuickstartManifestData

### Description
An interface for configuring quickstart package imports, specifying which adventures to import and optional world settings.

### Properties

*   **adventures** (Record<string, QuickstartAdventureData>) - Required - A mapping of system IDs to an adventure to import for that system.
*   **postImport** (boolean) - Optional - Whether the adventure(s) requires post-import operations. Non-GMs will be blocked from joining the World while post-import operations are still pending.
*   **world** (object) - Optional - Configuration for the auto-created world.
    *   **background** (string) - Optional - The world's background image for the join page. If omitted, the first adventure's image is used.
    *   **cover** (string) - Optional - The cover image for the world on the setup page. If omitted, the first adventure's image is used.
    *   **description** (string) - Optional - The world's description. If omitted, the first adventure's description is used.
```

--------------------------------

### get

Source: https://foundryvtt.com/api/v14/classes/foundry.documents.BaseDrawing.html

Retrieves a World-level Document of this type by its ID. It can optionally accept database get operation parameters. Returns null if the document is not found.

```APIDOC
## Static get

### Description
Get a World-level Document of this type by its id.

### Method
`Static`get

### Parameters
* `documentId`: string - The Document ID
* `operation`: DatabaseGetOperation = {} - Parameters of the get operation

### Returns
Document<object, DocumentConstructionContext> | null
The retrieved Document, or null
```

--------------------------------

### JSON Localization File Example

Source: https://foundryvtt.com/api/v14/classes/foundry.config.ReleaseData.html

An example of a JSON localization file structure that corresponds to the 'MyDataModel' class, defining labels and hints for its fields.

```json
{
  "MYMODULE": {
    "MYDATAMODEL": {
      "FIELDS" :
        {
          "foo": {
            "label": "Foo",
            "hint": "Instructions for foo"
          },
          "bar": {
            "label": "Bar",
            "hint": "Instructions for bar"
          }
        }
    }
  }
}
```

--------------------------------

### initialize

Source: https://foundryvtt.com/api/v14/classes/foundry.helpers.interaction.ClientKeybindings.html

Initializes the keybinding values for all registered actions.

```APIDOC
## initialize

### Description
Initializes the keybinding values for all registered actions.

### Method
initialize(): void

### Returns void
```

--------------------------------

### _canDragLeftStart

Source: https://foundryvtt.com/api/v14/classes/foundry.canvas.layers.PlaceablesLayer.html

Determines if a drag operation starting from the left mouse button can begin on this layer. This is typically used to check for valid starting conditions for dragging placeable objects.

```APIDOC
## _canDragLeftStart

### Description
Determines if a left-click drag operation can begin.

### Method
(user: any, event: any)

### Parameters
#### Path Parameters
* **user**: any
* **event**: any

### Returns
boolean
```

--------------------------------

### Reference Descriptor Example

Source: https://foundryvtt.com/api/v14/modules/foundry.canvas.vfx.html

A reference descriptor object used to dynamically resolve properties at runtime. This example shows how to reference the 'center' property of a 'target' with a positional delta.

```json
{
  "reference": "target",
  "property": "center",
  "delta": { "x": 0, "y": -50 }
}
```

--------------------------------

### _initializeApplicationOptions

Source: https://foundryvtt.com/api/v14/classes/foundry.applications.sidebar.tabs.NoteTab.html

Initializes the application options for the NoteTab. This method inherits its documentation.

```APIDOC
## _initializeApplicationOptions

### Description
Initializes the application options for the NoteTab. This method inherits its documentation.

### Method
_initializeApplicationOptions(options: any): ApplicationConfiguration

### Parameters
#### Path Parameters
* **options** (any)

### Returns
ApplicationConfiguration
```

--------------------------------

### Get Collection Name for Existing Collection

Source: https://foundryvtt.com/api/v14/classes/foundry.abstract.Document.html

Use this method to get the name of an embedded collection when the name is already known. This is useful for ensuring consistency in accessing embedded data.

```javascript
Actor.implementation.getCollectionName("items");
// returns "items"
```

--------------------------------

### initialize

Source: https://foundryvtt.com/api/v14/classes/foundry.canvas.sources.BaseLightSource.html

Initializes and configures the light source using provided data and options. This method can optionally reset source data to default values before applying changes.

```APIDOC
## initialize

### Description
Initialize and configure the source using provided data.

### Parameters
#### Path Parameters
* **data** (any) - Optional - Provided data for configuration
* **options** (object) - Optional - Additional options which modify source initialization
  * **reset** (boolean) - Optional - Should source data be reset to default values before applying changes?

### Returns
BaseLightSource - The initialized source
```

--------------------------------

### Get Entry by Name

Source: https://foundryvtt.com/api/v14/classes/foundry.abstract.EmbeddedCollectionDelta.html

Get an entry from the Collection by its name attribute. If strict mode is enabled, an error is thrown if the name is not found. Assumes stored objects have a 'name' property.

```javascript
let c = new Collection([["a", "Alfred"], ["b", "Bob"], ["c", "Cynthia"]]);
c.getName("Alfred"); // "Alfred"
c.getName("D"); // undefined
c.getName("D", {strict: true}); // throws Error
```

--------------------------------

### initialize

Source: https://foundryvtt.com/api/v14/classes/foundry.canvas.sources.PointLightSource.html

Initializes and configures the point light source using provided data and optional settings. Allows for resetting data to default values before applying changes.

```APIDOC
## initialize

### Description
Initialize and configure the source using provided data.

### Method
`initialize(data?: any, options?: { reset?: boolean }): PointLightSource`

### Parameters
#### Path Parameters
* **data** (any) - Optional - Provided data for configuration
* **options** (object) - Optional - Additional options which modify source initialization
  * **reset** (boolean) - Optional - Should source data be reset to default values before applying changes?

### Returns PointLightSource
```

--------------------------------

### Get Embedded Document

Source: https://foundryvtt.com/api/v14/classes/foundry.documents.BaseJournalEntryCategory.html

Get an embedded document by its id from a named collection in the parent document. Options can modify retrieval behavior, such as allowing invalid documents or enforcing strict existence checks.

```typescript
getEmbeddedDocument(
  embeddedName: string,
  id: string,
  options?: { invalid?: boolean; strict?: boolean },
): Document<object, DocumentConstructionContext>
```

--------------------------------

### SetupTour Protected Methods

Source: https://foundryvtt.com/api/v14/classes/foundry.nue.tours.SetupTour.html

Internal methods for SetupTour, including targeting elements.

```APIDOC
## Methods
### `Protected` _getTargetElement
  * _getTargetElement(selector: string): Element | null

`Protected`
Query the DOM for the target element using the provided selector

### Parameters
    * selector: string
      A CSS selector

### Returns
Element | null
  The target element, or null if not found

### `Protected` `Abstract` _postStep
  * _postStep(): Promise<void>

`Protected`
Clean-up operations performed after a step is completed.

### Returns
Promise<void>
```

--------------------------------

### _initializeApplicationOptions

Source: https://foundryvtt.com/api/v14/classes/foundry.applications.sidebar.apps.ModuleManagement.html

Initializes configuration options for the Application instance, merging subclass options with parent options.

```APIDOC
## _initializeApplicationOptions

### Description
Initialize configuration options for the Application instance. The default behavior of this method is to intelligently merge options for each class with those of their parents.
    * Array-based options are concatenated
    * Inner objects are merged
    * Otherwise, properties in the subclass replace those defined by a parent

### Parameters
#### Path Parameters
* `options` (Partial<ApplicationConfiguration>) - Required - Options provided directly to the constructor

### Returns ApplicationConfiguration
Configured options for the application instance
```

--------------------------------

### VisionMode Static LOCALIZATION_PREFIXES Example

Source: https://foundryvtt.com/api/v14/classes/foundry.canvas.perception.VisionMode.html

Demonstrates how to define localization prefixes for a DataModel to automatically map field labels and hints. This example shows a JavaScript class definition and the corresponding JSON localization structure.

```javascript
class MyDataModel extends foundry.abstract.DataModel {
  static defineSchema() {
    return {
      foo: new foundry.data.fields.StringField(),
      bar: new foundry.data.fields.NumberField()
    };
  }
  static LOCALIZATION_PREFIXES = ["MYMODULE.MYDATAMODEL"];
}

Hooks.on("i18nInit", () => {
  // Foundry will attempt to automatically localize models registered for a document subtype, so this step is only
  // needed for other data model usage, e.g. for a Setting.
  Localization.localizeDataModel(MyDataModel);
});
```

```json
{
  "MYMODULE": {
    "MYDATAMODEL": {
      "FIELDS" :
        {
          "foo": {
            "label": "Foo",
            "hint": "Instructions for foo"
          },
          "bar": {
            "label": "Bar",
            "hint": "Instructions for bar"
          }
        }
    }
  }
}
```

--------------------------------

### Application Constructor

Source: https://foundryvtt.com/api/v14/classes/foundry.appv1.api.Application.html

Initializes a new instance of the Application class with optional configuration options.

```APIDOC
## constructor
  * new Application(options?: ApplicationV1Options): Application

### Parameters
    * `Optional`options: ApplicationV1Options = {}
Configuration options which control how the application is rendered.

### Returns Application
```

--------------------------------

### getUserLevel

Source: https://foundryvtt.com/api/v14/classes/foundry.documents.BaseFolder.html

Get the explicit permission level that a User has over this Document, a value in CONST.DOCUMENT_OWNERSHIP_LEVELS. Compendium content ignores the ownership field in favor of User role-based ownership. Otherwise, Documents use granular per-User ownership definitions and Embedded Documents defer to their parent ownership. This method returns the value recorded in Document ownership, regardless of the User's role, for example a GAMEMASTER user might still return a result of NONE if they are not explicitly denoted as having a level. To test whether a user has a certain capability over the document, testUserPermission should be used.

```APIDOC
## getUserLevel

### Description
Get the explicit permission level that a User has over this Document, a value in CONST.DOCUMENT_OWNERSHIP_LEVELS. Compendium content ignores the ownership field in favor of User role-based ownership. Otherwise, Documents use granular per-User ownership definitions and Embedded Documents defer to their parent ownership. This method returns the value recorded in Document ownership, regardless of the User's role, for example a GAMEMASTER user might still return a result of NONE if they are not explicitly denoted as having a level. To test whether a user has a certain capability over the document, testUserPermission should be used.

### Method
`getUserLevel(user?: BaseUser): DocumentOwnershipNumber`

### Parameters
#### Path Parameters
- **user** (BaseUser) - Optional - The User being tested

### Returns
- **DocumentOwnershipNumber** - A numeric permission level from CONST.DOCUMENT_OWNERSHIP_LEVELS
```

--------------------------------

### _initializeApplicationOptions

Source: https://foundryvtt.com/api/v14/classes/foundry.applications.apps.DocumentOwnershipConfig.html

Initializes the options for the application.

```APIDOC
## _initializeApplicationOptions

### Description
Initializes the options for the application.

### Parameters
* **options** (any)

### Returns
any
```

--------------------------------

### validators

Source: https://foundryvtt.com/api/v14/classes/foundry.data.fields.TypedObjectField.html

Gets the validators for the field.

```APIDOC
## validators
  * get validators(): Record<string, any>

### Returns Record<string, any>

```

--------------------------------

### origin

Source: https://foundryvtt.com/api/v14/classes/foundry.data.LineShapeData.html

Get the origin of this shape.

```APIDOC
## origin

### Description
The origin of this shape.

### Returns
- Readonly<Point>: The origin of the shape.
```

--------------------------------

### initialize

Source: https://foundryvtt.com/api/v14/classes/foundry.canvas.placeables.tokens.TokenRingConfig.html

Register and initialize the token ring configuration system.

```APIDOC
## initialize

### Description
Register the token ring config and initialize it.

### Method
initialize

### Returns
- **void**
```

--------------------------------

### _onSoundStart

Source: https://foundryvtt.com/api/v14/classes/foundry.documents.Playlist.html

Handle callback logic when playback for an individual sound within the Playlist is started.

```APIDOC
## _onSoundStart

### Description
Handle callback logic when playback for an individual sound within the Playlist is started. Schedule auto-preload of next track

### Method
_onSoundStart

### Parameters
#### Path Parameters
* sound (PlaylistSound) - The sound that started playback.

### Returns Promise<void>
```

--------------------------------

### area

Source: https://foundryvtt.com/api/v14/classes/foundry.data.LineShapeData.html

Get the area of this shape.

```APIDOC
## area

### Description
Get the area of this shape.

### Returns
- number: The area of the shape.
```

--------------------------------

### getShape

Source: https://foundryvtt.com/api/v14/classes/foundry.canvas.placeables.Token.html

Get the shape of this Token.

```APIDOC
## getShape

### Description
Get the shape of this Token.

### Method
`getShape(): Rectangle | Polygon | Circle | Ellipse`

### Returns
- **Rectangle | Polygon | Circle | Ellipse** - The shape of the token
```

--------------------------------

### Methods

Source: https://foundryvtt.com/api/v14/classes/foundry.packages.BaseSystem.html

Provides functionality for initializing, testing, cloning, and serializing BaseSystem instances.

```APIDOC
## Methods

### _initializeSource
  * _initializeSource(
data: any,
__namedParameters?: { installed?: boolean },
): object
#### Parameters
    * data: any
    * __namedParameters: { installed?: boolean } = {}
#### Returns object


### _testRequiredDependencies
  * _testRequiredDependencies(
modulesCollection: Collection<string, Module>,
): Promise<boolean>
`Internal`
Test that the dependencies of a package are satisfied as compatible. This method assumes that all packages in modulesCollection have already had their own availability tested.
#### Parameters
    * modulesCollection: Collection<string, Module>
A collection which defines the set of available modules
#### Returns Promise<boolean>
Are all required dependencies satisfied?


### _testSupportedSystems
  * _testSupportedSystems(
systemCollection: Collection<string, System>,
): Promise<boolean>
`Internal`
Test compatibility of a package's supported systems.
#### Parameters
    * systemCollection: Collection<string, System>
A collection which defines the set of available systems.
#### Returns Promise<boolean>
True if all supported systems which are currently installed are compatible or if the package has no supported systems. Returns false otherwise, or if no supported systems are installed.


### clone
  * clone(
data?: object,
context?: DataModelConstructionContext,
): 
| DataModel<object, DataModelConstructionContext>
| Promise<DataModel<object, DataModelConstructionContext>>
Clone a model, creating a new data model by combining current data with provided overrides.
#### Parameters
    * `Optional`data: object = {}
Additional data which overrides current document data at the time of creation
    * `Optional`context: DataModelConstructionContext = {}
Context options passed to the data model constructor
#### Returns   
| DataModel<object, DataModelConstructionContext>
| Promise<DataModel<object, DataModelConstructionContext>>
The cloned instance


### getFieldForProperty
  * getFieldForProperty(key: string | string[]): DataField | undefined
Traverse the data model instance, obtaining the DataField definition for a field of a particular property.
#### Parameters
    * key: string | string[]
A property key like ["abilities", "strength"] or "abilities.strength"
#### Returns DataField | undefined
The corresponding DataField definition for that field, or undefined


### reset
  * reset(): void
Reset the state of this data instance back to mirror the contained source data, erasing any changes.
#### Returns void


### toJSON
  * toJSON(): object
Extract the source data for the DataModel into a simple object format that can be serialized.
#### Returns object
The document source data expressed as a plain object


### toObject
  * toObject(source?: boolean): object
Copy and transform the DataModel into a plain object. Draw the values of the extracted object from the data source (by default) otherwise from its transformed values.
#### Parameters
    * `Optional`source: boolean = true
Draw values from the underlying data source rather than transformed values
#### Returns object
The extracted primitive object
```

--------------------------------

### width

Source: https://foundryvtt.com/api/v14/classes/foundry.canvas.containers.SpriteMesh.html

Gets the width of the SpriteMesh.

```APIDOC
## width

### Description
Gets the width of the SpriteMesh.

### Returns
number
```

--------------------------------

### ClientPackage Constructor

Source: https://foundryvtt.com/api/v14/classes/foundry.ClientPackage.html

Initializes a new instance of the ClientPackage class.

```APIDOC
## new ClientPackage

### Description
Initializes a new instance of the ClientPackage class.

### Parameters
#### Parameters
- **data** (PackageManifestData) - Source data for the package
- **options** (object) - Optional. Options which affect DataModel construction. Defaults to {}.

### Returns
ClientPackage
```

--------------------------------

### height

Source: https://foundryvtt.com/api/v14/classes/foundry.canvas.containers.SpriteMesh.html

Gets the height of the SpriteMesh.

```APIDOC
## height

### Description
Gets the height of the SpriteMesh.

### Returns
number
```

--------------------------------

### initialize

Source: https://foundryvtt.com/api/v14/classes/foundry.canvas.sources.PointDarknessSource.html

Initializes and configures the point darkness source with provided data and optional settings.

```APIDOC
## initialize

### Description
Initialize and configure the source using provided data.

### Method
`initialize(data?: any, options?: { reset?: boolean }): PointDarknessSource`

### Parameters
#### Parameters
- **data** (any) - Optional - Provided data for configuration
- **options** (object) - Optional - Additional options which modify source initialization
  - **reset** (boolean) - Optional - Should source data be reset to default values before applying changes?

### Returns PointDarknessSource
```

--------------------------------

### getSetting

Source: https://foundryvtt.com/api/v14/classes/foundry.documents.collections.WorldSettings.html

Return the Setting document with the given key.

```APIDOC
## getSetting

### Description
Return the Setting document with the given key.

### Parameters
#### key
- **key** (string) - The setting key
#### user
- **user** (string) - Optional - For user-scoped settings, the user ID. Defaults to null.

### Returns
Setting - The Setting
```

--------------------------------

### Ping.animate

Source: https://foundryvtt.com/api/v14/classes/foundry.canvas.interaction.Ping.html

Starts the animation for the ping.

```APIDOC
## animate animate(): Promise<boolean>

### Description
Starts the ping animation.

### Returns
Promise<boolean> - Returns true if the animation ran to completion, false otherwise.
```

--------------------------------

### animate

Source: https://foundryvtt.com/api/v14/classes/foundry.canvas.interaction.ChevronPing.html

Starts the ping animation.

```APIDOC
## animate

### Description
Starts the ping animation.

### Returns
Promise<boolean> - Returns true if the animation ran to completion, false otherwise.
```

--------------------------------

### configure

Source: https://foundryvtt.com/api/v14/classes/foundry.canvas.sources.BaseLightSource.html

Configure the light source with changes.

```APIDOC
## configure

### Description
Configure the light source with changes.

### Method
`_configure(changes: any): void`

### Parameters
#### Path Parameters
- **changes** (any) - Description not available
```

--------------------------------

### setupPackages

Source: https://foundryvtt.com/api/v14/classes/foundry.Game.html

Configures package data for currently enabled packages in the world.

```APIDOC
## setupPackages

### Description
Configure package data that is currently enabled for this world.

### Method
setupPackages(data: object): void

### Parameters
* **data** (object) - Game data provided by the server socket.

### Returns
void
```

--------------------------------

### Get Collection Name for Document Type

Source: https://foundryvtt.com/api/v14/classes/foundry.abstract.Document.html

Use this method to get the collection name associated with a document type. If the direct collection name is not found, it attempts to find the first available collection for the given document name.

```javascript
Actor.implementation.getCollectionName("Item");
// returns "items"
```

--------------------------------

### initialize

Source: https://foundryvtt.com/api/v14/classes/foundry.documents.BaseItem.html

Initialize the instance by copying data from the source object to instance attributes.

```APIDOC
## initialize

### Description
Initialize the instance by copying data from the source object to instance attributes. This mirrors the workflow of SchemaField#initialize but with some added functionality.

### Method
`_initialize(options: any): void`

### Parameters
* `options` (any): Options provided to the model constructor.

### Returns
void
```

--------------------------------

### get

Source: https://foundryvtt.com/api/v14/classes/foundry.nue.ToursCollection.html

Retrieves an element from the Collection by its key.

```APIDOC
### get
  * get(key: string, options?: { strict?: boolean }): Tour | undefined
Get an element from the Collection by its key.
#### Parameters
    * key: string
The key of the entry to retrieve
    * `Optional`options: { strict?: boolean } = {}
Additional options that affect how entries are retrieved
      * ##### `Optional`strict?: boolean
Throw an Error if the requested key does not exist. Default false.
#### Returns Tour | undefined
The retrieved entry value, if the key exists, otherwise undefined
#### Example: Get an element from the Collection by key
```
let c = new Collection([["a", "Alfred"], ["b", "Bob"], ["c", "Cynthia"]]);  
c.get("a"); // "Alfred"  
c.get("d"); // undefined  
c.get("d", {strict: true}); // throws Error
Copy
```
```

--------------------------------

### get

Source: https://foundryvtt.com/api/v14/classes/foundry.documents.abstract.DocumentCollection.html

Retrieves an element from the DocumentCollection by its ID.

```APIDOC
## get

### Description
Get an element from the DocumentCollection by its ID.

### Parameters
#### Path Parameters
- **id** (string): The ID of the Document to retrieve.
#### Query Parameters
- **options** (object) - Optional: Additional options to configure retrieval.
  - **invalid** (boolean) - Optional: Allow retrieving an invalid Document.
  - **strict** (boolean) - Optional: Throw an Error if the requested Document does not exist.

### Returns
- TDocument: The retrieved Document.

### Throws
- If strict is true and the Document cannot be found.
```

--------------------------------

### create

Source: https://foundryvtt.com/api/v14/classes/foundry.canvas.rendering.shaders.DepthSamplerShader.html

Creates a new shader instance.

```APIDOC
## create

### Description
Creates a new shader instance.

### Method
`create(uniforms: any, options: any)`

### Parameters
#### Path Parameters
- **uniforms** (any) - Description not provided
- **options** (any) - Description not provided

### Returns
AbstractBaseShader
```

--------------------------------

### initializationOrder

Source: https://foundryvtt.com/api/v14/classes/foundry.documents.BaseJournalEntryPage.html

Get the initialization order for the document.

```APIDOC
## initializationOrder

### Description
Get the initialization order for the document.

### Method
`_initializationOrder(): Generator<(string | DataField | undefined)[], void, unknown>`

### Returns
Generator<(string | DataField | undefined)[], void, unknown>
```

--------------------------------

### configure

Source: https://foundryvtt.com/api/v14/classes/foundry.documents.BasePlaylistSound.html

Configure the BasePlaylistSound instance with optional parameters.

```APIDOC
## configure

### Description
Configure the BasePlaylistSound instance with optional parameters.

### Method
`_configure(__namedParameters?: { pack?: null; parentCollection?: null }): void`

### Parameters
* `__namedParameters` (object) - Optional. An object containing configuration options.
  * `pack` (null) - Optional. Pack identifier.
  * `parentCollection` (null) - Optional. Parent collection identifier.

### Returns
void
```

--------------------------------

### connect

Source: https://foundryvtt.com/api/v14/classes/foundry.av.AVMaster.html

Establishes a connection to the Audio/Video client.

```APIDOC
## connect

### Description
Connect to the Audio/Video client.

### Method
connect

### Returns Promise<boolean>
Was the connection attempt successful?
```

--------------------------------

### scene

Source: https://foundryvtt.com/api/v14/classes/foundry.data.LineShapeData.html

Get the scene that this shape is placed in, if any.

```APIDOC
## scene

### Description
The scene that this shape is placed in, if any.

### Returns
- documents.Scene | null: The scene the shape is in, or null if not placed in a scene.
```

--------------------------------

### _onCreate

Source: https://foundryvtt.com/api/v14/classes/foundry.documents.FogExploration.html

Post-process a creation operation for a single FogExploration instance. Post-operation events occur for all connected clients.

```APIDOC
## _onCreate

### Description
Post-process a creation operation for a single FogExploration instance. Post-operation events occur for all connected clients.

### Method
void

### Parameters
#### Path Parameters
* **data** (any) - Required - The initial data object provided to the document creation request
* **options** (any) - Required - Additional options which modify the creation request
* **userId** (any) - Required - The id of the User requesting the document update

### Returns void
```

--------------------------------

### grid

Source: https://foundryvtt.com/api/v14/classes/foundry.data.LineShapeData.html

Get the grid that this shape is placed in.

```APIDOC
## grid

### Description
The grid that this shape is placed in.

### Returns
- BaseGrid<GridCoordinates2D, GridCoordinates3D>: The grid associated with the shape.
```

--------------------------------

### center

Source: https://foundryvtt.com/api/v14/classes/foundry.data.LineShapeData.html

Get the center point of this shape.

```APIDOC
## center

### Description
The center point of this shape.

### Returns
- Readonly<Point>: The center point of the shape.
```

--------------------------------

### constructor

Source: https://foundryvtt.com/api/v14/classes/foundry.documents.collections.FogExplorations.html

Instantiates a new FogExplorations collection, optionally initializing it with provided data.

```APIDOC
## constructor
  * new FogExplorations(data?: object[]): FogExplorations
#### Parameters
    * data: object[] = []
An array of data objects from which to create document instances
#### Returns FogExplorations
```

--------------------------------

### constructor

Source: https://foundryvtt.com/api/v14/classes/foundry.grid.GridlessGrid.html

Initializes a new GridlessGrid instance with the provided configuration.

```APIDOC
## constructor
  * new GridlessGrid(config: GridConfiguration): GridlessGrid
The base grid constructor.
#### Parameters
    * config: GridConfiguration
The grid configuration
#### Returns GridlessGrid
```

--------------------------------

### triangulation

Source: https://foundryvtt.com/api/v14/classes/foundry.data.EllipseShapeData.html

Get the triangulation of this ellipse shape.

```APIDOC
## triangulation

### Description
Get the triangulation of this ellipse shape. The value of this property must not be mutated.

### Returns
Readonly<{ indices: Uint16Array | Uint32Array; vertices: Float32Array }> - The triangulation data of the ellipse.
```

--------------------------------

### create

Source: https://foundryvtt.com/api/v14/classes/foundry.audio.AudioHelper.html

Creates a Sound instance for a given audio source URL, allowing for programmatic control over individual sound effects or music tracks.

```APIDOC
## create

### Description
Create a Sound instance for a given audio source URL.

### Method
`create(options: SoundCreationOptions): Sound`

### Parameters
#### Path Parameters
- **options** (SoundCreationOptions) - Required - Sound creation options

### Returns
Sound - The created Sound instance
```

--------------------------------

### area

Source: https://foundryvtt.com/api/v14/classes/foundry.data.EllipseShapeData.html

Get the area of this ellipse shape.

```APIDOC
## area

### Description
Get the area of this ellipse shape.

### Returns
number - The area of the ellipse.
```

--------------------------------

### CombatConfiguration.turnMarker

Source: https://foundryvtt.com/api/v14/classes/foundry.data.CombatConfiguration.html

Gets the turn marker settings.

```APIDOC
## turnMarker

### Description
Get turn marker settings.

### Accessor
`get turnMarker(): Object`

### Returns
- **Object**
```

--------------------------------

### Methods

Source: https://foundryvtt.com/api/v14/classes/foundry.packages.BaseWorld.html

Provides methods for initializing package data, testing dependencies and systems, cloning models, getting field definitions, resetting state, and converting to JSON or object format.

```APIDOC
## Methods

### _initializeSource
  * _initializeSource(
data: any,
__namedParameters?: { installed?: boolean },
): object
#### Parameters
    * data: any
    * __namedParameters: { installed?: boolean } = {}
#### Returns object


### _testRequiredDependencies
  * _testRequiredDependencies(
modulesCollection: Collection<string, Module>,
): Promise<boolean>
`Internal`
Test that the dependencies of a package are satisfied as compatible. This method assumes that all packages in modulesCollection have already had their own availability tested.
#### Parameters
    * modulesCollection: Collection<string, Module>
A collection which defines the set of available modules
#### Returns Promise<boolean>
Are all required dependencies satisfied?


### _testSupportedSystems
  * _testSupportedSystems(
systemCollection: Collection<string, System>,
): Promise<boolean>
`Internal`
Test compatibility of a package's supported systems.
#### Parameters
    * systemCollection: Collection<string, System>
A collection which defines the set of available systems.
#### Returns Promise<boolean>
True if all supported systems which are currently installed are compatible or if the package has no supported systems. Returns false otherwise, or if no supported systems are installed.


### clone
  * clone(
data?: object,
context?: DataModelConstructionContext,
):  
| DataModel<object, DataModelConstructionContext>
| Promise<DataModel<object, DataModelConstructionContext>>
Clone a model, creating a new data model by combining current data with provided overrides.
#### Parameters
    * `Optional`data: object = {}
Additional data which overrides current document data at the time of creation
    * `Optional`context: DataModelConstructionContext = {}
Context options passed to the data model constructor
#### Returns   
| DataModel<object, DataModelConstructionContext>
| Promise<DataModel<object, DataModelConstructionContext>>
The cloned instance


### getFieldForProperty
  * getFieldForProperty(key: string | string[]): DataField | undefined
Traverse the data model instance, obtaining the DataField definition for a field of a particular property.
#### Parameters
    * key: string | string[]
A property key like ["abilities", "strength"] or "abilities.strength"
#### Returns DataField | undefined
The corresponding DataField definition for that field, or undefined


### reset
  * reset(): void
Reset the state of this data instance back to mirror the contained source data, erasing any changes.
#### Returns void


### toJSON
  * toJSON(): object
Extract the source data for the DataModel into a simple object format that can be serialized.
#### Returns object
The document source data expressed as a plain object


### toObject
  * toObject(source?: boolean): object
Copy and transform the DataModel into a plain object. Draw the values of the extracted object from the data source (by default) otherwise from its transformed values.
#### Parameters
    * `Optional`source: boolean = true
Draw values from the underlying data source rather than transformed values
#### Returns object
The extracted primitive object
```

--------------------------------

### CombatConfiguration.resource

Source: https://foundryvtt.com/api/v14/classes/foundry.data.CombatConfiguration.html

Gets the setting for the tracked resource.

```APIDOC
## resource

### Description
Get tracked resource setting.

### Accessor
`get resource(): string`

### Returns
- **string**
```

--------------------------------

### _onFirstRender

Source: https://foundryvtt.com/api/v14/classes/foundry.applications.sheets.AdventureExporter.html

Handles the initial rendering of the application, including context and options.

```APIDOC
## _onFirstRender

### Description
Handles the initial rendering of the application.

### Method
(Inherited Method)

### Parameters
#### Path Parameters
* **context** (any) - Required - The rendering context
* **options** (any) - Required - The rendering options

### Returns
Promise<void>
#### Inherit Doc
```

--------------------------------

### getSnappedPosition

Source: https://foundryvtt.com/api/v14/classes/foundry.canvas.placeables.Token.html

Get the snapped position of the token.

```APIDOC
## getSnappedPosition

### Description
Get the snapped position of the token.

### Method
`getSnappedPosition(position: any): { x: any; y: any }`

### Parameters
#### Path Parameters
- **position** (any) - Required - The position to snap

### Returns
- **{ x: any; y: any }** - The snapped position
```

--------------------------------

### _onFirstRender

Source: https://foundryvtt.com/api/v14/classes/foundry.applications.sheets.palette.TilePalette.html

Handles the initial rendering of the application. Inherits documentation from its parent class.

```APIDOC
## _onFirstRender

### Description
Handles the initial rendering of the application.

### Method
Internal

### Parameters
#### Path Parameters
* **context** (any) - Required - The rendering context
* **options** (any) - Required - Options for the first render

### Returns
Promise<void>

### Inherit Doc
```

--------------------------------

### defaultOptions

Source: https://foundryvtt.com/api/v14/classes/foundry.appv1.sheets.AdventureImporter.html

Get the default options for the Application.

```APIDOC
## defaultOptions

### Description
Get the default options for the Application.

### Method
GET

### Endpoint
/defaultOptions

### Returns
- **object** - The default options.
```

--------------------------------

### defaultOptions

Source: https://foundryvtt.com/api/v14/classes/foundry.appv1.api.DocumentSheet.html

Get the default options for the Application.

```APIDOC
## `Static`defaultOptions
  * get defaultOptions(): any
#### Returns any
```

--------------------------------

### _prepareContext

Source: https://foundryvtt.com/api/v14/classes/foundry.applications.sidebar.tabs.PlaylistDirectory.html

Prepares the context for rendering the playlist directory. This includes information about creation permissions, document names, and icons.

```APIDOC
## _prepareContext

### Description
Prepares the context for rendering the playlist directory. This includes information about creation permissions, document names, and icons.

### Method
_prepareContext

### Parameters
#### Path Parameters
* None

#### Query Parameters
* None

#### Request Body
* None

### Parameters
* **options** (any) - Options for context preparation.

### Returns Promise<ApplicationRenderContext & {
canCreateEntry: boolean;
canCreateFolder: boolean;
documentName: string;
folderIcon: string;
sidebarIcon: any;
}>
```

--------------------------------

### tab

Source: https://foundryvtt.com/api/v14/classes/foundry.applications.sidebar.filters.PlaceableFilter.html

Get the tab this dialog belongs to.

```APIDOC
## Accessor: tab

### Description
Get the tab this dialog belongs to.

### Returns
PlaceableTab
```

--------------------------------

### fromJSON

Source: https://foundryvtt.com/api/v14/classes/foundry.nue.Tour.html

Creates and returns a Tour instance by loading configuration from a JSON file.

```APIDOC
## fromJSON

### Description
Creates and returns a Tour by loading a JSON file.

### Method
`Static`

### Signature
`fromJSON(filepath: string): Promise<Tour>`

### Parameters
#### Path Parameters
- **filepath** (string) - Required - The path to the JSON file

### Returns
Promise<Tour>
```

--------------------------------

### BaseSystem Constructor

Source: https://foundryvtt.com/api/v14/classes/foundry.packages.BaseSystem.html

Constructs a new BaseSystem instance. It takes the source data for the package and optional configuration options.

```APIDOC
## constructor
  * new BaseSystem(data: PackageManifestData, options?: object): BaseSystem

### Parameters
    * data: PackageManifestData - Source data for the package
    * `Optional`options: object = {} - Options which affect DataModel construction

### Returns BaseSystem
```

--------------------------------

### schema

Source: https://foundryvtt.com/api/v14/classes/foundry.applications.sheets.palette.RegionPalette.html

Gets the schema associated with the class.

```APIDOC
## schema

### Description
Get the schema associated with the class.

### Method
GET

### Endpoint
accessor: schema

### Returns
any
```

--------------------------------

### CombatEncounters.active

Source: https://foundryvtt.com/api/v14/classes/foundry.documents.collections.CombatEncounters.html

Get the currently active Combat instance.

```APIDOC
## get active(): Combat

### Description
Retrieves the Combat document that is currently active in the game.

### Returns
Combat - The active Combat document, or null if none is active.
```
Tokens:
Raw