Function getActors

Parameters

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

  Options for which actors to fetch.

  • base: undefined | boolean

    Return base actors (from game.actors).

  • linked: undefined | boolean

    Get linked actors from scenes.

  • ownership: any

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

  • scene:
        | undefined
        | null
        | string
        | Scene

    Specific scene. Sets scenes and base to false.

  • scenes: undefined | boolean

    All scenes.

  • types: undefined | null | string[]

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

  • unlinked: undefined | boolean

    Get unlinked actors from scenes.

  • users: undefined | (string | User)[]

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