API Overview

Currently, our API consists of these components: OperationType, VariableType, ConnectionState, AllowFlags, CollisionFlags, Callback, Utils, Room, Replay, EventFactory, Query, Library, RoomConfig, Plugin, Renderer, Errors, Language, Impl.

Here is a classification of these components:

Constants

These are some constant values defined mostly to let us understand returning values of some functions.

OperationType: Click here for detailed explanation.

VariableType: Click here for detailed explanation.

AddonType: Click here for detailed explanation.

ConnectionState: Click here for detailed explanation.

AllowFlags: Click here for detailed explanation.

Direction: Click here for detailed explanation.

CollisionFlags: Click here for detailed explanation.

CameraFollow: Click here for detailed explanation.

BackgroundType: Click here for detailed explanation.

GamePlayState: Click here for detailed explanation.

BanEntryType: Click here for detailed explanation.

PlayerPositionInGame: Click here for detailed explanation.

Interfaces

These are mostly big objects, some consisting of many constants, functions or objects.

Callback: Click here for detailed explanation.

Utils: Click here for detailed explanation.

Room: Click here for detailed explanation.

Replay: Click here for detailed explanation.

EventFactory: Click here for detailed explanation.

Query: Click here for detailed explanation.

Errors: Click here for detailed explanation.

Impl: Click here for detailed explanation.

Classes

These are some important helper classes.

Library: Click here for detailed explanation.

RoomConfig: Click here for detailed explanation.

Plugin: Click here for detailed explanation.

Renderer: Click here for detailed explanation.

Language: Click here for detailed explanation.