Class PlayerList

The UI element which displays the list of Users who are currently playing within the active World.

Hierarchy (view full)

Properties

options _element position _dragDrop _tabs _searchFilters _minimized _scrollPositions appId _state _priorState RENDER_STATES

Accessors

isHidden id element template popOut rendered closing title defaultOptions

Methods

render getData activateListeners activateTab bringToTop close minimize maximize setPosition _getDisplayName _positionInDOM _render _callHooks _saveScrollPositions _restoreScrollPositions _renderOuter _getHeaderButtons _activateCoreListeners _onChangeTab _onSearchFilter _canDragStart _canDragDrop _onDragStart _onDragOver _onDrop _waitForImages _getUserContextOptions _onToggleOfflinePlayers #kickUser #banUser #unbanUser

Properties

options

options: any

The options provided to this application upon initialization

_element

_element: jQuery

An internal reference to the HTML element this application renders

position

position: any

Track the current position and dimensions of the Application UI

_dragDrop

_dragDrop: DragDrop[]

DragDrop workflow handlers which are active for this Application

_tabs

_tabs: Tabs[]

Tab navigation handlers which are active for this Application

_searchFilters

_searchFilters: SearchFilter[]

SearchFilter handlers which are active for this Application

_minimized

_minimized: boolean

Track whether the Application is currently minimized

_scrollPositions

_scrollPositions: any

Track the most recent scroll positions for any vertically scrolling containers

appId

appId: number

The application ID is a unique incrementing integer which is used to identify every application window drawn by the VTT

Protected _state

_state: number

The current render state of the Application

See

Protected _priorState

_priorState: number

The prior render state of this Application. This allows for rendering logic to understand if the application is being rendered for the first time.

See

Static RENDER_STATES

RENDER_STATES: Readonly<{
    ERROR: -3;
    CLOSING: -2;
    CLOSED: -1;
    NONE: 0;
    RENDERING: 1;
    RENDERED: 2;
}> = ...

The sequence of rendering states that track the Application life-cycle.

Type declaration

  • ERROR: -3
  • CLOSING: -2
  • CLOSED: -1
  • NONE: 0
  • RENDERING: 1
  • RENDERED: 2

Accessors

isHidden

  • get isHidden(): boolean

  • Whether the players list is in a configuration where it is hidden.

    Returns boolean

id

  • get id(): string

  • Return the CSS application ID which uniquely references this UI element

    Returns string

element

  • get element(): jQuery

  • Return the active application element, if it currently exists in the DOM

    Returns jQuery

template

  • get template(): string

  • The path to the HTML template file which should be used to render the inner content of the app

    Returns string

popOut

  • get popOut(): boolean

  • Control the rendering style of the application. If popOut is true, the application is rendered in its own wrapper window, otherwise only the inner app content is rendered

    Returns boolean

rendered

  • get rendered(): boolean

  • Return a flag for whether the Application instance is currently rendered

    Returns boolean

closing

  • get closing(): boolean

  • Whether the Application is currently closing.

    Returns boolean

title

  • get title(): string

  • An Application window should define its own title definition logic which may be dynamic depending on its data

    Returns string

Static defaultOptions

  • get defaultOptions(): any

  • Returns any

Methods

