View source for Scripting 018

This is a temporary page for documenting the scripting changes for release 018.

TODO:  FlagItem:getCaptureZone & FlagItem:getShip functions (verify w/ sam); make sure all items have getLoc, getRad, getVel, getTeamIndx, and isItem; hasFlag(); engineer-deploy-object (??), ship/bot:getMountedItems();  document libopt (or at least or inclusion of such with summary and pointer to docs) -- need to do require("getopt") to activate it.  mention inspect.lua under debugging section.

Server admins can program their own robots in addition to designing their own levels.  Robots are coded in Lua, and have a number of special functions available to them.  

For examples of fully functional bots, see the [[Robot_gallery|Robot Gallery]].  

Robot coding is still fluid, and the information here is subject to change.  You might want to read about the [[Script structure|general structure of Bitfighter scripts]] before proceeding.


How to read the function notation:

{{funcdoc|returnType|functionName|argType1, argType2|Description of function is here.  If the function returns no value, returnType will be omitted.}}


Return types:
Unlike most languages, Lua does not differentiate between integers and floating point numbers.  Instead, everything is simply a number.  In fact, Lua often will let you interchange strings and numbers, converting dynamically on an as-needed basis.  However, relying on this automatic type coercion is bad practice and can get you into trouble.

Some functions take or return special data types:

'''Point''' - A Point is an object that contains an x and a y coordinate.  When used as an argument in the functions below, in most cases you can replace a Point object with a pair of numbers representing the x and y coordinates.<p>
For example:
<source lang="lua">
local a = Asteroid.new()   -- Create a new asteroid object
local p = Point(110, 80)
a:setLoc(p)                -- Specify the asteroid's location
a:setLoc(110, 80)          -- Equivalent statement
</source>
In many cases, using the pair of points will perform slightly better because it avoids the step of constructing a Point object, but when choosing between the two, you should always prefer the one that produces clearer code.<p>


'''Geometry''' - Geometry is not itself an object, but rather a placeholder for a Point or a table of Points.  When dealing with objects that are inherently point-like, such as a TestItem or a CoreItem, Geometry is simply a single Point object (or a pair of coordinates as explained above).  In the context of a Zone or LineItem, Geometry is a Lua table of Points (or individual coordinates).<P>

Points to remember in Lua:
<ul>
<li>Lua arrays are 1-based: the first index is 1 rather than 0 as is the case in programming languages such as C++ and Java</li>
<li>Lua is case sensitive.  That means that the variable foo is different than Foo and FOO</li>
<li>Any variable not declared as local will be global.  Accessing global variables is slower than local ones, and being sloppy about variable scope can lead to unexpected problems.  Use the local keyword whenever appropriate.</li>
</ul>

We will follow the Lua formatting conventions used in the Programming in Lua book.

== Object Model ==
Starting with release 018, Bitfighter objects follow a true inheritance model -- that is, each object has a parent and may have one or more children.  Each object has the same methods as the parent, and may have one or more methods specific to the object.  For example, all objects that can appear in a game have a getLoc() method that returns   the object's position, but only objects that can move have getVel() method to return their speed.  Therefore, knowing understanding the object model is an important step towards discovering what methods an object implements.

The Bitfighter object model can be viewed by running Bitfighter with the -luadocs option.


'''The current Bitfighter object model:'''

 BfObject
 +----- Item
 |       +----- CoreItem
 |       +----- EngineeredItem
 |       |       +----- Turret
 |       |       +----- ForceFieldProjector
 |       +----- MoveObject
 |       |       +----- MoveItem
 |       |       |       +----- FlagItem
 |       |       |       +----- SoccerBallItem
 |       |       |       +----- HeatSeeker
 |       |       |       +----- Burst
 |       |       |       |       +----- SpyBugItem
 |       |       |       |       +----- MineItem
 |       |       |       +----- ResourceItem
 |       |       |       +----- TestItem
 |       |       |       +----- Circle
 |       |       |       +----- Asteroid
 |       |       +----- Ship
 |       |               +----- Robot
 |       +----- PickupItem
 |               +----- EnergyItem
 |               +----- RepairItem
 +----- Projectile
 +----- Teleporter
 +----- WallItem
 +----- Zone
         +----- LoadoutZone
         +----- NexusZone
         +----- GoalZone


=== BfObject ===
BfObjects are the granddaddy of all Bitfighter's game objects.  Any method defined here is available on all child objects unless specifically noted otherwise.

