Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Options

Agent options interface

Hierarchy

  • Options

Index

Properties

compileCommands

compileCommands: {}

Map from extension type to set of commands used to compile this agent instead of the defaults. When there is no mapping default commands are used

default

null

Type declaration

detached

detached: boolean

Whether agent is to be run in detached mode. In detached mode, the agent simply stores messages that is written to it and clears the message queue when a turn is finished

default

false

id

id: ID

A specified ID to use for the agent

image

image: string

Image to use for docker container if Agent is being run in secureMode. The default is a standard image provided by Dimensions that has all supported languages built in so agents can use them. The requirement for these images is that they have bash installed.

It is highly recommended to use the Match.Configs.languageSpecificAgentOptions field and set specific images for each programming language in a production environment to reduce overhead caused by docker.

default

docker.io/stonezt2000/dimensions_langs

logLimit

logLimit: number

Limit of agent logs in bytes.

default

1e5 - 100 kb

loggingLevel

loggingLevel: LEVEL

Logging level of this agent

maxCompileTime

maxCompileTime: number

Maximum time allowed to be spent compiling

default

1 minute (60,000 ms)

maxInstallTime

maxInstallTime: number

Maximium time allowed for an agent to spend on the installing step

default

5 minutes (300,000 ms)

name

name: string

Name of agent

runCommands

runCommands: {}

Map from extension type to set of commands used to run this agent instead of the defaults. When there is no mapping default commands are used

default

null

Type declaration

secureMode

secureMode: boolean

Whether or not to spawn agent securely and avoid malicious activity

When set to true, the agent's file and the directory containing the file are copied over to a temporary directory of which there is restricted access. By default this is false

default

false (always inherited from the match configs, see Match.Configs)

tournamentID

tournamentID: ID

A specified tournament ID linking an agent to the {@link Tournament} and Player it belongs to

useCachedBotFile

useCachedBotFile: boolean

Whether or not to try and use a cached bot file. This is only relevant if a storage service is used as it helps reduce the number of times a bot file is downloaded.

default

false

Generated using TypeDoc