nl.tudelft.goal.ut3.agent
Class UT3BotBehavior

java.lang.Object
  cz.cuni.amis.pogamut.ut2004.bot.impl.UT2004BotController<BOT>
      cz.cuni.amis.pogamut.ut2004.bot.impl.UT2004BotLogicController<BOT>
          cz.cuni.amis.pogamut.ut3.bot.impl.UT3BotModuleController<cz.cuni.amis.pogamut.ut2004.bot.impl.UT2004Bot>
              nl.tudelft.goal.ut3.agent.UT3BotBehavior

All Implemented Interfaces:

cz.cuni.amis.pogamut.base.agent.module.IAgentLogic<cz.cuni.amis.pogamut.base.agent.module.LogicModule>, cz.cuni.amis.pogamut.ut2004.bot.IUT2004BotController<cz.cuni.amis.pogamut.ut2004.bot.impl.UT2004Bot>, cz.cuni.amis.pogamut.ut2004.bot.IUT2004BotLogicController<cz.cuni.amis.pogamut.ut2004.bot.impl.UT2004Bot,cz.cuni.amis.pogamut.base.agent.module.LogicModule>, eis.eis2java.util.AllPerceptsProvider

public class UT3BotBehavior
extends UT3BotModuleController<cz.cuni.amis.pogamut.ut2004.bot.impl.UT2004Bot>
implements eis.eis2java.util.AllPerceptsProvider

Field Summary

protected long	actionCount
protected nl.tudelft.pogamut.unreal.agent.module.shooting.util.OrderedFocusProvider	focus
protected long	logicIteration
protected nl.tudelft.pogamut.unreal.agent.module.shooting.util.FocusProvider	lookFocus
protected List<ContextSelector>	lookSelector
protected nl.tudelft.goal.unreal.messages.BotParameters	parameters Settings for the bot.
protected eis.eis2java.util.AllPerceptsModule	percepts
protected nl.tudelft.pogamut.unreal.agent.module.sensor.Projectiles	projectiles
protected nl.tudelft.goal.unreal.floydwarshall.SharedFloydWarshallMap	sfwMap Path-planner (IPathPlanner using NavPoints), you may use it to find paths inside the environment wihtout waiting for round-trip of GetPath command and PathLists response from UT2004.
protected List<ContextSelector>	targetSelector
protected nl.tudelft.pogamut.unreal.agent.module.shooting.WeaponryShooting	weaponShooting

Fields inherited from class cz.cuni.amis.pogamut.ut3.bot.impl.UT3BotModuleController

act, body, config, ctf, fwMap, game, getBackToNavGraph, info, items, listenerRegistrator, move, navBuilder, navigation, pathExecutor, pathPlanner, players, random, raycasting, runStraight, senses, shoot, visibility, weaponPrefs, weaponry, world

Fields inherited from class cz.cuni.amis.pogamut.ut2004.bot.impl.UT2004BotLogicController

logicModule

Fields inherited from class cz.cuni.amis.pogamut.ut2004.bot.impl.UT2004BotController

bot, log, USER_LOG_CATEGORY_ID

Constructor Summary

UT3BotBehavior()

Method Summary

nl.tudelft.goal.unreal.messages.Percept	actionCount() Deprecated.
void	addAction(nl.tudelft.goal.unreal.actions.Action action) Queues up the action to be executed on the first evaluation of the logic cycle.
nl.tudelft.goal.unreal.messages.Percept	armor()
Collection<nl.tudelft.goal.unreal.messages.Percept>	base() Information about the location of the base.
void	beforeFirstLogic() Called before the evaluation of the first logic.
Collection<nl.tudelft.goal.unreal.messages.Percept>	bot() Percept provided when another bot becomes visible to this bot.
nl.tudelft.goal.unreal.messages.Percept	currentWeapon() Information about weapon the bot is currently holding.
void	deploy() Bot tries to deploy a deployable weapon.
Collection<nl.tudelft.goal.unreal.messages.Percept>	deployable() Information about the deployable the bot is currently holding.
void	finishControllerInitialization() Finish controller initialisation.
Collection<nl.tudelft.goal.unreal.messages.Percept>	flag() Description: Percept provided when the flag is visible.
Collection<nl.tudelft.goal.unreal.messages.Percept>	flagState() Description: Percept that provides information about the current state of the flag.
List<nl.tudelft.goal.unreal.messages.Percept>	fragged() This percept is provided when one bot is violently fragmented by another.
nl.tudelft.goal.unreal.messages.Percept	game() Information about the type of game being played, the map and the score required for winning the game.
Map<Method,Object>	getAllPercepts() Returns a previously prepared batch of percepts.
cz.cuni.amis.pogamut.ut2004.communication.messages.gbcommands.Initialize	getInitializeCommand() Prepares the initialization message for Gamebots using the BotParameters provided to the UT2004BotRunner.
void	initializeController(cz.cuni.amis.pogamut.ut2004.bot.impl.UT2004Bot bot)
protected void	initializeModules(cz.cuni.amis.pogamut.ut2004.bot.impl.UT2004Bot bot) Initialize projectiles and weaponshooting modules.
protected void	initializePathFinding(cz.cuni.amis.pogamut.ut2004.bot.impl.UT2004Bot bot) Initializes path-finding modules: UT2004BotModuleControllerNew#pathPlanner, UT2004BotModuleController.fwMap and UT2004BotModuleControllerNew#pathExecutor.
protected void	initializeWeaponShootings() Adds handlers to deal with different weapons.
Collection<nl.tudelft.goal.unreal.messages.Percept>	item() Description: Provides information items the bot sees in the world.
void	logic() The bot will evaluate its the logic every 100ms.
nl.tudelft.goal.unreal.messages.Percept	logicIteration() Deprecated.
void	look(SelectorList targets) Tells the bot how to prioritize what it looks at.
void	msgBotKilled(cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.BotKilled msg) Event listener for deaths of this bot.
void	msgPlayerKilled(cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.PlayerKilled msg) Event listener for deaths of other bots & players.
void	navigate(nl.tudelft.goal.unreal.messages.UnrealIdOrLocation destination) When called the bot will make a best effort attempt to navigate to requested destination.
nl.tudelft.goal.unreal.messages.Percept	navigation() Information about the state of the navigation.
Collection<nl.tudelft.goal.unreal.messages.Percept>	navPoint() Information about point in the map.
nl.tudelft.goal.unreal.messages.Percept	orientation() Information about the bot's position, rotation and velocity.
nl.tudelft.goal.unreal.messages.Percept	path(nl.tudelft.goal.unreal.messages.UnrealIdOrLocation from, nl.tudelft.goal.unreal.messages.UnrealIdOrLocation to) The bot computes a path from a to b.
Collection<nl.tudelft.goal.unreal.messages.Percept>	pickup() Information indicating at which navpoint weapons, ammo, and health can be found.
Collection<nl.tudelft.goal.unreal.messages.Percept>	powerup() Description: Percept provided when the bot picks up a powerup
void	prefer(WeaponPrefList weaponList) Tells the bot which weapon it should prefer.
void	respawn() When called the bot will respawn in at a random spawn point of its team.
nl.tudelft.goal.unreal.messages.Percept	score() Information about the number of kills, deaths, and suicides this bot accumulated.
nl.tudelft.goal.unreal.messages.Percept	self() Information about the bot's identity and team.
void	shoot(SelectorList targets) Tells the bot how to prioritize who it shoots.
void	skip() Does nothing.
nl.tudelft.goal.unreal.messages.Percept	slowvolume() Description: Percept provided when the bot see's a slow volume.
nl.tudelft.goal.unreal.messages.Percept	status() Information about the bot's current physical state.
void	stop() When called the bot will stop.
void	stopShooting() *
nl.tudelft.goal.unreal.messages.Percept	teamScore() Percept that provides information about the current state of the game.
Collection<nl.tudelft.goal.unreal.messages.Percept>	visiblePickup() Information indicating which pickup is visible.
Collection<nl.tudelft.goal.unreal.messages.Percept>	weapon() Information about weapons the bot has in its inventory.

Methods inherited from class cz.cuni.amis.pogamut.ut3.bot.impl.UT3BotModuleController

getBody, getConfig, getFwMap, getGame, getInfo, getItems, getMove, getNavBuilder, getNavigation, getPathExecutor, getPathPlanner, getPlayers, getRandom, getRaycasting, getSenses, getShoot, getVisibility, getWeaponPrefs, getWeaponry, getWorld, initializeListeners

Methods inherited from class cz.cuni.amis.pogamut.ut2004.bot.impl.UT2004BotLogicController

getLogicInitializeTime, getLogicShutdownTime, initializeLogic, logicInitialize, logicShutdown

Methods inherited from class cz.cuni.amis.pogamut.ut2004.bot.impl.UT2004BotController

botFirstSpawn, botInitialized, botKilled, botShutdown, getAct, getBot, getLog, getName, getPassword, getWorldView, prepareBot

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface cz.cuni.amis.pogamut.ut2004.bot.IUT2004BotController

botFirstSpawn, botInitialized, botKilled, botShutdown, getAct, getBot, getLog, getPassword, getWorldView, prepareBot

Field Detail

targetSelector

protected List<ContextSelector> targetSelector

lookSelector

protected List<ContextSelector> lookSelector

projectiles

protected nl.tudelft.pogamut.unreal.agent.module.sensor.Projectiles projectiles

weaponShooting

protected nl.tudelft.pogamut.unreal.agent.module.shooting.WeaponryShooting weaponShooting

lookFocus

protected nl.tudelft.pogamut.unreal.agent.module.shooting.util.FocusProvider lookFocus

focus

protected nl.tudelft.pogamut.unreal.agent.module.shooting.util.OrderedFocusProvider focus

percepts

protected eis.eis2java.util.AllPerceptsModule percepts

parameters

protected nl.tudelft.goal.unreal.messages.BotParameters parameters

Settings for the bot.

logicIteration

protected long logicIteration

actionCount

protected long actionCount

sfwMap

protected nl.tudelft.goal.unreal.floydwarshall.SharedFloydWarshallMap sfwMap

Path-planner (IPathPlanner using NavPoints), you may use it to find paths inside the environment wihtout waiting for round-trip of GetPath command and PathLists response from UT2004. It is much faster than UT2004BotModuleController.pathPlanner but you need to pass NavPoint instances to planner instead of ILocated ... to find the nearest NavPoint instance, DistanceUtils is a handy, check especially DistanceUtils.getNearest(java.util.Collection, ILocated).

Constructor Detail

UT3BotBehavior

public UT3BotBehavior()

Method Detail

initializeController

public void initializeController(cz.cuni.amis.pogamut.ut2004.bot.impl.UT2004Bot bot)

Specified by:

initializeController in interface cz.cuni.amis.pogamut.ut2004.bot.IUT2004BotController<cz.cuni.amis.pogamut.ut2004.bot.impl.UT2004Bot>

Overrides:

initializeController in class UT3BotModuleController<cz.cuni.amis.pogamut.ut2004.bot.impl.UT2004Bot>

initializeModules

protected void initializeModules(cz.cuni.amis.pogamut.ut2004.bot.impl.UT2004Bot bot)

Initialize projectiles and weaponshooting modules.

Overrides:

initializeModules in class UT3BotModuleController<cz.cuni.amis.pogamut.ut2004.bot.impl.UT2004Bot>

initializeWeaponShootings

protected void initializeWeaponShootings()

Adds handlers to deal with different weapons.

initializePathFinding

protected void initializePathFinding(cz.cuni.amis.pogamut.ut2004.bot.impl.UT2004Bot bot)

Initializes path-finding modules: UT2004BotModuleControllerNew#pathPlanner, UT2004BotModuleController.fwMap and UT2004BotModuleControllerNew#pathExecutor. If you need different path planner / path executor - override this method and initialize your own modules.

Overrides:

initializePathFinding in class UT3BotModuleController<cz.cuni.amis.pogamut.ut2004.bot.impl.UT2004Bot>

Parameters:

bot -

getInitializeCommand

public cz.cuni.amis.pogamut.ut2004.communication.messages.gbcommands.Initialize getInitializeCommand()

Prepares the initialization message for Gamebots using the BotParameters provided to the UT2004BotRunner.

Specified by:

getInitializeCommand in interface cz.cuni.amis.pogamut.ut2004.bot.IUT2004BotController<cz.cuni.amis.pogamut.ut2004.bot.impl.UT2004Bot>

Overrides:

getInitializeCommand in class cz.cuni.amis.pogamut.ut2004.bot.impl.UT2004BotController<cz.cuni.amis.pogamut.ut2004.bot.impl.UT2004Bot>

finishControllerInitialization

public void finishControllerInitialization()

Finish controller initialisation. Connects the weaponshooting to the navigation.

Specified by:

