colyseus
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • EventEmitter
    • Server

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

clients

clients: object

Type declaration

  • [id: string]: Room<any>[]

matchMaker

matchMaker: MatchMaker = new MatchMaker()

server

server: WebSocketServer

EventEmitter

EventEmitter: EventEmitter

defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

  • addListener(event: string | symbol, listener: Function)

  • Parameters

    • event: string | symbol
    • listener: Function

emit

  • emit(event: string | symbol, ...args: any[]): boolean

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): string | symbol

  • Returns string | symbol

getMaxListeners

  • getMaxListeners(): number

  • Returns number

listenerCount

  • listenerCount(type: string | symbol): number

  • Parameters

    • type: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

on

  • on(event: string | symbol, listener: Function)

  • Parameters

    • event: string | symbol
    • listener: Function

onClientLeaveRoom

  • onClientLeaveRoom(room: any, client: any, isDisconnect: any): boolean

  • Parameters

    • room: any
    • client: any
    • isDisconnect: any

    Returns boolean

onConnect

  • onConnect(client: Client): void

onDisconnect

  • onDisconnect(client: any): void

onError

  • onError(client: Client, e: any): void

onJoinRoomRequest

  • onJoinRoomRequest(client: Client, roomToJoin: number | string, clientOptions: any): void

  • Parameters

    • client: Client
    • roomToJoin: number | string
    • clientOptions: any

    Returns void

onMessage

  • onMessage(client: Client, data: any): void

once

  • once(event: string | symbol, listener: Function)

  • Parameters

    • event: string | symbol
    • listener: Function

prependListener

  • prependListener(event: string | symbol, listener: Function)

  • Parameters

    • event: string | symbol
    • listener: Function

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: Function)

  • Parameters

    • event: string | symbol
    • listener: Function

register

  • register(name: string, handler: Function, options?: any): void
  • example

    Registering with room name + class handler server.register("room_name", RoomHandler)

    example

    Registering with room name + class handler + custom options server.register("area_1", AreaHandler, { map_file: "area1.json" }) server.register("area_2", AreaHandler, { map_file: "area2.json" }) server.register("area_3", AreaHandler, { map_file: "area3.json" })

    Parameters

    • name: string
    • handler: Function
    • Optional options: any

    Returns void

removeAllListeners

  • removeAllListeners(event?: string | symbol)

  • Parameters

    • Optional event: string | symbol

removeListener

  • removeListener(event: string | symbol, listener: Function)

  • Parameters

    • event: string | symbol
    • listener: Function

setMaxListeners

  • setMaxListeners(n: number)

  • Parameters

    • n: number

listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number

  • Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc