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

Type parameters

  • T

Hierarchy

  • EventEmitter
    • Room

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Room(options?: any): Room

  • Parameters

    • Default value options: any = {}

    Returns Room

Properties

_patchInterval

_patchInterval: number

_previousState

_previousState: any

_simulationInterval

_simulationInterval: Timer

clients

clients: Client[] = []

clock

clock: ClockTimer = new ClockTimer()

options

options: any

roomId

roomId: number

roomName

roomName: string

state

state: T

timeline

timeline: Timeline

EventEmitter

EventEmitter: EventEmitter

defaultMaxListeners

defaultMaxListeners: number

Methods

_onJoin

  • _onJoin(client: Client, options?: any): void

  • Parameters

    • client: Client
    • Optional options: any

    Returns void

_onLeave

  • _onLeave(client: Client, isDisconnect?: boolean): void

  • Parameters

    • client: Client
    • Default value isDisconnect: boolean = false

    Returns void

addListener

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

  • Parameters

    • event: string | symbol
    • listener: Function

broadcast

  • broadcast(data?: any): boolean

  • Parameters

    • Optional data: any

    Returns boolean

broadcastPatch

  • broadcastPatch(): boolean

broadcastState

  • broadcastState(): boolean

disconnect

  • disconnect(): void

emit

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

  • Parameters

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

    Returns boolean

eventNames

  • eventNames(): string | symbol

  • Returns string | symbol

getEncodedState

  • getEncodedState(): any

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[]

lock

  • lock(): void

on

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

  • Parameters

    • event: string | symbol
    • listener: Function

onDispose

  • onDispose(): void

onJoin

  • onJoin(client: Client, options?: any): void

  • Parameters

    • client: Client
    • Optional options: any

    Returns void

onLeave

  • onLeave(client: Client): void

onMessage

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

once

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

  • Parameters

    • event: string | symbol
    • listener: Function

patch

  • patch(): void

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

removeAllListeners

  • removeAllListeners(event?: string | symbol)

  • Parameters

    • Optional event: string | symbol

removeListener

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

  • Parameters

    • event: string | symbol
    • listener: Function

requestJoin

  • requestJoin(options: any): boolean

  • Parameters

    • options: any

    Returns boolean

send

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

sendState

  • sendState(client: Client): void

setMaxListeners

  • setMaxListeners(n: number)

  • Parameters

    • n: number

setPatchRate

  • setPatchRate(milliseconds: number): void

  • Parameters

    • milliseconds: number

    Returns void

setSimulationInterval

  • setSimulationInterval(callback: Function, delay?: number): void

  • Parameters

    • callback: Function
    • Default value delay: number = 1000 / 60

    Returns void

setState

  • setState(newState: any): void

  • Parameters

    • newState: any

    Returns void

unlock

  • unlock(): void

useTimeline

  • useTimeline(maxSnapshots?: number): void

  • Parameters

    • Default value maxSnapshots: number = 10

    Returns void

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