Class: RPG

RPG(settingsopt)

The core RPG class provides all functions necessary for interacting with the game world, as powered by Verse.

Constructor

new RPG(settingsopt)

Instantiate an instance of RPG using `new RPG(settings)`, where `settings` is an `Object` containing various optional settings.
Parameters:
Name Type Attributes Description
settings Object <optional>
Properties
Name Type Attributes Default Description
authority String <optional>
 localhost:9999 Host and port combination reflecting intended authority.
Properties:
Name Type Description
entities Collection
Source:

Members

handles

Provides a simple list of named Collection types to manage.
Source:

state

Provides an Entity representing the current game state.
Properties:
Name Type Description
id String Hex-encoded unique identifier for the game state.
Source:

Methods

(async) _sync()

Load information from the configured Authority.
Source:

(async) start()

Call `start()` to begin processing the game state, including the clock beginning to advance for the in-game world.
Source: