Runtime | nrelay

The runtime manages clients, resources, plugins and any other services which are used by an nrelay project.

Hierarchy

EventEmitter
- Runtime

Index

Constructors

constructor

Properties

Constructors

constructor

new Runtime(environment: Environment): Runtime

- Defined in runtime/runtime.ts:88
Parameters
- environment: Environment
Returns Runtime

Properties

accountService

accountService: AccountService

The account service used by this runtime.

args

args: Arguments

The last arguments which were passed to this runtime.

Note that this may be undefined, and it may also contain arguments which were not passed by the user (such as the update and plugin-path args).

buildVersion

buildVersion: string

The build version to use when creating new clients.

Private clients

clients: Map<string, Client>

The clients which are managed by this runtime.

env

env: Environment

The environment of this runtime.

libraryManager

libraryManager: LibraryManager

The library manager used by this runtime.

Private logStream

logStream: WriteStream

A WriteStream which is used for the log file.

packetMap

packetMap: PacketMap

A bidirectional map of packet ids.

resources

resources: ResourceManager

The resource manager used by this runtime.

updater

updater: Updater

The updater used by this runtime.

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addClient

addClient(account: Account): Promise<Client>

- Defined in runtime/runtime.ts:250
Creates a new client which uses the provided account.

Parameters
- account: Account
  
  The account to login to.
Returns Promise<Client>

addListener

addListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.addListener

Overrides EventEmitter.addListener
- Defined in C:/Users/Tom/Documents/dev/rotmg/current-nrelay/nrelay/node_modules/@types/node/index.d.ts:946
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

Private createLog

createLog(): void

- Defined in runtime/runtime.ts:335
Creates a log file for this runtime.

Returns void

emit

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

Inherited from EventEmitter.emit

Overrides EventEmitter.emit
- Defined in C:/Users/Tom/Documents/dev/rotmg/current-nrelay/nrelay/node_modules/@types/node/index.d.ts:956
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): Array<string | symbol>

Inherited from EventEmitter.eventNames

Overrides EventEmitter.eventNames
- Defined in C:/Users/Tom/Documents/dev/rotmg/current-nrelay/nrelay/node_modules/@types/node/index.d.ts:957
Returns Array<string | symbol>

getClients

getClients(): Client[]

- Defined in runtime/runtime.ts:320
Gets a copy of the clients in this runtime. Modifying this list will not affect the runtime.

Returns Client[]

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners

Overrides EventEmitter.getMaxListeners
- Defined in C:/Users/Tom/Documents/dev/rotmg/current-nrelay/nrelay/node_modules/@types/node/index.d.ts:954
Returns number

listenerCount

listenerCount(type: string | symbol): number

Inherited from EventEmitter.listenerCount

Overrides EventEmitter.listenerCount
- Defined in C:/Users/Tom/Documents/dev/rotmg/current-nrelay/nrelay/node_modules/@types/node/index.d.ts:958
Parameters
- type: string | symbol
Returns number

listeners

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

Inherited from EventEmitter.listeners

Overrides EventEmitter.listeners
- Defined in C:/Users/Tom/Documents/dev/rotmg/current-nrelay/nrelay/node_modules/@types/node/index.d.ts:955
Parameters
- event: string | symbol
Returns Function[]

on

on(event: string | symbol, listener: function): this

Inherited from EventEmitter.on

Overrides EventEmitter.on
- Defined in C:/Users/Tom/Documents/dev/rotmg/current-nrelay/nrelay/node_modules/@types/node/index.d.ts:947
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

once

once(event: string | symbol, listener: function): this

Inherited from EventEmitter.once

Overrides EventEmitter.once
- Defined in C:/Users/Tom/Documents/dev/rotmg/current-nrelay/nrelay/node_modules/@types/node/index.d.ts:948
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependListener

prependListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.prependListener

Overrides EventEmitter.prependListener
- Defined in C:/Users/Tom/Documents/dev/rotmg/current-nrelay/nrelay/node_modules/@types/node/index.d.ts:949
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependOnceListener

prependOnceListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in C:/Users/Tom/Documents/dev/rotmg/current-nrelay/nrelay/node_modules/@types/node/index.d.ts:950
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from EventEmitter.removeAllListeners

Overrides EventEmitter.removeAllListeners
- Defined in C:/Users/Tom/Documents/dev/rotmg/current-nrelay/nrelay/node_modules/@types/node/index.d.ts:952
Parameters
- Optional event: string | symbol
Returns this

removeClient

removeClient(guid: string): void

- Defined in runtime/runtime.ts:300
Removes the client with the given guid from this runtime.

Parameters
- guid: string
  
  The guid of the client to remove.
Returns void

removeListener

removeListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.removeListener

Overrides EventEmitter.removeListener
- Defined in C:/Users/Tom/Documents/dev/rotmg/current-nrelay/nrelay/node_modules/@types/node/index.d.ts:951
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

run

run(args: Arguments): Promise<void>

- Defined in runtime/runtime.ts:104
Starts this runtime.

Parameters
- args: Arguments
  
  The arguments to start the runtime with.
Returns Promise<void>

setMaxListeners

setMaxListeners(n: number): this

Inherited from EventEmitter.setMaxListeners

Overrides EventEmitter.setMaxListeners
- Defined in C:/Users/Tom/Documents/dev/rotmg/current-nrelay/nrelay/node_modules/@types/node/index.d.ts:953
Parameters
- n: number
Returns this

updateBuildVersion

updateBuildVersion(buildVersion: string): void

- Defined in runtime/runtime.ts:328
Updates the build version stored in the versions.json file.

Parameters
- buildVersion: string
  
  The new build version to store.
Returns void

Static listenerCount

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

Inherited from EventEmitter.listenerCount
- Defined in C:/Users/Tom/Documents/dev/rotmg/current-nrelay/nrelay/node_modules/@types/node/index.d.ts:943
Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

environment: Environment

Returns Runtime

Properties

accountService

args

buildVersion

Private clients

env

libraryManager

Private logStream

packetMap

resources

updater

Static defaultMaxListeners

Methods

addClient

Parameters

account: Account

Returns Promise<Client>

addListener

Parameters

event: string | symbol

listener: function

Parameters

Rest ...args: any[]

Returns void

Returns this

Private createLog

Returns void

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

eventNames

Returns Array<string | symbol>

getClients

Returns Client[]

getMaxListeners

Returns number

listenerCount

Parameters

type: string | symbol

Returns number

listeners

Parameters

event: string | symbol

Returns Function[]

on

Parameters

event: string | symbol

listener: function

Parameters

Rest ...args: any[]

Returns void

Returns this

once

Parameters

event: string | symbol

listener: function

Parameters

Rest ...args: any[]

Returns void

Returns this

prependListener

Parameters

event: string | symbol

listener: function

Parameters

Rest ...args: any[]

Returns void

Returns this