{{funcdoc|classId|getClassID||Get an object's class id.  See [[#ItemTypes|the ItemTypes section]] for a list of possible return values.}}
{{funcdoc||getLoc||Get an object's position.  Returns a Point object representing the object's current position.  For objects that are not points (such as a Loadout Zone), will return the object's centroid.}}
{{funcdoc||setLoc|Point|Set the object's location.}} 
{{funcdoc|int|getTeamIndx||Returns the index of the team this object is associated with.  See [[#Special team constants|Special team constants]] for details on how neutral and hostile teams are represented.}} 
{{funcdoc||setTeam|Team index|Assigns the object to a team.  Use the [[#Special team constants|special team constants]] to make an item neutral or hostile.  Will have no effect on items that are inherently teamless (such as a NexusZone).}} 
{{funcdoc||addToGame||Add the specified object to the current game or editor session.  A given item can only be added to a game once.  For most objects in a game, updating characteristics such as position will immediately be reflected in the game or editor.}}
{{funcdoc||removeFromGame||Removes the object from the game.  May not be implemented for all objects.}}
{{funcdoc|Geometry|getGeom||Returns an object's geometry.  For point objects, this will be a single Point.  For more complex objects (such as a WallItem or a Zone), will return a Lua table containing a list of Points.}}
{{funcdoc||setGeom|Geometry|Sets an object's geometry.  Note that not all objects support changing geometry if an object is in a game.}}
{{funcdoc|BfObject|clone||Returns an exact duplicate of an object.  If an object that is in a game is cloned, the copy will ''not'' be added to the game until it is explicitly added with the addToGame() method.}}

===Item===
:{{funcdoc|num|getRad||Returns the radius of the item in pixels.}}
:{{funcdoc|bool|isOnShip||Returns true if the Item is mounted on a ship, false otherwise.  Most Items cannot be mounted on ships.}}
:{{funcdoc|Ship|getShip||Returns the Ship the Item is mounted on.  If the Item is not mounted, returns nil.}}
:{{funcdoc|bool|isInCaptureZone||Returns true if the item is in a capture zone, false otherwise.  Currently, only Flags and SoccerBallItems can be in capture zones, and only in some games.  Always returns false for other Items.}}
:{{funcdoc|GoalZone|getCaptureZone||Returns the GoalZone in which the Item is captured.  If the Item is not captured, this function will return nil.}}

==== CoreItem ====
::CoreItems implement all BfObject methods, plus the following:
::{{funcdoc|num|getHealth||Returns total health of all panels on the core item.  There is currently no way to query the health of an individual panel.}}
::{{funcdoc||setHealth|num|Sets the overall health of all panels on the core item; Each panel will be given 1/10th the specified health.  Health of 1 is the same health a ship has, so to give each panel a health equivalent to a ship, do setHealth(10).}}

==== EngineeredItem ====
::{{funcdoc|bool|isActive||Returns true if the EngineeredItem is "alive" and active, or false if it is dead.}}
::{{funcdoc|num|getHealth||Returns health of the item.  Health is specified as a number between 0 and 1 where 0 is completely dead and 1 is totally healthy.}}
::{{funcdoc||setHealth|num|Set the current health of the item.  Health is specified as a number between 0 and 1 where 0 is completely dead and 1 is totally healthy.  Values outside this range will be clamped to the valid range.}}
::{{funcdoc|num|getMountAngle||Gets the angle (in radians) at which the EngineeredItem is mounted.}}

===== ForceFieldProjector =====
:::ForceFieldProjectors implement all the EngineeredItem methods.

===== Turret =====
:::Turrets implement all the EngineeredItem methods plus the following:
:::{{funcdoc|num|getAimAngle||Returns the angle (in radians) at which the Turret is aiming.}}
:::{{funcdoc||getAimAngle|num|Sets the angle (in radians) at which the Turret is aiming.}}

==== PickupItem ====
::PickupItems implement all the Item methods, plus the following:
::{{funcdoc|bool|isVis||Returns true if the PickupItem is currently visible to players and is available for pickup.}}
::{{funcdoc||setVis|bool|Sets whether the PickupItem is visible to players and is available for pickup.}}
::{{funcdoc||setRegenTime|num|Sets the time (in seconds) for the PickupItem to regenerate itself.  Default is 20 seconds.  Setting regen time to a negative number will produce an error.}}

===== EnergyItem =====
:::EnergyItems implement all the PickupItem methods.

===== RepairItem =====
:::RepairItems implement all the PickupItem methods.

=== Projectile ===
Implements all methods implemented by BfObjects, and also the following:
{{funcdoc|WeaponType|getWeapon||Returns the type of the projectile.  See [[#WeaponType constants|WeaponType constants]] for valid values.}}  
{{funcdoc|Point|getVel||Returns the projectile's velocity.}}
{{funcdoc||setVel|Point|Sets the projectile's velocity.}}


=== Teleporter ===
Teleporters, of course, teleport ships from one place to another.  Each Teleporter will have a single "intake", which is considered the Teleporter's location, and can be obtained with the getLoc() method.  Teleporters must have at least one "outlet" (or destination), but could have several.  

Teleporters implement all BfObject methods, plus the following:<br>

{{funcdoc||addDest|Point|Add a destination to the teleporter.}}
{{funcdoc||delDest|int|Remove the specified destination from the teleporter.  Remember, in Lua, indices start with 1, so to remove the first destination, do tel:delDest(1)  If you specify an invalid index, an error will be generated.}}
{{funcdoc||clearDests||Remove all destinations from the teleporter.  Teleporter will not be displayed if it has no destinations.}}
{{funcdoc|Point|getDest|int|Retrieves the specified destination.  Remember that the first destination will have an index of 1.  Specifying an invalid index will generate an error.}}
{{funcdoc|int|getDest||Returns the number of destinations the teleporter has.}}

=== Zone ===
Zones are invisible objects, used mainly for generating events.  Zones implement all BfObject methods.

==== GoalZone ====
Implements all Zone methods, plus the following:<br>
{{funcdoc|bool|hasFlag||Returns true if the GoalZone has a flag, false otherwise.  Always returns false in games where GoalZones don't hold flags (e.g. Soccer).}}

==== NexusZone ====
Implements all Zone methods, plus those listed below.<br>
Note that the following methods act as passthroughs to the underlying Game object, and as such, will affect '''ALL''' NexusZones in the game.  They are provided as object methods because that seems more intuitive, though this may change in the future.
{{funcdoc||setOpen|bool|Pass true to open the Nexus, false to close it.}}
{{funcdoc|bool|isOpen||Returns true if the Nexus is open, false if not.}}
{{funcdoc||setOpenTime|num|Set the time (in seconds) that the Nexus will remain open.  Pass 0 if the Nexus should never close.}}
{{funcdoc||setClosedTime|num|Set the time (in seconds) that the Nexus will remain closed.  Pass 0 if the Nexus should never reopen.}}

==== LoadoutZone ====
Implements all Zone methods.

== Events ==
Lua robots are designed to respond to many in-game events using event handlers.  To respond to an event your bot must have an appropriately named function (described below), and must subscribe to any events it is interested in.  You can also unsubscribe to an event at any time to stop receiving event notifications.

==== Currently defined events ====
<table border=1px cellpadding=3px>
<tr><th>Event ID</th><th>Associated function</th><th>Description</th></tr>
<tr><td>TickEvent</td><td>onTick(timeSinceLastTickInMs)</td><td>Called every frame of the game.  Unlike other events, robots are subscribed to this event by default.</td>
<tr><td>ShipSpawnedEvent</td><td>onShipSpawned(ship)</td><td>Called when any ship or robot spawns (not including your robot).  Spawning ship is passed as the first argument.</td></tr>
<tr><td>ShipKilledEvent</td><td>onShipKilled(ship)</td><td>Called when any ship or robot is killed (not including your robot).  Dead ship is passed as the first argument.</td></tr>
<tr><td>MsgReceivedEvent</td><td>onMsgReceived(message, senderPlayerInfo, global)</td><td>Called when a player or robot sends a message.  Message itself is first argument, a PlayerInfo for the sender is the second argument, and the third argument is a boolean that will be true if the message was global, false if sent to teammates only.  Note that senderPlayerInfo can be nil if message is sent by a Controller script.</td></tr>
<tr><td>PlayerJoinedEvent</td><td>onPlayerJoined(playerInfo)</td><td>Called when a player or robot joins the game (not when they spawn).  Note that when hosting a game locally, local player does not necessarily trigger this event due to the uncertain order of creation of game objects.  First argument is playerInfo for the joining player.</td></tr>
<tr><td>PlayerLeftEvent</td><td>onPlayerLeft(playerInfo)</td><td>Called when a player or robot leaves the game.  Note that event may not be fired when robots or local player leaves game due to server shutting down.  First argument is playerInfo for the leaving player.</td></tr>
<tr><td>NexusOpenedEvent</td><td>onNexusOpened()</td><td>Called when Nexus opens in a Nexus game.  Never fires in other game types.</td></tr>
<tr><td>NexusClosedEvent</td><td>onNexusClosed()</td><td>Called when Nexus closes in a Nexus game.  Never fires in other game types.</td></tr>
</table>

Example:
<source lang="lua">
function main()
   ...
   subscribe(ShipSpawnedEvent)    -- Subscribe so onShipSpawned() will be called
   ...
end

-- Since we are subscribed to the ShipSpawned event, the onShipSpawned() function 
-- will be called whever a ship or robot spawns.
function onShipSpawned(ship)
   logprint("Ship spawned: ".. tostring(ship:getLoc()))
   angle = bot:getLoc():angleTo(ship:getLoc())
   logprint("angle to spawned ship = "..angle)
end
</source>


Example:
<source lang="lua">
-- Keep track of all players/robots in the game.  This may be more efficient than
-- reading the list every time it is needed if it is used frequently.

function main()
   ...
   subscribe(PlayerJoinedEvent)
   subscribe(PlayerLeftEvent)
   ...
   
   players = GameInfo():getPlayers()    -- Vars defined in main() will be global
end


function onPlayerJoined()
   players = GameInfo():getPlayers()    -- Player joined: get updated player list
end


function onPlayerLeft()
   players = GameInfo():getPlayers()    -- Player left: get updated player list
end


</source>


You can also use timers and events to create a basic sleep function:
<source lang="lua">
function sleep(time)                                  -- Sleep time in ms
   unsubscribe(TickEvent)                             -- Stop getting tick events until...
   Timer:scheduleOnce("subscribe(TickEvent)", time)   -- ...we resubscribe!
end
</source>

== Navigation, configuration, and combat ==

There are two general methods for getting the current game time:<br> 
{{funcdoc|number|getTime|}} -Returns time for this frame, in ms.<br>
{{funcdoc|number|getCPUTime|}} Returns number representing the CPU time in ms.  Can be used to time events<br>
 

These functions will return slightly different results.  Generally speaking, if you are timing things in the "real world", i.e. you want to pause for exactly 1 second, use getCPUTime().  If you want to use a timer to make the robot move smoothly around a mathematically derived course, use getTime(), as that is what is used internally when calculating ship movement.

Example:
<source lang="lua">
lastTime = thisTime
thisTime = bot:getCPUTime()
local delta = thisTime - lastTime
logprint(delta .. " ms have elapsed in the real world since last frame.")
</source>

Example:
<source lang="lua">
-- Will fly robot in a circular orbit around an item.
-- Assume we've already found one and stored it in "item"

local botLoc = bot:getLoc()
local itemLoc = item:getLoc()

local dist = botLoc:distanceTo(itemLoc)

-- For this example, we'll define orbitRadius as a local variable.  In a
-- real robot, this might be better declared a global variable in the header. 
local orbitRadius = 300    

-- Here we use the getTime() function to make the motion look smooth.
-- If we just advanced orbitAng by a fixed amount each frame, it would
-- appear jerky, as each frame represents a slightly different length in time.

-- .0015 determined experimentally

orbitAng = orbitAng + .0015 * bot:getTime()  -- orbitAng is a global variable

local dest = nil
if(dist <= orbitRadius * 1.1) then 
    dest = itemLoc
    dest:setxy(itemLoc:x() + orbitRadius * math.cos(orbitAng),
               itemLoc:y() + orbitRadius * math.sin(orbitAng) )
else
    dest = itemLoc
end

bot:setThrustToPt(dest)         -- Travel towards calculated point
</source>


{{funcdoc|Point|getZoneCenter|x, y}} Return point representing center of zone containing point x,y<br>
{{funcdoc|Point|getGatewayFromZoneToZone|a, b}} Return point representing fastest way from zone a to zone b.  If zones a & b are not neighbors, returns nil<br>
{{funcdoc|number|getZoneCount|}} Return number of zones<br>
{{funcdoc|number|getCurrentZone|}} Return current zone that robot is in<br>
<br>
{{funcdoc|number|getAngle|}} Return angle robot is currently facing<br>
{{funcdoc|Point|getLoc|}} Return point representing location of robot<br>
{{funcdoc|number|getTeamIndx|}} Return index of robot's team<br>
{{funcdoc|void|setAngle|ang}} Point robot at angle<br>
{{funcdoc|void|setAngle|pt}} Point robot toward point pt<br>

Example:
<source lang="lua">

-- This code in onTick()

    local items = bot:findItems(AsteroidType)  -- Get list of all asteroids
    local asteroid = findClosest(items)     -- Finds closest

    if(asteroid == nil) then                -- Make sure we found one
        return
    end

    local loc = bot:getLoc()                -- Our location (Point object)
    local ang = loc:angleTo( asteroid:getLoc() )
    bot:setAngle(ang)                       -- Aim ship toward asteroid 
    bot:fire()
</source>


{{funcdoc|void|setAnglePt|Point}} Point robot towards Point<br>
{{funcdoc|number|getAnglePt|Point}} Compute angle to Point<br>
{{funcdoc|boolean|hasLosPt|Point}} Return whether or not robot can see Point<br>
{{funcdoc|boolean|hasLosPt|x, y}} Return whether or not robot can see point x,y<br>
{{funcdoc|number|getFiringSolution|item}} Calculate angle at which robot needs to fire to hit moving or stationary object.  Will return nil if the item is out of range, behind an obstacle, or firing will hit a friendly ship.  Always check the return value for nil!<br>

Example:
<source lang="lua">

    local loc = bot:getLoc()                                -- Current location
    local items = bot:findGlobalItems(SoccerBallItemType)   -- Find soccerball

   
    -- Loop through all returned items and find the closest
    -- This code here for learning purposes... could be replaced with
    -- much simpler single line:
    -- local ball = findClosest(items)

    local minDist = 99999999
    local ball = nil
    
    for sb in values(items) do
        local l = sb:getLoc()           -- Ball's location
        
        -- Distance from ship to ball (use distSquared because
        -- it is easy to compute and good for comparison)
        local d = loc:distSquared(l)    
                
        if(d < minDist) then
           ball = sb
           minDist = d
        end
    end
    -- End replaceable code section

    -- Check to make sure we found a soccer ball ... could be out of view
    if(ball == nil) then
        return
    end
   
    
    local ang = bot:getFiringSolution(sb)   -- Get shoot angle to hit moving ball
   
    -- Always check for nil: could happen if ball were behind a wall or 
    -- friendly ship.  Running setAngle(nil) will do nothing.
    if(ang == nil) then
        return
    end
    
    bot:setAngle(ang)    -- Ready... aim...
    bot:fire()           --  ...fire!

</source>
<br>
{{funcdoc|number|getTeamIndx|}} Return index of team this robot is on<br>
{{funcdoc|boolean|hasFlag|}} Return whether or not robot currently has the flag<br>
<br>
<br>
{{funcdoc|WeaponType|getActiveWeapon|}} Return currently selected weapon<br>
Example:
<source lang="lua">
weap = bot:getActiveWeapon()    -- Get info about our currently active weapon
weapInfo = WeaponInfo(weap)     -- Get information about it   
logprint(weapInfo:getName() .. " has a range of " .. weapInfo:getRange())
</source>


Modules are automatically disabled at the end of each game cycle.  Therefore, if you want to keep a module on for a sustained period of time, you must activate it each time onTick() is called.  To activate a module, use one of the activateModule() commands.

{{funcdoc|void|activateModule|ModuleType}} Activate module, specified by ModuleType.  If specified module is not included in the current loadout, this command will have no effect.
Example:
<source lang="lua">
-- Note that this line will do nothing if we don't have shields
bot:activateModule(ModuleShield)    -- Shields up!
</source>

{{funcdoc|void|activateModuleIndex|indx}} Activate module, specified by its index (1 or 2)<br>
Example:
<source lang="lua">
-- Must specify an index, currently either 1 or 2
bot:activateModuleIndex(1)          -- Activate first module, whatever it is
</source>

{{funcdoc|void|setReqLoadout|Loadout}} Set the requested loadout to Loadout<br>
{{funcdoc|Loadout|getCurrLoadout|}} Returns current loadout<br>
Example:
<source lang="lua">
loadout = bot:getCurrLoadout()       -- Retrieve current bot configuration

weapType1 = loadout:getWeapon(1)     -- Get the first weapon
weapType2 = loadout:getWeapon(2)     -- Get the second weapon
weapType3 = loadout:getWeapon(3)     -- Get the third weapon

-- Check to see if the first weapon is a phaser
if (weapType1 == WeaponPhaser) then
   logprint("First weapon is a phaser!")
end

-- Print a list of our three current weapons
logprint("My three weapons are: " .. WeaponInfo(weapType1):getName() .. ", "
                                  .. WeaponInfo(weapType2):getName() .. ", and "
                                  .. WeaponInfo(weapType3):getName())
</source>


{{funcdoc|Loadout|getReqLoadout|}} Returns requested loadout<br>


<br>
<u>Navigation</u><br>
<br>
{{funcdoc|[Item list]|findItems|ObjectType,  ...}} Return a list of items of the specified type or types that are within the robot's viewable area<br>
{{funcdoc|[Item list]|findGlobalItems|ObjectType,  ...}} Return a list of items of the specified type or types that are anywhere in the game.  Note that items that would ordinarily be out of scope will <i>not</i> be included in this list!<br>

Example:

<source lang="lua">
-- Find all resource items in the normal viewport
local items = bot:findItems(ResourceItemType)                   

-- You can specify multiple item types if you want
-- Get a list of all TestItems or Asteroids that are visible anywhere
-- (note that items that are out-of-scope will be omitted)
local globItems = bot:findGlobalItems(TestItemType, AsteroidType)  

-- Now iterate over the list ... there are many examples in the documentation!
for item in values(globItems) do
    -- Do something with item ... perhaps figure out which is closest, 
    -- which is heading towards us, etc.
end
</source>


{{funcdoc|Point|getWaypoint|Point}}<br>
{{funcdoc|Point|getWaypoint|x, y}}<br>
<br>
<br>
<u>Ship control</u><br>
{{funcdoc|void|setThrust|vel, angle}} Set robot's velocity to vel (0-1), at angle<br>
{{funcdoc|void|setThrustPt|vel, Point}} Set robot's velocity to vel (0-1), toward Point. <br>
<br>
{{funcdoc|void|setThrustToPt|Point}} Thrust toward Point, but adjust speed in an attempt to land right on point, and not overshoot.  If Point is distant, setThrustToPt() will cause robot to go at full speed.<br>
<br>
{{funcdoc|void|fire|}} Fires active weapon<br>
{{funcdoc|void|setWeaponIndex|index}} Activates weapon with index (1, 2, 3)<br>
{{funcdoc|void|setWeapon|WeaponType}} Activates weapon type specified (does nothing if WeaponType is not in current loadout)<br>
{{funcdoc|boolean|hasWeapon |WeaponType}} Does current configuration have specified weapon<br>

Example:
<source lang="lua">
if(bot:hasWeapon(WeaponMine)) then
    bot:setWeapon(WeaponMine)      -- Make mine layer active if it's 
                                   --     part of our current loadout
    bot:fire()                     -- Lay a mine
end
</source>

==Logging & Sending Messages==
{{funcdoc|void|globalMsg|msg}} Send a message to all players<br>
{{funcdoc|void|teamMsg|msg}} Send a message to players on the same team<br>
<br>
{{funcdoc|void|logprint|msg}} Print msg to game logfile and to game console<br>

When sending a team or global message, some basic variable substitutions are available.  %playerName% will be replaced with the receiving player's name.  %controlName% will be replaced with the appropriate key binding on the receiving player's machine.  A full list of controlNames can be found in the KeyBinding section of the bitfighter.ini file.  Examples include %SelWeapon1% and %ShowScoreboard%.  While this capability is also available to player manually typing chat messages, it is mostly intended for tutorial bots to help the player along.  Variable names are case insensitive.

== GameItems ==

The Lua object structure generally follows that used by Bitfighter.  The GameItems group conisists of Ships, Robots, RepairItems, Asteroids, ResourceItems, SoccerBallItems, Flags, NexusFlags, and TestItems.  These all share similar properties, and have similar methods.  All of these implement the getLoc(), getVel(), and getRad() methods for querying location, velocity, and radius respectively.  Some items have additional methods that apply only to them.  See below for details on these additional methods.


=== Ships & Robots ===

Unless otherwise noted, all of these methods will work both on a ShipItem object as well as the local bot object.

{{funcdoc|boolean|isAlive|}} Returns true if ship/bot is still alive, false otherwise.

Rather than checking isAlive() every tick, it may be more efficient to keep track of dying ships by subscribing to ShipKilledEvent.

Example:
<source lang="lua">
-- Assuming we've subscribed to ShipKilledEvent, and that target is a global
function onShipKilled(ship)
   if target == ship then
      target = nil   -- check for target == nil elsewhere and reacquire a target
   end
end
</source >


Note: All of the following functions will return nil if they are called on a dead ship.  When in doubt, check for nil!

{{funcdoc|Point|getLoc|}}  Return center of item<br>
{{funcdoc|number|getRad|}}  Return radius of item<br>
{{funcdoc|Point|getVel|}}  Return speed of item<br>
{{funcdoc|number|getAngle|}} Returns angle ship is currently facing<br>
{{funcdoc|number|getTeamIndx|}} Index of the team this ship/robot is on<br>

{{funcdoc|PlayerInfo|getPlayerInfo|}} Return info about player or robot controlling the ship<br>

The following two methods return a number between 0 and 1 where 1 means full health or energy, 0 means no health or energy.

{{funcdoc|number|getHealth|}} Return health of the ship or robot<br>
{{funcdoc|number|getEnergy|}} Return energy of ship or robot<br>

{{funcdoc|boolean|isModuleActive|ModuleType}} Returns true if specified module is active<br>
{{funcdoc|boolean|hasFlag|}} Returns true if ship is carrying a flag, false otherwise<br>
{{funcdoc|number|getFlagCount|}} Returns number of flags a ship is carrying.  Currently, ships can only have more than one flag in Nexus games<br>
{{funcdoc|void|dropItem|}} Drops any items the bot may be holding<br>


{{funcdoc|WeaponType|getActiveWeapon|}} Returns the active weapon constant (see WeaponType constants)<br>

=== CoreItems, ResourceItems, SoccerBallItems, and TestItems === 
These items all have the same methods and behave in a very similar manner. 
Category: GameItem<br>
<br>
{{funcdoc|Point|getLoc|}}  Return center of item<br>
{{funcdoc|number|getRad|}}  Return radius of item<br>
{{funcdoc|Point|getVel|}} Return velocity of item<br>
{{funcdoc|number|getTeamIndx|}} Returns index of items's team (will always be NeutralTeamIndx)<br>

The coordinates of ResourceItems and TestItems can simply be passed to their constructors:
<source lang="lua">
local testItem1 = TestItem.new(100,200)
local testItem2 = TestItem.new(point.new(100,200))

local resourceItem1 = ResourceItem.new(200,100)
local resourceItem2 = ResourceItem.new(point.new(200,100))
</source>

CoreItems have one additional method:<br>
{{funcdoc|number|getHealth|}}  Return item's health<br>

Example: 
<source lang="lua">
local items = bot:findItems(TestItemType)  -- Find all TestItems in view

-- Now cycle through all returned items and find the fastest one
local maxSpeed = -1
local fastest = nil

for indx, ti in ipairs(items) do
    -- getVel() returns a point representing the x and y components of
    -- the velocity.  Need to use len() to get actual speed.  Or, in this
    -- case, since actual speed isn't important, we can use lenSquared()
    -- which is less computationally intensive, and will yield perfectly
    -- good results for comparison purposes (such as finding the fastest).
    spd = ti:getVel():lenSquared()  

    if(spd > maxSpeed) then
        fastest = ti
        maxSpeed = spd 
    end
end

-- Better check to make sure fastest isn't nil before using it!
-- Could be nil if there are no TestItems in view

if(fastest != nil) then
   -- Do something
end

</source>

=== Asteroids ===
Category: GameItem<br>
<br>
{{funcdoc|Point|getLoc|}} Return center of asteroid<br>
{{funcdoc|number|getRad|}} Return radius of asteroid<br>
{{funcdoc|Point|getVel|}} Return velocity of asteroid<br>
{{funcdoc|number|getTeamIndx|}} Returns asteroid's team index (will always be NeutralTeamIndx)<br>
{{funcdoc|number|getSize|}} Index of current asteroid size (0 = initial size, 1 = next smaller, 2 =  ...)<br>
{{funcdoc|number|getSizeCount|}} Number of indexes of size we can have<br>

Example: 
<source lang="lua">
local asteroids = bot:findItems(AsteroidType) 
local target = asteroids[1]:getLoc()  -- Pick first asteroid
</source>

=== RepairItems ===
Category: GameItem<br>
<br>
{{funcdoc|Point|getLoc|}} Return center of repairItem<br>
{{funcdoc|number|getRad|}} Return radius of repairItem<br>
{{funcdoc|Point|getVel|}} Return velocity of repairItem (usually 0,0)<br>
{{funcdoc|number|getTeamIndx|}} Returns repairItems's team index (will always be NeutralTeamIndx)<br>
{{funcdoc|boolean|isVis|}} Is repairItem currently visible?<br>

Example:
<source lang="lua">
local ri = bot:findItems(RepairItemType)   -- Get list of all known RepairItems  
local pos = ri[1]:getLoc()                 -- Get position of first
</source>

=== Flags ===
Category: GameItem<br>
<br>
{{funcdoc|Point|getLoc|}} Return location of flag<br>
{{funcdoc|number|getRad|}} Return radius of flag<br>
{{funcdoc|Point|getVel|}} Return velocity of flag<br>
{{funcdoc|number|getTeamIndx|}} Get index of owning team (-1 for neutral flag)<br>
{{funcdoc|boolean|isInInitLoc|}} Is flag in it's initial location?<br>
{{funcdoc|boolean|inCaptureZone|}} Is flag in a team's capture zone?<br>
{{funcdoc|boolean|isOnShip|}} Is flag being carried by a ship?<br>

=== Turrets and ForceFieldProjectors ===
Category: GameItem<br>

{{funcdoc|Point|getLoc|}} Return location of NexusFlag<br>
{{funcdoc|number|getRad|}} Return radius of NexusFlag<br>
{{funcdoc|Point|getVel|}} Return velocity of NexusFlag<br>
{{funcdoc|number|getTeamIndx|}} Get index of owning team (see Special Team Constants)<br>
{{funcdoc|number|getHealth|}} Get health of item (1 = full heath, 0 = totally dead)<br>
{{funcdoc|boolean|isActive|}} True if item is active, false otherwise<br>

=== GoalZones and LoadoutZones ===
{{funcdoc|Point|getLoc|}} Get the centroid of the zone<br>
{{funcdoc|number|getRad|}} Returns 0<br>
{{funcdoc|Point|getVel|}} Get the velocity of the item (will usually be (0,0)!)<br>
{{funcdoc|number|getTeamIndx|}} Get index of owning team (see Special Team Constants)<br>

=== Nexus Related ===
The following functions only have meaning in a Nexus game.

{{funcdoc|number|getNexusTimeLeft|}} Return time left until next change of the nexus open/closed status (in ms)<br>
{{funcdoc|boolean|isNexusOpen|}} Returns true if nexus is open, false if closed<br>

Example:
<source lang="lua">
if isNexusOpen() then
   local timeLeft = getNexusTimeLeft() / 1000
   if timeLeft < 10 then
      teamMsg("Hurry! Nexus closes in "  ..  timeLeft .. " seconds!")
   end
end
</source>

=== Bullets, Mines, and SpyBugs ===
Category: GameItem<br>
There are three GameItem types that have to do with bullets, mines, and spybugs: BulletType, MineType, and SpyBugType respectively.  They all have the same methods, and can be used somewhat interchangeably, as shown in the example below.  However, as shown, they can also be found independently.
<p>
BulletType encompases Phaseser, Bounce, Triple, Burst, and Turret shots, the properties of which can be retrieved with the WeaponInfo object.
<br><br>

{{funcdoc|Point|getLoc|}} Return location of item<br>
{{funcdoc|number|getRad|}} Return radius of item<br>
{{funcdoc|Point|getVel|}} Return velocity of item<br>
{{funcdoc|number|getTeamIndx|}} Get the team of the shooter/layer of the item<br>
{{funcdoc|WeaponType|getWeapon|}} Return WeaponType for this item<br>

Example:
<source lang="lua">
local bullets = bot:findItems(BulletType, MineType, SpyBugType) 

<some code>    -- Code here to select one of the found items

local weap = selectedBullet:getWeapon()
local weapInfo = WeaponInfo(weap)
logprint("Selected "  ..  weapInfo:getName())
</source>

== Weapon Information ==
All WeaponInfo data will remain constant throughout the game.  Therefore, if you need some information about a weapon (mines, say, for a minesweeping bot), it might make sense to retrieve it in the bot's main() function, and store it in a global variable rather than instantiating a new WeaponInfo object during every iteration of the robot's onTick() method.

Example:
<source lang="lua">
local weap = bot:getActiveWeapon()      -- Get bot's currently active weapon
logprint(weap:getName() .. " shoots with a speed of " .. weap:getProjVel())
</source>

<source lang="lua">
-- In main()... we'd better not declare these variables as local!
function main()
   ...
   turretInfo = WeaponInfo(WeaponTurret)   -- Get info about the infernal turrets
   safeDist = turretInfo:getRange()        -- Be safe and stay this far away 
   ...
end
</source>



{{funcdoc|string|getName|}} Name of weapon ("Phaser", "Triple", etc.)<br>
{{funcdoc|WeaponType|getID|}} ID of module (WeaponPhaser, WeaponTriple, etc.)<br>
{{funcdoc|number|getRange|}} Get range of weapon (units)<br>
{{funcdoc|number|getFireDelay|}} Delay between shots in ms<br>
{{funcdoc|number|getMinEnergy|}} Minimum energy needed to use<br>
{{funcdoc|number|getEnergyDrain|}} Amount of energy weapon consumes<br>
{{funcdoc|number|getProjVel|}} Speed of projectile (units/sec)<br>
{{funcdoc|number|getProjLife|}} Time projectile will live (ms) -1 == live forever)<br>
{{funcdoc|number|getDamage|}} Damage projectile does (0-1, where 1 = total destruction)<br>
{{funcdoc|number|getDamageSelf|}} Damage if shooter shoots self (0-1, where 1 = total destruction)<br>
{{funcdoc|boolean|getCanDamageTeammate|}} Will weapon damage teammates?<br>

== WeaponType constants ==
Commands that return a WeaponType will return one of the following values:
<table width=100%>
<tr><td width=50%><b>WeaponPhaser</b></td><td><b>WeaponBounce</b></td></tr>
<tr><td><b>WeaponTriple</b></td><td><b>WeaponBurst</b></td></tr>
<tr><td><b>WeaponMine</b></td><td><b>WeaponSpyBug</b></td></tr>
<tr><td><b>WeaponTurret</b></td><td></td></tr>
</table>

== Module Information ==
All ModuleInfo data will remain constant throughout the game. Therefore, if you need some information about a module (for example, the energy consmption of shields), it might make sense to retrieve it in the bot's main() function, and store it in a global variable rather than instantiating a new ModuleInfo object during every iteration of the robot's onTick() method. 

Example:

<source lang="lua">
local mod = ModuleInfo(ModuleBoost)
logprint("This is a lame example!")</source>

{{funcdoc|string|getName|}} Name of module ("Shield", "Turbo", etc.)<br>
{{funcdoc|ModuleType|getID|}} ID of module (ModuleShield, ModuleBoost, etc.)<br>

== ModuleType constants ==
Functions that return a ModuleType will return one of the following values:
<table width = 100%>
<tr><td width=50%><b>ModuleShield</b></td><td><b>ModuleBoost</b></td></tr>
<tr><td><b>ModuleSensor</b></td><td><b>ModuleRepair</b></td></tr>
<tr><td><b>ModuleCloak</b></td><td><b>ModuleEngineer</b></td></tr>
<tr><td><b>ModuleArmor</b></td></tr>
</table>

== Loadouts ==
{{funcdoc|void|setWeapon|index, WeaponType}} Set weapon at index<br>
{{funcdoc|void|setModule|index, ModuleType}} Set module at index<br>
{{funcdoc|WeaponType|getWeapon|index}} Return weapon at index<br>
{{funcdoc|ModuleType|getModule|index}} Return module at index<br>

Example:
<source lang="lua">
-- Get a new loadout (comes pre-filled with default values)
local loadout = Loadout()

-- Configure the loadout to suit our needs
loadout:setWeapon(1, WeaponPhaser)
loadout:setWeapon(2, WeaponBurst)
loadout:setWeapon(3, WeaponMine)
loadout:setModule(1, ModuleShield)
loadout:setModule(2, ModuleCloak)

-- Set the loadout, will become active when bot hits loadout zone
-- or spawns, depending on game
bot:setReqLoadout(loadout)     

if(loadout:getWeapon(1) == WeaponPhaser) then
   logprintf("This line always gets printed!")
end
</source>



{{funcdoc|boolean|isValid|}} Is loadout config valid?<br>
{{funcdoc|boolean|equals|Loadout}} is loadout the same as Loadout?<br>

== GameInfo ==

You can get information about the current game with the GameInfo object. You only need get this object once, then you can use it as often as you like.  It will always reflect the latest data. 
<br>
Example:
<source lang="lua">
game = GameInfo()           -- Create the GameInfo object 
gameType = game:getGameType()

if(gameType == SoccerGame) then
   logprint("This bot is not very good at soccer!")
else
   gameTypeName = game:getGameTypeName()
   logprintf("I just love playing " .. gameTypeName .. "!")   
end
</source>

Example:
<source lang="lua">
-- Create the GameInfo object in main() (don't declare it local!!)
function main()
   ...
   game = GameInfo()    -- In main non-local variables become globals
   ...
end
 ...

-- Even though we only create our GameInfo once, it is always current

 ...

-- Later, in onTick():
local remTime = game:getGameTimeReamaining()
local totTime = game:getGameTimeTotal()
local percent = (totTime - remTime) / remTime
logprint("Game is " .. percent .. "% over)
</source>

{{funcdoc|GameType |getGameType|}} Return current game typet) <br>
{{funcdoc|string|getGameTypeName|}} Return current game type <br>
{{funcdoc|number|getFlagCount|}} Return the number of flags in the game<br>
{{funcdoc|number|getWinningScore|}} Returns the score required to win the level<br>
{{funcdoc|number|getGameTimeTotal|}} Returns the time (in seconds) that the level will be played for<br>
{{funcdoc|number|getGameTimeRemaining|}} Returns the time remaining (in seconds) for this level<br>
{{funcdoc|number|getLeadingScore|}} Gets score of the leading team<br>
{{funcdoc|number|getLeadingTeam|}} Gets index of leading team<br>
{{funcdoc|number|getTeamCount|}} Return number of teams<br>

Example:
<source lang="lua">
-- Create the GameInfo object main() (don't declare it local!!)
function main()
   ...
   game = GameInfo()    -- In main non-local variables become globals
   ...
end

-- Then later, in onTick() or other function
...
local leadingTeam = game:getLeadingTeam()
local team = TeamInfo(leadingTeam)
bot:teamMsg("Hurry up! Team " .. team:getName() .. " is winning!" )
</source>

{{funcdoc|PlayerInfo list|getPlayers|}} Return a list of PlayerInfo objects representing all players/bots in the game<br>

Example:
<source lang="lua">
players = GameInfo():getPlayers()
for player in values(players) do
   if player:isRobot() then
      logprint(player:getName().." is a bot!")
   else
      logprint("Hello "..player:getName())
   end
end
</source>

{{funcdoc|string|getLevelName|}} Gets the level's name<br>
{{funcdoc|number|getGridSize|}} Gets the level's gridSize parameter<br>
{{funcdoc|boolean|getIsTeamGame|}} Is this a team game?<br>
<br>
{{funcdoc|void|getEventScore|ScoringEvent}} Gets score awarded for ScoringEvent<br>


== GameType constants ==
Functions that return a GameType will return one of the following values:
<table width=100%>
<tr><td width=50%><b>BitmatchGame</b></td><td><b>CoreGame</b></td></tr>
<tr><td><b>CTFGame</b></td><td><b>HTFGame</b></td></tr>
<tr><td><b>NexusGame</b></td><td><b>RabbitGame</b></td></tr>
<tr><td><b>RetrieveGame</b></td><td><b>SoccerGame</b></td></tr>
<tr><td><b>ZoneControlGame</b></td></tr>
</table>

== ScoringEvent constants ==
Functions that return a ScoringEvent will return one of the following values:
<table width=100%>
<tr><td width=50%><b>KillEnemy</b></td><td><b>KillSelf</b></td></tr>
<tr><td><b>KillTeammate</b></td><td><b>KillEnemyTurret</b></td></tr>
<tr><td><b>KillOwnTurret</b></td><td><b>CaptureFlag</b></td></tr>
<tr><td><b>CaptureZone</b></td><td><b>UncaptureZone</b></td></tr>
<tr><td><b>HoldFlagInZone</b></td><td><b>RemoveFlagFromEnemyZone</b></td></tr>
<tr><td><b>RabbitHoldsFlag</b></td><td><b>RabbitKilled</b></td></tr>
<tr><td><b>RabbitKills</b></td><td><b>ReturnFlagsToNexus</b></td></tr>
<tr><td><b>ReturnFlagToZone</b></td><td><b>LostFlag</b></td></tr>
<tr><td><b>ReturnTeamFlag</b></td><td><b>ScoreGoalEnemyTeam</b></td></tr>
<tr><td><b>ScoreGoalHostileTeam</b></td><td><b>ScoreGoalOwnTeam</b></td></tr>
</table>

== TeamInfo ==
{{funcdoc|string|getName|}} return team name<br>
{{funcdoc|number|getIndex|}} return team's index, index of first team is 1<br>
{{funcdoc|number|getPlayerCount|}} return player count<br>
{{funcdoc|number|getScore|}} return team score<br>
{{funcdoc|PlayerInfo list|getPlayers|}} Return a list of PlayerInfo objects representing all players/bots on the team<br>

Example:
<source lang="lua">
local gameInfo = GameInfo()
local teams = gameInfo:getTeamCount()

-- Note that while the number of teams will not change throughout the game,
-- the number of players on each team might.  Also, the robot may be initialized
-- before the players have been added, so if you run this code in the bot header, 
-- it may report some teams having 0 players.

for i = 1, teams do        -- First team has an index of 1
   team = TeamInfo(i)
   logprint("Team " .. i .. " is called " .. team:getName() .. 
      " and has " .. team:getPlayerCount() .. " players")
end
</source>

=== Special team constants ===
Two special team constants are available to make your programs simpler and easier to read.  In addition to the normal player teams, Bitfighter has two pseudo teams, "Neutral" and "Hostile".  These constants can be used to identify those teams:

<b>NeutralTeamIndx</b> - Neutral team<br>
<b>HostileTeamIndx</b> - Hostile team<br>

Example:
<source lang="lua">
team = turret:getTeamIndx()
if team == NeutralTeamIndx then        -- Neutral - can be repaired
   mode = repair
else if team == HostileTeamIndx then   -- Hostile - must be destroyed!
   mode = attack 
end
</source>

== PlayerInfo ==
Provides information about a player or robot.  The PlayerInfo object will remain valid and will contain current information as long as the player is in the game.<br><br>
string <b>getName()</b> - return player's name<br>
Ship <b>getShip()</b> - return player's ship (note: can be nil)<br>
string <b>getScriptName()</b> - for robots, returns name of script; for players, returns nil<br>
number <b>getTeamIndx()</b> - return team's index, index of first team is 1<br>
number <b>getRating()</b> - return player's rating<br>
number <b>getScore()</b> - return player's score<br>
boolean <b>isRobot()</b> - returns true if the PlayerInfo is a robot, false if it is a human<br>

== Timers ==
Timer is a utility class that makes it easier to manage timing periodic or delayed events.   The timer code is based on a very nice library written by Haywood Slap

A timer object that can be used to schedule arbitrary events to be executed
at some time in the future.  All times are given in milliseconds.

=== Usage ===

There are four basic timer functions:
<source lang="lua">
-- Execute the event once in 'delay' ms
Timer:scheduleOnce(event, delay

-- Execute the event repeatedly, every 'delay' ms
Timer:scheduleRepeating(event, delay)  
      
-- Execute the event every 'delay' ms while event returns true
Timer:scheduleRepeatWhileTrue(event, delay)  

-- Remove all pending events from the timer's queue
Timer:clear()                                
</source>

=== Timer Events ===

The 'event' used can either be the name a function, a table that contains
a function named 'run', or a bit of arbitrary Lua code.

Any Lua function can be called by the Timer.

Examples:
<source lang="lua">
function onLevelStart()
   -- Compiles and runs string in five seconds. 
   -- Note that the string here is in quotes.
   Timer:scheduleOnce("logprint(\"Once!\")", 5000)   

   -- Runs the always function every 30 seconds
   Timer:scheduleRepeating(always, 30000)            

   -- Runs "run" method of maybe every two seconds
   -- until method returns false
   Timer:scheduleRepeatWhileTrue(maybe, 2000)        
end                                                  

-- Standard function
function always()
   logprint("Timer called always")
end

-- Table: run method will be called
maybe = {
   count = 3
   run = function(self)
      logprint("Count down " .. self.count)
      self.count = self.count - 1
      return self.count > 0
   end
}
</source>

When using a table as an 'event' the first parameter to the run
function should always be a parameter named "self" (or "this"
if you prefer).  The "self" parameter can be used to access the
other fields in the table, that is, the "self" parameter will refer
to the table that contains the run function.  If you do not need to
refer to any of the other fields in the table then you do not need
to include the self parameter.

== Points ==

Point is a utility class to make handling coordinates or vectors simpler.  You can create your own point objects using the constructor, or you can get them as return values from many functions.

{{funcdoc|Point|Point|x, y}} Create a new Point object with coordinates x, y.  You do not need to use setxy() unless you want to change the coords later.<br>

{{funcdoc|number|x|}} Return x value<br>
{{funcdoc|number|y|}} Return y value<br>

{{funcdoc|void|setxy|x, y}} Update coordinates of point<br>
{{funcdoc|void|setx|x}} Update x coordinate of point<br>
{{funcdoc|void|sety|y}} Update y coordinate of point<br>
{{funcdoc|void|setAngle|ang}} Set angle of point to <i>ang</i>.  This will preserve the point's current length, and can can be used in conjunction with normalize to set a point via polar coordinates<br>
{{funcdoc|void|setPolar|r, ang}} Set point using polar coordinates, r = distance from origin, ang = angle<br>

{{funcdoc|number|len|}} Returns the length of the point, useful if point represents a velocity or other vector<br>
{{funcdoc|number|lenSquared|}} Returns the length squared of the point, useful if point represents a velocity or other vector, and you want a less computationally expensive representation of length that will work for comparative purposes<br>
{{funcdoc|boolean|equals|Point}} Returns true if the point is the same as Point<br>
{{funcdoc|void|normalize|length}} If Point represents a vector, set its length to <i>length</i>
{{funcdoc|number|distanceTo|Point}} Returns distance from point to Point<br>
{{funcdoc|number|distSquared|Point}} Returns distance squared from point to Point (less computationally intensive, good for comparison)<br> 
{{funcdoc|number|angleTo|Point}} Returns angle from point to Point<br>
{{funcdoc|number|angleTo|x, y}} Returns angle from point to point(x, y)<br>

Example:
<source lang="lua">
local point = Point(0, 0)      -- Create a new point

if point:equals(Point(1, 1)) then       
   logprint("This never gets printed")      
end

if point:distanceTo(Point(1, 1)) < 5 then       
   logprint("This always gets printed")      
end

-- Same thing, but with a little less overhead
if point:distanceTo(1, 1) < 5 then       
   logprint("So does this, but more efficiently")      
end


-- Here we'll use a point to represent a velocity, which has x & y components
local xspeed = 10
local yspeed = 15
local velocity = Point(xspeed, yspeed)
logprint("Speed = " .. velocity:len())
</source>

== ItemTypes ==
Functions that return an ItemType will return one of the following values:

<b>ShipType</b><br>
<b>RobotType</b><br>
<b>BulletType</b><br>
<b>MineType</b><br>
<b>SpyBugType</b><br>
<b>RobotType</b><br>
<b>TeleportType</b> (not yet fully implemented)<br>
<b>SpeedZoneType</b> (not yet fully implemented)<br>
<b>AsteroidType</b><br>
<b>CoreType</b><br>
<b>TurretType</b><br>
<b>ForceFieldProjectorType</b><br>
<b>TestItemType</b><br>
<b>FlagType</b><br>
<b>SoccerBallItemType</b><br>
<b>ResourceItemType</b><br>

== Things that are not really items ==
<u>Polygonal-like</u><br>
<b>BotNavMeshZoneType</b><br>
<b>NexusType</b><br>
<b>GoalZoneType</b><br>
<b>LoadoutZoneType</b><br>

<u>Wall-like</u><br>
<b>BarrierType</b>
<b>ForceFieldType</b><br>

== Helper functions ==
{{funcdoc|item|findClosest|(list of items [, teamIndx]}} Finds item closest to bot.  If teamIndx is specified, only considers items on team.  If list is empty (or there are no team items in the list), funtion returns nil.