Indicator of whether cleanup was called already or not
The database plugin being used. Allows Dimensions to interact with a database and store Match, {@link Tournament}, and user data, allowing for data persistance across instances.
This dimension's ID. It is always a 6 character NanoID unless overrided through the DimensionConfigs
Logger
A map of the matches running in this Dimension
This Dimension's name
The storage plugin being used. Allows Dimensions to interact with a storage service and store user object data, particuarly bot file uploads
A map of the tournaments in this Dimension.
The Station associated with this Dimension and current node instance
Cleanup function that cleans up any resources used and related to this dimension. For use right before process exits and during testing.
Create a match with the given files and any optional Match.Configs. Resolves with the initialized Match object as specified by the Design of this Dimension
Rejects if an error occurs.
List of files or objects to use to generate agents and use for a new match
Configurations that are Design dependent
Create a tournament
The initial files to make competitors in this tournament. Can also specify the name and an existingID, which is the playerID. If database is used, this existingID is used to find the assocciated user with this ID.
Configuration for the tournament
a Tournament of the specified type
Get the station
Returns true if dimension has a database backing it
Returns true if dimension has a storage plugin backing it
Removes a match by id. Returns true if removed, false if nothing was removed
Runs a match with the given files and any optional Match.Configs. It rejects if an error occurs. Some errors include MatchDestroyedError which happens when Match.destroy is called.
This also automatically stores matches into the Database if database is active and configured to save
Resolves with the results of the match as specified by the Design of this Dimension
List of files or objects to use to generate agents and use for a new match
Configurations that are Design dependent. These configs are passed into Design.initialize
Design.update and Design.storeResults
Sets up necessary security and checks if everything is in place
Uses a particular plugin in the dimensions framework.
the plugin
Generates a 6 character nanoID string for identifying dimensions
Dimension configs. Set to defaults
Stats
Generated using TypeDoc
The Dimension framework for intiating a Design to then run instances of a Match or {@link Tournament} on.