finishControllerInitialization in interface cz.cuni.amis.pogamut.ut2004.bot.IUT2004BotController<cz.cuni.amis.pogamut.ut2004.bot.impl.UT2004Bot>

Overrides:

finishControllerInitialization in class UT3BotModuleController<cz.cuni.amis.pogamut.ut2004.bot.impl.UT2004Bot>

beforeFirstLogic

public void beforeFirstLogic()

Called before the evaluation of the first logic. Use this to set up elements that need information about the world.

Specified by:

beforeFirstLogic in interface cz.cuni.amis.pogamut.base.agent.module.IAgentLogic<cz.cuni.amis.pogamut.base.agent.module.LogicModule>

Overrides:

beforeFirstLogic in class cz.cuni.amis.pogamut.ut2004.bot.impl.UT2004BotLogicController<cz.cuni.amis.pogamut.ut2004.bot.impl.UT2004Bot>

logic

public void logic()

The bot will evaluate its the logic every 100ms. In each evaluation it will do the following:

1. Execute all outstanding action.
2. Determine a target to shoot and look at. The target is determined by the first Selector in the list set by UT3BotBehavior#target(SelectorList) that returns a valid target.
3. Determine a target to look at. The target is determined by the first Selector in the list set by look(SelectorList) that returns a valid target.
4. Look at something
1. If we are navigating, navigation will ensure that we look at either our target or at the path ahead.
2. If we have a target to look at, we turn to that target.
3. If we don't have a target to look at, we turn around looking for a target.
5. Prepare a batch of percepts for the Environment.

Specified by:

logic in interface cz.cuni.amis.pogamut.base.agent.module.IAgentLogic<cz.cuni.amis.pogamut.base.agent.module.LogicModule>

Overrides:

logic in class cz.cuni.amis.pogamut.ut2004.bot.impl.UT2004BotLogicController<cz.cuni.amis.pogamut.ut2004.bot.impl.UT2004Bot>

addAction

public void addAction(nl.tudelft.goal.unreal.actions.Action action)
               throws InterruptedException

Queues up the action to be executed on the first evaluation of the logic cycle. When the queue is full, this action will block until the queue is free.

Parameters:

action -

Throws:

InterruptedException

getAllPercepts

public Map<Method,Object> getAllPercepts()

Returns a previously prepared batch of percepts.

Specified by:

getAllPercepts in interface eis.eis2java.util.AllPerceptsProvider

Returns:

a previously prepared batch of percepts.

navigate

public void navigate(nl.tudelft.goal.unreal.messages.UnrealIdOrLocation destination)
              throws InterruptedException

When called the bot will make a best effort attempt to navigate to requested destination. The destination either be a Location or the UnrealId of an ILocated such as NavPoint or Player. When provided with a player the bot will actively pursue the player provided the player remains visible. The destination is considered reached when the bot is within 50 UT units from the destination. Or 100 UT units when trying to navigate to a player. The navigation can fail when there is no path to the destination, when the bot gets stuck. A bot can be considered stuck by three heuristics. Either the UT2004DistanceStuckDetector when the bot has not be closing in on its target enough, UT2004PositionStuckDetector when it has not been moving at all, or the UT2004TimeStuckDetector when it has not moved enough over time. When the bot dies or respawns the navigation will reset to waiting.

Parameters:

destination - where the bot should go.

Throws:

InterruptedException

stop

public void stop()
          throws InterruptedException

When called the bot will stop. Navigation will reset to waiting.

Throws:

InterruptedException

respawn

public void respawn()
             throws InterruptedException

When called the bot will respawn in at a random spawn point of its team. When the bot respawns he will have 100 health, 0 adrenaline, 0 armor, a shield gun and an assault rifle with 100 bullets and 4 grenades. The navigating will be reset to waiting.

Throws:

InterruptedException

deploy

public void deploy()
            throws InterruptedException

Bot tries to deploy a deployable weapon.

Syntax: deploy

Will only work if the bot picked up a deployable weapon, the bot can't switch to another weapon while holding a deployable weapon.

Parameters:

location -

Throws:

InterruptedException

path

public nl.tudelft.goal.unreal.messages.Percept path(nl.tudelft.goal.unreal.messages.UnrealIdOrLocation from,
                                                    nl.tudelft.goal.unreal.messages.UnrealIdOrLocation to)

The bot computes a path from a to b.

