Bitfighter
021
The Bitfighter Lua Documentation - Robots, Levelgens, and Plugins
|
Member Functions | |
Mine() | |
Constructor. | |
Mine(pos) | |
Constructor. | |
getAngle() | |
Get the items's angle in radians. [details] | |
getCaptureZone() | |
Returns capture zone holding the item. [details] | |
getGeom() | |
Returns an object's geometry. [details] | |
getId() | |
Gets an object's user assigned id. [details] | |
getObjType() | |
Gets an object's ObjType. [details] | |
getOwner() | |
Gets an object's owner as a PlayerInfo. [details] | |
getPos() | |
Gets an object's position. [details] | |
getRad() | |
Returns the radius of an item. [details] | |
getShip() | |
Returns the ship where the item is mounted. [details] | |
getTeamIndex() | |
Gets the index of the object's team. [details] | |
getVel() | |
Get the items's velocity. [details] | |
getWeapon() | |
isInCaptureZone() | |
Is item in a capture zone? [details] | |
isSelected() | |
Determine if an object is selected in the editor. [details] | |
removeFromGame() | |
Removes the object from the current game or editor session. [details] | |
setAngle(angle) | |
Sets the item's rotation angle. [details] | |
setGeom(geometry) | |
Sets an object's geometry. [details] | |
setId(id) | |
Sets an object's user assigned id. [details] | |
setOwner(playerName) | |
Sets the owner of the object. [details] | |
setPos(pos) | |
Set the object's position. [details] | |
setSelected(selected) | |
Set whether an object is selected in the editor. [details] | |
setTeam(teamIndex) | |
Assigns the object to a team. [details] | |
setVel(vel) | |
Sets the item's velocity. [details] | |
returns Mine |
|
inherited from MoveObject |
Get the items's angle in radians.
|
inherited from Item |
|
inherited from BfObject |
Returns an object's geometry.
|
inherited from BfObject |
Gets an object's user assigned id.
Users can assign an id to elements in the editor with the ! or # keys. Use this function to obtain this id. If the user has not assigned an object an id, getId() will return a negative id that will remain consistent throught the game.
|
inherited from BfObject |
Gets an object's ObjType.
See ObjType for a list of possible return values.
|
inherited from BfObject |
Gets an object's owner as a PlayerInfo.
Some objects (like projectiles) have an owning player associated. This method returns a PlayerInfo object if there is an owner. Otherwise, returns nil.
This method is intended to be used with bullets and other projectiles, not with game objects like zones.
|
inherited from BfObject |
Gets an object's position.
For objects that are not points (such as a LoadoutZone), will return the object's centroid.
|
inherited from Item |
Returns the radius of an item.
|
inherited from Item |
Returns the ship where the item is mounted.
Most objects cannot be mounted. For those, this function will always return nil.
|
inherited from BfObject |
Gets the index of the object's team.
Many BfObjects (such as TestItems) are never part of any particular team. For these objects, this method will return Team.Neutral
.
|
inherited from MoveObject |
Get the items's velocity.
|
inherited from Burst |
|
inherited from Item |
Is item in a capture zone?
true
if item is held in a capture zone, false
if it is not.
|
inherited from BfObject |
Determine if an object is selected in the editor.
This is useful for editor plugins only.
true
if the object is selected, false
if not.
|
inherited from BfObject |
Removes the object from the current game or editor session.
May not be implemented for all objects.
|
inherited from MoveObject |
Sets the item's rotation angle.
Set the rotation angle (in radians) of this MoveObject
angle | A rotation angle in radians |
|
inherited from BfObject |
Sets an object's geometry.
geometry | The object's new geometry. |
Note that not all objects support changing geometry if the object has already been added to a game.
|
inherited from BfObject |
Sets an object's user assigned id.
Users can assign an id to elements in the editor with the ! or # keys. Use this function to set this id from Lua. When called from an editor plugin, the value passed will be displayed in the editor when the player presses ! or #.
|
inherited from BfObject |
Sets the owner of the object.
playerName | Name of player as a string. |
This method is intended to be used with bullets and other projectiles, not with game objects like zones.
|
inherited from BfObject |
Set the object's position.
To set the full geometry of a more complex object, see the setGeom() method.
pos | The new position of the object. |
|
inherited from BfObject |
Set whether an object is selected in the editor.
This is useful for editor plugins only.
selected | true to select the object, false to deselect it. |
|
inherited from BfObject |
Assigns the object to a team.
teamIndex | Index of the team the object should be assigned to. (first team index is 1; there is no team 0) |
Instead of a team index, you can use the special team enums Team.Neutral
and Team.Hostile
.
Limitations:
|
inherited from MoveObject |
Sets the item's velocity.
As with other functions that take a point as an input, you can also specify the x and y components as numeric arguments.
vel | A point representing item's velocity. |