Class: Route

Route

Represents a Route on a Scene.

Constructor

new Route(scene, name, handle, metadata)

Creates a new route instance.

Parameters:
Name Type Description
scene Stormancer.Scene

The scene instance

name string

The route name.

handle number

Handle of the route (16 bits unsigned integer).

metadata object.<string, string>

Metadata attached to this route.

Source:

Members

handle :number

Route handle.

Type:
  • number
Source:

handlers :Array.<function()>

Contains the handlers that are run when packets are received.

Type:
  • Array.<function()>
Source:

metadata :object.<string, string>

Route metadata.

Type:
  • object.<string, string>
Source:

name :string

A string containing the name of the route.

Type:
  • string
Source:

scene :Stormancer.Scene

The Scene instance which contains this route.

Type:
Source: