new RoomExtension(id, className)

Creates a new RoomExtension instance.

The RoomSettings.extension property must be set to this instance during Room creation.

Parameters

Name Type Optional Description

id

string

 

The name of the Extension as deployed on the server; it's the name of the folder containing the Extension classes inside the main [sfs2x-install-folder]/SFS2X/extensions folder.

className

string

 

The fully qualified name of the main class of the Extension.

See also
RoomSettings#extension
CreateRoomRequest
ExtensionRequest

Properties

className  string

Returns the fully qualified name of the main class of the Extension.

id  string

Returns the name of the Extension to be attached to the Room.

It's the name of the server-side folder containing the Extension classes inside the main [sfs2x-install-folder]/SFS2X/extensions folder.

propertiesFile  string

Sets the name of an optional properties file that should be loaded on the server-side during the Extension initialization.

The file must be located in the server-side folder containing the Extension classes (see the id property).

Default value
An empty string