Match | dimensions-ai

An match created using a Design and a list of Agents. The match can be stopped and resumed with stop, resume, and state and configurations can be retrieved at any point in time with the state and configs fields

see: Design for Design information
see: Agent for Agent information

Hierarchy

Match

Index

Methods

Object literals

configs

Constructors

constructor

new Match(design: Design, agentFiles: GenerationMetaData, configs?: DeepPartial<Configs>, dimension: Dimension): Match

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/Match/index.ts#L171
Match Constructor

Parameters
- design: Design
  
  The Design used
- agentFiles: GenerationMetaData
- Default value configs: DeepPartial<Configs> = {}
  
  Configurations that are passed to every run through Design.initialize, Design.update, and Design.getResults functioon in the given Design
- dimension: Dimension
Returns Match

Properties

agentFiles

agentFiles: GenerationMetaData

agent meta data regarding files, ids, etc.

agents

agents: Array<Agent> = []

List of the agents currently involved in the match.

see: Agent for details on the agents.

creationDate

creationDate: Date

When the match was created (called with new)

design

design: Design

The Design used

Private dimension

dimension: Dimension

finishDate

finishDate: Date

When the match finished

id

id: NanoID

Match ID. It's always a 12 character NanoID

idToAgentsMap

idToAgentsMap: Map<ID, Agent> = new Map()

Map from an Agent.ID ID to the Agent

log

log: Logger = new Logger()

The match logger.

see: Logger for details on how to use this

mapAgentIDtoTournamentID

mapAgentIDtoTournamentID: Map<ID, ID> = new Map()

A mapping from Agent IDs to the tournament id of the Player in a tournament that generated the Agent

matchEngine

matchEngine: MatchEngine

The associated MatchEngine that is running this match and serves as the backend for this match.

matchProcess

matchProcess: ChildProcess

Match process used to store the process governing a match running on a custom design

matchProcessTimer

matchProcessTimer: any

The timer set for the match process

matchStatus

matchStatus: Status = Match.Status.UNINITIALIZED

The current match status

name

name: string

Name of the match

Private nonLocalFiles

nonLocalFiles: Array<string> = []

Non local files that should be removed as they are stored somewhere else. Typically bot files are non local if using a backing storage service

replayFile

replayFile: string

Path to the replay file for this match

replayFileKey

replayFileKey: string

Key used to retrieve the replay file from a storage plugin

Private resolveStopPromise

resolveStopPromise: Function

Resolver for stop Promise

results

results: any = null

The results field meant to store any results retrieved with Design.getResults

default: null

Private resumePromise

resumePromise: Promise<void>

Promise for resuming

Private resumeResolve

resumeResolve: Function

Resolver for the above promise

Private runReject

runReject: Function

Rejecter for the run promise

Private shouldStop

shouldStop: boolean = false

Signal to stop at next time step

state

state: any

The state field. This can be used to store anything by the user when this match is passed to the Design life cycle functions Design.initialize, Design.update, and Design.getResults

This is also used by the CustomDesign class to store all standard outputted match output for matches running using a custom design and passing in Design.OverrideOptions.

timeStep

timeStep: number = 0

The current time step of the Match. This time step is independent of any Design and agents are coordianted against this timeStep

Methods

destroy

destroy(): Promise<void>

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/Match/index.ts#L792
Destroys this match and makes sure to remove any leftover processes

Returns Promise<void>

getMatchErrorLogDirectory

getMatchErrorLogDirectory(): string

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/Match/index.ts#L809
Returns string

getResults

getResults(): Promise<any>

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/Match/index.ts#L693
Retrieve results through delegating the task to Design.getResults

Returns Promise<any>

Private handleLogFiles

handleLogFiles(): Promise<void>

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/Match/index.ts#L453
Handles log files and stores / uploads / deletes them as necessary

Returns Promise<void>

initialize

initialize(): Promise<boolean>

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/Match/index.ts#L225
Initializes this match using its configurations and using the Design.initialize function. This can throw error with agent generation, design initialization, or with engine initialization. In engine initialization, errors that can be thrown can be AgentCompileErrors, AgentInstallErrors, etc.

Returns Promise<boolean>

a promise that resolves true if initialized correctly

kill

kill(agent: ID | Agent, reason?: string): Promise<void>

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/Match/index.ts#L682
Terminate an Agent, kill the process. Note, the agent is still stored in the Match, but you can't send or receive messages from it anymore

Parameters
- agent: ID | Agent
  
  id of agent or the Agent object to kill
- Optional reason: string
  
  an optional reason string to provide for logging purposes
Returns Promise<void>

Private killAndCleanUp

killAndCleanUp(): Promise<void>

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/Match/index.ts#L666
Stop all agents through the match engine and clean up any other files and processes

Used by custom and dimensions based designs

Returns Promise<void>

next(): Promise<Status>

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/Match/index.ts#L524
Next function. Moves match forward by one timestep. Resolves with the match status This function should always used to advance forward a match unless a custom design is provided

Gathers commands from agents via the MatchEngine

Should not be called by user

Returns Promise<Status>

resume