Syntax: path(From,To)

• From: UnrealId of a nav point.
• To: UnrealId of a nav point.

The action results in a path percept containing the path from a to b.

Syntax: path(Length,[NavPointId])

• Length: Length of the path in UT units.
• NavPointId: A list of UnrealIds in the path.

Parameters:

from - the navpoint from which the path starts.

to - the navpoint where the path should go to

Returns:

the path between from and to, including the distance of the path.

shoot

public void shoot(SelectorList targets)
           throws InterruptedException

Tells the bot how to prioritize who it shoots.

Syntax: shoot([Selector])
Syntax: shoot(Selector)

• [Selector]: A list of selectors. A selector either selects a target from the list of visible players, provides a fixed location or selects nothing if no suitable target was available for selection. The bot evaluates each selector in order. The target provided by the first first selector to select a target will be shot at. Should no selector provide a valid target will be shot at. If no targets are selected the bot will stop shooting.
• Selector: A selector will select a target from the visible players. Can be, nearestEnemy, nearestFriendly, nearestFriendlyWithLinkGun, enemyFlagCarrier, friendlyFlagCarrier, a PlayerID or a location(X,Y,Z).

Note:

1. To stop shooting, use shoot([]) or stopShooting.
2. By default the bot will shoot the nearest visible enemy.

Throws:

InterruptedException

stopShooting

public void stopShooting()
                  throws InterruptedException

*

Tells the bot to stop shooting.

Syntax: stopShoot

Note: Executes shoot([])

Throws:

InterruptedException

prefer

public void prefer(WeaponPrefList weaponList)
            throws InterruptedException

Tells the bot which weapon it should prefer. The bot will select the first weapon from the list it can use. A weapon can be used when the bot has the and the ammo for it.

Syntax: prefer([weapon(WeaponId, FireMode)])
Syntax: prefer(weapon(WeaponId, FireMode))

• WeaponId: The id of the weapon.
• FireMode: How the bot should use the weapon, either primary or secondary.

Note: By Default the bot prefers the weapons in this order:

1. weapon(shock_rifle, secondary)
2. weapon(rocket_launcher, primary)
3. weapon(flack_cannon, primary)
4. weapon(sniper_rifle, primary)
5. weapon(lightning_gun, primary)
6. weapon(mini_gun, primary)
7. weapon(link_gun, primary)
8. weapon(bio_rifle, secondary)
9. weapon(assault_rifle, primary)
10. weapon(assault_rfile, secondary)
11. weapon(shield_gun, secondary)
12. weapon(shield_gun, primary)

Throws:

InterruptedException

look

public void look(SelectorList targets)
          throws InterruptedException

Tells the bot how to prioritize what it looks at.

Syntax: look([Selector])
Syntax: look(Selector)

• [Selector]: A list of selectors. A selector either selects a target from the list of visible players, provides a fixed location or selects nothing if no suitable target was available for selection. The bot evaluates each selector in order. The target provided by the first first selector to select a target will be shot at. Should no selector provide a valid target will be looked at. If no targets are selected the bot will slowly turn around.
• Selector: A selector will select a target from the visible players. Can be, nearestEnemy, nearestFriendly, nearestFriendlyWithLinkGun, enemyFlagCarrier, friendlyFlagCarrier, a PlayerID or a location(X,Y,Z).

Note:

1. To to start looking around, use look([]).
2. By default the bot will look at the nearest visible enemy.

Throws:

InterruptedException

skip

public void skip()

Does nothing.

Syntax: skip

logicIteration

@Deprecated
public nl.tudelft.goal.unreal.messages.Percept logicIteration()

Deprecated.

Information about iteration of the bots logic.

Type: On Change

Syntax: logic(Iteration)

• Iteration: The number of iterations of the bots logic so far.

Notes:

1. While the bot is capable of executing multiple actions in single logic iteration, it does not always make sense. Use this iteration to check if the bot is clear again.

actionCount

@Deprecated
public nl.tudelft.goal.unreal.messages.Percept actionCount()

Deprecated.

armor

public nl.tudelft.goal.unreal.messages.Percept armor()

self

public nl.tudelft.goal.unreal.messages.Percept self()

Information about the bot's identity and team.

Type: On Change

Syntax: self(UnrealId, NickName, Team)

• UnrealId: Unique identifier assigned by Unreal.
• NickName: Name as it appears in the game.
• Team: Either red, blue, or none.

