BerryBots Lua API

• Index

Ship / Stage Modules

• Admin
• DebugGfx
• Sensors
• Ship
• ShipControl
• StageBuilder
• StageControl
• StageSensors
• World

Game Runner Modules

• MatchRunner
• RunnerControl
• RunnerFiles
• RunnerForm

Helpful Links

• Lua 5.1 Manual
• Lua-users Tutorial Directory
• Sample Ships
• Sample Stages
• BerryBots Game Specs
• BerryBots Wiki

Module ShipControl

The API to be implemented by a ship control program. Defines the behavior of a ship or a team of ships.

Functions

gameOver ()	(optional) Indicates the game has ended.
init (ships, world, gfx)	Initializes a ship control program.
roundOver ()	(optional) Indicates a round has ended.
run (enemyShips, sensors)	Executes ship control code each tick.

Tables

EnemyShip

Information about an enemy ship that's visible to the ships controlled by this program.

Functions

gameOver ()

(optional) Indicates the game has ended. Called by the stage on the final tick of the game. No further action can be taken in the game world, but data can be printed about the match, or if file system access has been enabled, data could be written to disk.

init (ships, world, gfx)

Initializes a ship control program. Passes references to ships and world objects. These can be used to query information about the state of the game world, information about ships under this program's control, and to issue commands to those ships. Only called once at the start of the match. Some ship initialization functions, like setName, can only be called from init.

Parameters

• ships: A userdata object representing a ship, or if team size > 1, a table of ship userdata objects.
• world: A userdata object used to query information about the game world, such as stage size, locations of walls and zones, and current time.
• gfx: A userdata object used to draw debug graphics on the screen. Graphics are hidden unless the user checks the checkbox in the output console for this ship/team.

See also:

• Ship
• World
• DebugGfx

roundOver ()

(optional) Indicates a round has ended. Called by the stage each time a round ends. The meaning of this depends on the stage. In the sample battle stage library, it is called between a fixed number of rounds, but not after the last round when gameOver is called. Other game types could have a variable number of rounds.

run (enemyShips, sensors)

Executes ship control code each tick. Called once per tick to give the program a chance to process information about the game and issue commands to its ship(s). Only called if one or more of the ships controlled by this program are still alive.

Parameters

• enemyShips: A table with information about the enemy ships that are visible to the ships controlled by this program. Each entry is a table with information about an enemy ship.
• sensors: A userdata object that can be queried for information on events that involved this program's ships on the previous tick.

See also:

• EnemyShip
• Sensors

Tables

EnemyShip

Information about an enemy ship that's visible to the ships controlled by this program.

Fields:

• x: The x coordinate (higher is to the right).
• y: The y coordinate (higher is to the top).
• heading: Angle the enemy ship is traveling, in radians (0 is east, pi / 2 is north).
• speed: Speed at which the enemy ship is traveling.
• energy: Amount of energy the enemy ship has.
• isStageShip: Whether the ship was loaded by the stage.
• name: Name of the enemy ship.
• teamName: Name of the enemy ship's team.