Documentation
¶
Index ¶
- func CurrentReplayPath() string
- func OpponentID() string
- func Random1v1Map() string
- func RunAgent(agent client.PlayerSetup)
- func Set(name, value string)
- func SetComputer(race api.Race, difficulty api.Difficulty, build api.AIBuild)
- func SetConnectTimeout(timeout time.Duration)
- func SetExecutable(exePath string)
- func SetGameVersion(baseBuild uint32, dataVersion string)
- func SetInterfaceOptions(options *api.InterfaceOptions)
- func SetMap(name string)
- func SetRealtime()
- func SetReplayFilter(filter func(info *api.ResponseReplayInfo) bool)
- func SetReplayPath(path string) error
- func SetReplayPlayerID(player api.PlayerID)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CurrentReplayPath ¶
func CurrentReplayPath() string
CurrentReplayPath provides access to the replay filename and full path of the current replay (if any).
func OpponentID ¶ added in v0.2.0
func OpponentID() string
OpponentID returns the current ladder opponent ID or an empty string.
func Random1v1Map ¶
func Random1v1Map() string
Random1v1Map returns a random map name from the current 1v1 ladder map pool.
func SetComputer ¶
SetComputer sets the default computer opponent flags (can still be overridden on the command line).
func SetConnectTimeout ¶ added in v0.2.0
SetConnectTimeout sets how long to wait for a connection to the game.
func SetExecutable ¶ added in v0.2.0
func SetExecutable(exePath string)
SetExecutable sets the default executable path to use.
func SetGameVersion ¶ added in v0.2.0
SetGameVersion specifies a specific base game and data version to use when launching.
func SetInterfaceOptions ¶ added in v0.2.0
func SetInterfaceOptions(options *api.InterfaceOptions)
SetInterfaceOptions sets the interface launch options when starting a game.
func SetReplayFilter ¶
func SetReplayFilter(filter func(info *api.ResponseReplayInfo) bool)
SetReplayFilter provides a filter which determines if a replay should be run. This allows such things as MMR filtering within a large group of replays. The filter function can also call SetReplayPlayerID before returning true to alter the player who will be observed for the replay.
func SetReplayPath ¶
SetReplayPath sets a directory of replay files or a single replay to load.
func SetReplayPlayerID ¶
SetReplayPlayerID specifies which player the agent would like to observe. This can be called from the filter function specified in SetReplayFilter to determine the player dynamically.
Types ¶
This section is empty.
Source Files