render

  • render(force, context?): any

  • Parameters

    • force: any
    • context: {} = {}

      Returns any

    getData

    • getData(options?): {
          users: any;
          hide: boolean;
          showOffline: boolean;
      }

    • Parameters

      • options: {} = {}

        Returns {
            users: any;
            hide: boolean;
            showOffline: boolean;
        }

        • users: any
        • hide: boolean
        • showOffline: boolean

      activateListeners

      activateTab

      • activateTab(tabName, options?): void

      • Change the currently active tab

        Parameters

        • tabName: string

          The target tab name to switch to

        • options: {
              group: string;
              triggerCallback: boolean;
          } = {}

          Options which configure changing the tab

          • group: string

            A specific named tab group, useful if multiple sets of tabs are present

          • triggerCallback: boolean

            Whether to trigger tab-change callback functions

        Returns void

      bringToTop

      • bringToTop(): void

      • Bring the application to the top of the rendering stack

        Returns void

      close

      • close(options?): Promise<void>

      • Close the application and un-register references to it within UI mappings This function returns a Promise which resolves once the window closing animation concludes

        Parameters

        • Optional options: any = {}

          Options which affect how the Application is closed

        Returns Promise<void>

        A Promise which resolves once the application is closed

        Fires

        closeApplication

      minimize

      • minimize(): Promise<void>

      • Minimize the pop-out window, collapsing it to a small tab Take no action for applications which are not of the pop-out variety or apps which are already minimized

        Returns Promise<void>

        A Promise which resolves once the minimization action has completed

      maximize

      • maximize(): Promise<void>

      • Maximize the pop-out window, expanding it to its original size Take no action for applications which are not of the pop-out variety or are already maximized

        Returns Promise<void>

        A Promise which resolves once the maximization action has completed

      setPosition

      • setPosition(position?): void | {
            left: number;
            top: number;
            width: number;
            height: number;
            scale: number;
        }

      • Set the application position and store its new location. Returns the updated position object for the application containing the new values.

        Parameters

        • position: {
              left: number;
              top: number;
              width: number;
              height: string | number;
              scale: number;
          } = {}

          Positional data

          • left: number

            The left offset position in pixels

          • top: number

            The top offset position in pixels

          • width: number

            The application width in pixels

          • height: string | number

            The application height in pixels

          • scale: number

            The application scale as a numeric factor where 1.0 is default

        Returns void | {
            left: number;
            top: number;
            width: number;
            height: number;
            scale: number;
        }

      Protected _getDisplayName

      • _getDisplayName(user): string
      • Protected

        Prepare a displayed name string for the User which includes their name, pronouns, character, or GM tag.

        Parameters

        • user: any

        Returns string

      Protected _positionInDOM

      • _positionInDOM(): void
      • Protected

        Position this Application in the main DOM appropriately.

        Returns void

      Protected _render

      • _render(force?, options?): Promise<void>
      • Protected

        An asynchronous inner function which handles the rendering of the Application

        Parameters

        • force: boolean = false

          Render and display the application even if it is not currently displayed.

        • options: any = {}

          Additional options which update the current values of the Application#options object

        Returns Promise<void>

        A Promise that resolves to the Application once rendering is complete

        Fires

        renderApplication

      Protected _callHooks

      • _callHooks(hookName, ...hookArgs): void
      • Protected Internal

        Call all hooks for all applications in the inheritance chain.

        Parameters

        • hookName: string | ((className) => string)

          The hook being triggered, which formatted with the Application class name

        • Rest ...hookArgs: any[]

          The arguments passed to the hook calls

        Returns void

      Protected _saveScrollPositions

      • _saveScrollPositions(html): void
      • Protected

        Persist the scroll positions of containers within the app before re-rendering the content

        Parameters

        • html: jQuery

          The HTML object being traversed

        Returns void

      Protected _restoreScrollPositions

      • _restoreScrollPositions(html): void
      • Protected

        Restore the scroll positions of containers within the app after re-rendering the content

        Parameters

        • html: jQuery

          The HTML object being traversed

        Returns void

      Protected _renderOuter

      • _renderOuter(): Promise<jQuery>
      • Protected

        Render the outer application wrapper

        Returns Promise<jQuery>

        A promise resolving to the constructed jQuery object

      Protected _getHeaderButtons

      • _getHeaderButtons(): ApplicationHeaderButton[]
      • Protected

        Specify the set of config buttons which should appear in the Application header. Buttons should be returned as an Array of objects. The header buttons which are added to the application can be modified by the getApplicationHeaderButtons hook.

        Returns ApplicationHeaderButton[]

        Fires

        getApplicationHeaderButtons

      Protected _activateCoreListeners

      • _activateCoreListeners(html): void
      • Protected

        Activate required listeners which must be enabled on every Application. These are internal interactions which should not be overridden by downstream subclasses.

        Parameters

        • html: jQuery

        Returns void

      Protected _onChangeTab

      • _onChangeTab(event, tabs, active): void
      • Protected

        Handle changes to the active tab in a configured Tabs controller

        Parameters

        • event: MouseEvent

          A left click event

        • tabs: Tabs

          The Tabs controller

        • active: string

          The new active tab name

        Returns void

      Protected _onSearchFilter

      • _onSearchFilter(event, query, rgx, html): void
      • Protected

        Handle changes to search filtering controllers which are bound to the Application

        Parameters

        • event: KeyboardEvent

          The key-up event from keyboard input

        • query: string

          The raw string input to the search field

        • rgx: RegExp

          The regular expression to test against

        • html: HTMLElement

          The HTML element which should be filtered

        Returns void

      Protected _canDragStart

      • _canDragStart(selector): boolean
      • Protected

        Define whether a user is able to begin a dragstart workflow for a given drag selector

        Parameters

        • selector: string

          The candidate HTML selector for dragging

        Returns boolean

        Can the current user drag this selector?

      Protected _canDragDrop

      • _canDragDrop(selector): boolean
      • Protected

        Define whether a user is able to conclude a drag-and-drop workflow for a given drop selector

        Parameters

        • selector: string

          The candidate HTML selector for the drop target

        Returns boolean

        Can the current user drop on this selector?

      Protected _onDragStart

      • _onDragStart(event): void
      • Protected

        Callback actions which occur at the beginning of a drag start workflow.

        Parameters

        • event: DragEvent

          The originating DragEvent

        Returns void

      Protected _onDragOver

      • _onDragOver(event): void
      • Protected

        Callback actions which occur when a dragged element is over a drop target.

        Parameters

        • event: DragEvent

          The originating DragEvent

        Returns void

      Protected _onDrop

      • _onDrop(event): void
      • Protected

        Callback actions which occur when a dragged element is dropped on a target.

        Parameters

        • event: DragEvent

          The originating DragEvent

        Returns void

      Protected _waitForImages

      • _waitForImages(): Promise<void>
      • Protected

        Wait for any images present in the Application to load.

        Returns Promise<void>

        A Promise that resolves when all images have loaded.

      Private _getUserContextOptions

      • _getUserContextOptions(): any[]
      • Private

        Return the default context options available for the Players application

        Returns any[]

      Private _onToggleOfflinePlayers

      • _onToggleOfflinePlayers(event): void
      • Private

        Toggle display of the Players hud setting for whether to display offline players

        Parameters

        • event: Event

          The originating click event

        Returns void

      Private #kickUser

      • #kickUser(user): Promise<void>

      • Temporarily remove a User from the World by banning and then un-banning them.

        Parameters

        • user: User

          The User to kick

        Returns Promise<void>

      Private #banUser

      • #banUser(user): Promise<void>

      • Ban a User by changing their role to "NONE".

        Parameters

        • user: User

          The User to ban

        Returns Promise<void>

      Private #unbanUser

      • #unbanUser(user): Promise<void>

      • Unban a User by changing their role to "PLAYER".

        Parameters

        • user: User

          The User to unban

        Returns Promise<void>

      Settings

      Member Visibility

      Theme

      On This Page

      options_elementposition_dragDrop_tabs_searchFilters_minimized_scrollPositionsappId_state_priorStateRENDER_STATESisHiddenidelementtemplatepopOutrenderedclosingtitledefaultOptionsrendergetDataactivateListenersactivateTabbringToTopcloseminimizemaximizesetPosition_getDisplayName_positionInDOM_render_callHooks_saveScrollPositions_restoreScrollPositions_renderOuter_getHeaderButtons_activateCoreListeners_onChangeTab_onSearchFilter_canDragStart_canDragDrop_onDragStart_onDragOver_onDrop_waitForImages_getUserContextOptions_onToggleOfflinePlayers#kickUser#banUser#unbanUser