orientation

public nl.tudelft.goal.unreal.messages.Percept orientation()

Information about the bot's position, rotation and velocity.

Type: On Change

Syntax: orientation(location(X,Y,Z), rotation(Pitch,Yaw,Roll), velocity(Vx, Vy,Vz))

• Location: the position in UT units.
• Rotation: the bots rotation in degrees.
• Velocity: the velocity in UT units per second.

status

public nl.tudelft.goal.unreal.messages.Percept status()

Information about the bot's current physical state.

Type: On Change

Syntax status(Health, Armour, Adrenaline,ActiveCombo)

• Health: A number between 0 and 199, indicating the health.
• Armour: A number between 0 and 150, indicating the armor.

score

public nl.tudelft.goal.unreal.messages.Percept score()

Information about the number of kills, deaths, and suicides this bot accumulated.

Type: On Change

Syntax: score(Kills, Deaths, Suicides)

• Kills: Number of people the bot fragged during this game.
• Deaths: Number of times the bot died during this game.
• Suicides: Number of times the bot got himself killed.

Note: Using the respawn action and being fragged by an opponent both count as a death. Being killed by the your own weapon counts as a suicide.

currentWeapon

public nl.tudelft.goal.unreal.messages.Percept currentWeapon()

Information about weapon the bot is currently holding.

Type: On Change

Syntax: currentWeapon(WeaponType,FireMode)

• WeaponType: Name of the weapon.
• FireMode: How the weapon is shooting. Either primary, secondary or none.

TODO: List available weapons.

weapon

public Collection<nl.tudelft.goal.unreal.messages.Percept> weapon()

Information about weapons the bot has in its inventory.

Type: On change

Syntax: weapon(WeaponType, PriAmmo, SecAmmo)

• WeaponType: Name of the weapon.
• PriAmmo: A number between 0 and the maximum for the weapon, indicating the available ammo for the primary fire mode.
• SecAmmo: A number between 0 and the maximum for the weapon, indicating the available ammo for the secondary fire mode.

TODO: List available weapons.

deployable

public Collection<nl.tudelft.goal.unreal.messages.Percept> deployable()

Information about the deployable the bot is currently holding.

Type: On change

Syntax: deployable(Name)

• Name: name of the deployable

Note: the bot can't switch weapons if it's holding a deployable weapon.

Returns:

msgBotKilled

public void msgBotKilled(cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.BotKilled msg)

Event listener for deaths of this bot.

Parameters:

msg -

msgPlayerKilled

public void msgPlayerKilled(cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.PlayerKilled msg)

Event listener for deaths of other bots & players.

Parameters:

msg -

fragged

public List<nl.tudelft.goal.unreal.messages.Percept> fragged()

This percept is provided when one bot is violently fragmented by another.

Type: Always

Syntax: fragged(Time,KillerID,VictemID,Weapon)

Notes:

1. When the killer and victim id are equal, the bot committed suicide.
2. When the killer is none, the bot respawned.

navigation

public nl.tudelft.goal.unreal.messages.Percept navigation()

Information about the state of the navigation. The available states are:

• navigating: The bot is traveling to its destination.
• stuck: The botcould not reach its destination.
• noPath: The bot could not find a path to its destination.
• reached: The bot has arrived at its destination.
• waiting: The bot is waiting for actions (initial state).

Type: On Change

Syntax: navigation(State,Destination)

• State: State of the navigation. Either navigating, stuck, noPath, reached or waiting.

navPoint

public Collection<nl.tudelft.goal.unreal.messages.Percept> navPoint()

Information about point in the map. Together these form a directed graph that spans the entire map.

Type: Once

Syntax: navPoint(UnrealID, location(X,Y,Z), [NeigsUnrealID])

1. UnrealID: The unique id of this navpoint.
2. Location: The location of this navpoint in the map.
3. [NeigsUnrealID]: A list of Id's for the neighbouring navpoints that are reachable from this navpoint.

*

visiblePickup

public Collection<nl.tudelft.goal.unreal.messages.Percept> visiblePickup()

Information indicating which pickup is visible.

Type: On change with negation

Syntax: pickup(UnrealID)

• UnrealID: The UnrealId of the nav point this pickup spot is placed on.

pickup

public Collection<nl.tudelft.goal.unreal.messages.Percept> pickup()

