Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ServerModuleListSnapshot

The ServerModuleListSnapshot class is used to load the server's current list of active server modules (not to be confused with room modules). By default, only administrator clients can load the server's module list.

The following code demonstrates:

The list of modules retrieved by ServerModuleListSnapshot is a one-time snapshot of the state of the server, and is not kept up to date after it is loaded. To update a ServerModuleListSnapshot object to match latest the state of the server, pass that object to Orbiter.updateSnapshot method.

Hierarchy

Index

Constructors

constructor

Properties

Readonly target

target: EventDispatcher

Methods

addEventListener

  • addEventListener(type: string, listener: Function, thisArg: any, priority?: number): boolean
  • Parameters

    • type: string
    • listener: Function
    • thisArg: any
    • Default value priority: number = 0

    Returns boolean

dispatchEvent

  • dispatchEvent(event: Event): void
  • Parameters

    • event: Event

    Returns void

getListeners

  • getListeners(type: string): EventListener[]
  • Parameters

    • type: string

    Returns EventListener[]

getModuleList

  • Returns an array of the server modules active on the server.

    Returns ModuleDefinition[] | null

getStatus

  • getStatus(): Status | undefined
  • Returns the status of the most recent snapshot load-operation. If a load operation is currently in progress, getStatus() returns null. The possible return values of getStatus() depend on the snapshot type.

    Returns Status | undefined

hasListener

  • hasListener(type: string, listener: Function, thisArg: any): boolean
  • Parameters

    • type: string
    • listener: Function
    • thisArg: any

    Returns boolean

removeEventListener

  • removeEventListener(type: string, listener: Function, thisArg: any): boolean
  • Parameters

    • type: string
    • listener: Function
    • thisArg: any

    Returns boolean

updateInProgress

  • updateInProgress(): boolean | undefined
  • Indicates whether the snapshot is currently loading data. While an update is in progress, further requests to update the snapshot are ignored.

    Returns boolean | undefined