Function getActors

Parameters

• Optionaloptions: {
      base?: boolean;
      linked?: boolean;
      ownership?: any;
      scene?: null | string | Scene;
      scenes?: boolean;
      types?: null | string[];
      unlinked?: boolean;
      users?: (string | User)[];
  } = {}

  Options for which actors to fetch.

  • Optionalbase?: boolean

    Return base actors (from game.actors).

  • Optionallinked?: boolean

    Get linked actors from scenes.

  • Optionalownership?: any

    What permission level (CONST.DOCUMENT_OWNERSHIP_LEVELS) to test user for, if user is defined.

  • Optionalscene?: null | string | Scene

    Specific scene. Sets scenes and base to false.

  • Optionalscenes?: boolean

    All scenes.

  • Optionaltypes?: null | string[]

    Array of actor types to accept. Returns all if null.

  • Optionalunlinked?: boolean

    Get unlinked actors from scenes.

  • Optionalusers?: (string | User)[]

    Test specific users permission, either User instances or user IDs. Defaults to current user.