Information indicating at which navpoint weapons, ammo, and health can be found.

Type: Once

Syntax: pickup(UnrealID, Label, ItemType)

• UnrealID: The UnrealId of the nav point this pickup spot is placed on.
• Label: The category of the pickup.
• ItemType: The type of the of the item located on the pickup.

Notes:

1. Depending on the game setting "weapon stay", there may not always be a weapon present on a pick up point.
2. If "weapon stay" is enabled, a weapon can only be picked up if one of the same type is not present in the bots inventory yet.
3. TODO: A full overview of which category Label belongs to which item type.

base

public Collection<nl.tudelft.goal.unreal.messages.Percept> base()

Information about the location of the base. The opposing team will try to steal the flag from this location. Your team must deliver any capture flags to the base.

Type: Once

Syntax: base(Team, UnrealID)

• Team: Either red or blue.
• UnrealID: The UnrealId of the navpoint this flagbase is placed on.

game

public nl.tudelft.goal.unreal.messages.Percept game()

Information about the type of game being played, the map and the score required for winning the game.

Type: On Change

Syntax: game(Gametype, Map, TeamScoreLimit, RemainingTime)

• Gametype: The type of game being played.
• Map: The name of the map being played on.
• TeamScoreLimit: Score needed to win the match. If the score is zero or not reached by the end of the game, the team that has the highest score when the time limit is reached wins.
• RemainingTime: Time left in the game. If the score for both teams is a tie, it is possible to go into over time.

teamScore

public nl.tudelft.goal.unreal.messages.Percept teamScore()

Percept that provides information about the current state of the game.

Type: On change

Syntax: teamScore(TeamScore, OpponentTeamScore)

• TeamScore score of the team this bot is on.
• OpponentTeamScore score of the opponent team.

Notes

1. For CTF the score is the number of times the ag has been captured.
2. Once either team reaches the goal score from the Game- info percept, the game is over.

flagState

public Collection<nl.tudelft.goal.unreal.messages.Percept> flagState()

Description: Percept that provides information about the current state of the flag.

Type: On change with negation.

Syntax: flagState(Team,FlagState)

• Team: Either blue or red.
• FlagState: State of the flag. Either home, held or dropped.

Notes:

1. See also the flag percept

item

public Collection<nl.tudelft.goal.unreal.messages.Percept> item()

Description: Provides information items the bot sees in the world.

Type: On change with negation.

Syntax: item(UnrealID, Label, ItemType, NavPointId)

Syntax: item(UnrealID, Label, ItemType, location(X,Y,Z)) when dropped.

• UnrealID: The UnrealID of this item.
• Label: The category of the pick up.
• ItemType: The actual item type of the item located on the pickup.
• NavPointId: The UnrealId of the navpoint this item is placed when spawned.
• Location: location in the world when this item is dropped.

Notes:

1. TODO: A full over view of which category Label belongs to which item type.

flag

public Collection<nl.tudelft.goal.unreal.messages.Percept> flag()

Description: Percept provided when the flag is visible.

Type: On change with negation.

Syntax: flag(Team, UnrealId, location(X,Y,Z))

• Team: Either red or blue.
• UnrealId: The UnrealId of the player holding the flag, none when the flag is not held.
• Location: The location of the flag in the world.

Notes:

1. See also the flagStatus percept.

bot

public Collection<nl.tudelft.goal.unreal.messages.Percept> bot()

Percept provided when another bot becomes visible to this bot.

Type: On change with negation.

Syntax: bot(UnrealId, Team, location(X,Y,Z), Weapon, FireMode)

• UnrealId: Unique identifier for this bot assigned by Unreal.
• Team: Either red or blue.
• location(X,Y,Z): Location of the bot in the world.
• Weapon: The weapon the bot is holding. TODO: Any of the following:
• FireMode: Mode of shooting, either primary, secondary or none.

powerup

public Collection<nl.tudelft.goal.unreal.messages.Percept> powerup()

Description: Percept provided when the bot picks up a powerup

Type: On change

Syntax: powerup(Name, Time)

• Name: Name of the powerup
• Time: Time left on this powerup

slowvolume

public nl.tudelft.goal.unreal.messages.Percept slowvolume()

Description: Percept provided when the bot see's a slow volume.

Type: On change

Syntax: slowVolume([NavPoints])

• NavPoints: A list of all the navpoints lying in the volume