Actors

Actors

The Collection of Actor entities.

Constructor

new Actors()

Source:
See:
  • Actor The Actor entity.
  • ActorDirectory All Actors which exist in the world are rendered within the ActorDirectory sidebar tab.
Example

Retrieve an existing Actor by its id

let actor = game.actors.get(actorId);

Extends

Members

(static) registeredSheets :Array

Source:

Return an Array of currently registered sheet classes for this Entity type

Type:

apps :Array

Source:
Overrides:

An Array of application references which will be automatically updated when the collection content changes

Type:

directory :SidebarDirectory|null

Source:
Overrides:

Return a reference to the SidebarDirectory application for this Collection, or null if it has not yet been created.

Type:

entities :Array

Source:
Overrides:

An Array of all the Entity instances of this type which are contained within the collection

Type:

entity :string

Source:
Overrides:

Return a reference to the base Entity name which is contained within this Collection.

Type:
  • string

name :string

Source:
Overrides:

The Collection name

Type:
  • string

object :Entity

Source:
Overrides:

Return a reference to the Entity subclass which should be used when creating elements of this Collection. This should always be an explicit reference to the class which is used in this game to represent the entity, and not the base implementation of that entity type. For example :class:Actor5e not :class:Actor.

Type:

tokens :Object

Source:

A mapping of synthetic Token Actors which are currently active within the viewed Scene. Each Actor is referenced by the Token.id.

Type:
  • Object

Methods

(static) registerSheet()

Source:

Register an Actor sheet class as a candidate which can be used to display Actors of a given type See EntitySheetConfig.registerSheet for details

Example

Register a new ActorSheet subclass for use with certain Actor types.

Actors.registerSheet("dnd5e", ActorSheet5eCharacter, { types: ["character"], makeDefault: true });

(static) unregisterSheet()

Source:

Unregister an Actor sheet class, removing it from the list of avaliable sheet Applications to use See EntitySheetConfig.unregisterSheet for details

Example

Deregister the default ActorSheet subclass to replace it with others.

Actors.unregisterSheet("core", ActorSheet);

get(id, strict) → {Entity|null}

Source:
Overrides:

Get an element from the collection by ID.

Parameters:
Name Type Description
id string

The entity ID to retrieve from the collection
strict boolean

Throw an Error if the requested id does not exist, otherwise return null. Default false.
Returns:

The retrieved Entity, if the ID was found, otherwise null;

Type
Entity | null

(async) importFromCollection(collection, entryId, updateDataopt, optionsopt) → {Promise.<Entity>}

Source:
Overrides:

Import an Entity from a compendium collection, adding it to the current World.

Parameters:
Name Type Attributes Description
collection string

The name of the pack from which to import
entryId string

The ID of the compendium entry to import
updateData Object <optional>

Optional additional data used to modify the imported Entity before it is created
options Object <optional>

Optional arguments passed to the Entity.create method
Returns:

A Promise containing the imported Entity

Type
Promise.<Entity>

initialize() → {this}

Source:
Overrides:

Initialize the Collection instance by preparing all of it's contained Entities

Returns:

A reference to the initialized Collection

Type
this

insert(entity)

Source:
Overrides:

Add a new Entity to the Collection, asserting that they are of the correct type.

Parameters:
Name Type Description
entity Entity

The entity instance to add to the collection

remove(id)

Source:
Overrides:

Remove an Entity from the Collection by its ID.

Parameters:
Name Type Description
id string

The entity ID which should be removed

render() → {this}

Source:
Overrides:

Render any Applications associated with this Collection

Returns:

A reference to the rendered Collection

Type
this