resume(): Promise<void>

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/Match/index.ts#L634
Resume the match if it was in the stopped state

Returns Promise<void>

true if succesfully resumed

Private retrieveBot

retrieveBot(botkey: string, file: string, useCached: boolean): Promise<string>

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/Match/index.ts#L345
Retrieves a bot through its key and downloads it to a random generated folder. Returns the new file's path

Parameters
- botkey: string
- file: string
- useCached: boolean
  
  if true, storage plugin will avoid redownloading data. If false, storage plugin will always redownload data
Returns Promise<string>

run

run(): Promise<any>

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/Match/index.ts#L369
Runs this match to completion. Sets this.results to match results and resolves with the match results when done

Returns Promise<any>

send

send(message: string, receiver: Agent | ID): Promise<boolean>

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/Match/index.ts#L723
Functional method for sending a message string to a particular Agent. Returns a promise that resolves true if succesfully sent. Returns false if could not send message, meaning agent was also killed.

Parameters
- message: string
  
  the string message to send
- receiver: Agent | ID
  
  receiver of message can be specified by the Agent or it's Agent.ID (a number)
Returns Promise<boolean>

sendAll

sendAll(message: string): Promise<boolean>

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/Match/index.ts#L703
Sends a message to the standard input of all agents in this match

Parameters
- message: string
  
  the message to send to all agents available
Returns Promise<boolean>

a promise resolving true/false if it was succesfully sent

step

step(commands: Array<Command>): Promise<Status>

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/Match/index.ts#L506
Step forward the match by one timestep by sending commands individually.

Parameters
- commands: Array<Command>
Returns Promise<Status>

stop

stop(): Promise<void>

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/Match/index.ts#L602
Stops the match. For non-custom designs, stops at the next nearest timestep possible. Otherwise attempts to stop the match using the MatchEngine stopCustom function.

Notes:
- If design uses a PARALLEL match engine, stopping behavior can be a little unpredictable
- If design uses a SEQUENTIAL match engine, a stop will result in ensuring all agents complete all their actions up to a coordinated stopping timeStep
Returns Promise<void>

throw

throw(agentID: ID, error: Error): Promise<void>

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/Match/index.ts#L762
Throw an FatalError, MatchError, or MatchWarn within the Match. Indicates that the Agent with id agentID caused this error/warning.

Throwing MatchWarn will just log a warning level message and throwing a MatchError will just log it as an error level message.

Throwing FatalError will cause the match to automatically be destroyed. This is highly not recommended and it is suggested to have some internal logic to handle moments when the match cannot continue.

Examples are misuse of an existing command or using incorrect commands or sending too many commands

Parameters
- agentID: ID
  
  the misbehaving agent's ID
- error: Error
  
  The error
Returns Promise<void>

Static genMatchID

genMatchID(): string

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/Match/index.ts#L805
Generates a 12 character nanoID string for identifying matches

Returns string

Object literals

configs

configs: object

Match Configurations. See Match.Configs for configuration options

agentOptions

agentOptions: Options = deepCopy(Agent.OptionDefaults)

agentSpecificOptions

agentSpecificOptions: undefined[] = []

detached

detached: false = false

engineOptions

engineOptions: {}

Type declaration

languageSpecificAgentOptions

languageSpecificAgentOptions: {}

Type declaration

loggingLevel

loggingLevel: INFO = Logger.LEVEL.INFO

name

name: string = ""

secureMode

secureMode: false = false

storeErrorDirectory

storeErrorDirectory: string = "errorlogs"

storeErrorLogs

storeErrorLogs: true = true

storeMatchErrorLogs

storeMatchErrorLogs: false = false

storeReplay

storeReplay: true = true

storeReplayDirectory

storeReplayDirectory: string = "replays"

Hierarchy

Index

Enumerations

Interfaces

Constructors

Properties

Methods

Object literals

Constructors

constructor

Parameters

design: Design

agentFiles: GenerationMetaData

Default value configs: DeepPartial<Configs> = {}

dimension: Dimension

Returns Match

Properties

agentFiles

agents

creationDate

design

Private dimension

finishDate

id

idToAgentsMap

log

mapAgentIDtoTournamentID

matchEngine

matchProcess

matchProcessTimer

matchStatus

name

Private nonLocalFiles

replayFile

replayFileKey

Private resolveStopPromise

results

Private resumePromise

Private resumeResolve

Private runReject

Private shouldStop

state

timeStep

Methods

destroy

Returns Promise<void>

getMatchErrorLogDirectory

Returns string

getResults

Returns Promise<any>

Private handleLogFiles

Returns Promise<void>

initialize

Returns Promise<boolean>

kill

Parameters

agent: ID | Agent

Optional reason: string

Returns Promise<void>

Private killAndCleanUp

Returns Promise<void>

next

Returns Promise<Status>

resume

Returns Promise<void>

Private retrieveBot

Parameters

botkey: string

file: string

useCached: boolean

Returns Promise<string>

run

Returns Promise<any>

send

Parameters

message: string

receiver: Agent | ID

Returns Promise<boolean>

sendAll

Parameters