Bitfighter: RepairItem Class Reference

Returns capture zone holding the item.

Many games do not feature capture zones. For those games, this function will always return nil. Currently only FlagItems can be captured.

Returns: Zone where the item has been captured. Returns nil if the item is not in a capture zone.

◆ getGeom()

returns Geom

Returns an object's geometry.

Returns: A geometry as described on the Geom page

◆ getId()

returns int

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.

Returns: The object's id.

◆ getObjType()

returns ObjType

Gets an object's ObjType.

obj = TestItem.new()

print(obj:getObjType() == ObjType.TestItem) -- prints 'true'

BfObject::getObjType

ObjType getObjType()

Gets an object's ObjType.

Definition: BfObject__cpp.h:9

TestItem

Large bouncy ball type item.

Definition: moveObject__cpp.h:41

See ObjType for a list of possible return values.

Returns: The object's ObjType.

◆ getOwner()

returns PlayerInfo

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.

Returns: A PlayerInfo representing the object's owner, or nil.

◆ getPos()

returns point

Gets an object's position.

For objects that are not points (such as a LoadoutZone), will return the object's centroid.

Returns: A Point representing the object's position.

◆ getRad()

returns num

Returns the radius of an item.

Returns: The radius of the item. For a Teleporter, this is the radius of the entrance. For a ForceFieldProjector, this is the radius of the base.

◆ getRegenTime()

returns int

Returns the time (in seconds) for the PickupItem to regenerate itself.

Returns: Time in seconds for the item will remain hidden.

◆ getShip()

returns Ship

Returns the ship where the item is mounted.

Most objects cannot be mounted. For those, this function will always return nil.

Returns: Ship where the item is mounted. Returns nil if the item is not mounted.

◆ getTeamIndex()

returns int

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.

Note: Remember that in Lua, indices start with 1!

Returns: Team index of the object.

◆ isInCaptureZone()

returns bool

Is item in a capture zone?

Returns: true if item is held in a capture zone, false if it is not.

◆ isSelected()

returns bool

Determine if an object is selected in the editor.

This is useful for editor plugins only.

Returns: Returns true if the object is selected, false if not.

◆ isVis()

returns bool

Returns: true if item is currently visible, false if not.

◆ removeFromGame()

returns nothing

Removes the object from the current game or editor session.

May not be implemented for all objects.

◆ setGeom(geometry)

Arg types: geometry: Geom | returns nothing

Sets an object's geometry.

Parameters

geometry The object's new geometry.

Note that not all objects support changing geometry if the object has already been added to a game.

◆ setId(id)

Arg types: id: int | returns nothing

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 #.

◆ setOwner(playerName)

Arg types: playerName: string | returns nothing

Sets the owner of the object.

Parameters

playerName Name of player as a string.

Note: This method only works if the item in question has already been added to the game via addItem(object). The owner cannot be set beforehand. Also, 'playerName' must exactly match a the name of a player already in the game (case-sensitive).

This method is intended to be used with bullets and other projectiles, not with game objects like zones.

◆ setPos(pos)

Arg types: pos: point | returns nothing

Set the object's position.

To set the full geometry of a more complex object, see the setGeom() method.

Parameters

pos	The new position of the object.

◆ setRegenTime(time)

Arg types: time: int | returns nothing

Sets the time (in seconds) for the PickupItem to regenerate itself. Default is 20 seconds. Setting regen time to a negative value will produce an error.

Parameters

time	Time in seconds for the item to remain hidden.

◆ setSelected(selected)

Arg types: selected: bool | returns nothing

Set whether an object is selected in the editor.

This is useful for editor plugins only.

Parameters

selected true to select the object, false to deselect it.

◆ setTeam(teamIndex)

Arg types: teamIndex: int | returns nothing

Assigns the object to a team.

Parameters

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:

Will have no effect on items that are inherently teamless (such as a NexusZone).
Neither Ships nor Robots can be assigned to Team.Neutral or Team.Hostile.

◆ setVis(visible)

Arg types: visible: bool | returns nothing