LineItem Class Reference

Decorative line visible to one or all teams. Has no specific game function.

Inheritance diagram for LineItem:

Member Functions
	LineItem()
	Constructor.
	LineItem(lineGeom)
	Constructor. [details]
	LineItem(lineGeom, teamIndex)
	Constructor. [details]
	getGeom()
	Returns an object's geometry. [details]
	getGlobal()
	Returns the LineItem's global parameter. [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]
	getTeamIndex()
	Gets the index of the object's team. [details]
	isSelected()
	Determine if an object is selected in the editor. [details]
	removeFromGame()
	Removes the object from the current game or editor session. [details]
	setGeom(geometry)
	Sets an object's geometry. [details]
	setGlobal(global)
	Sets the LineItem's global parameter. [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]

Detailed Description

Decorative line visible to one or all teams. Has no specific game function.

If a non-global LineItem is assigned to a team, it will only be visible to players on that team. If the LineItem is neutral (that is, team == Team.Neutral, the default), it will be visible to all players regardless of team or globalness.

Geometry

The geometry of a LineItem is a polyline (i.e. 2 or more points)

Constructor Documentation

LineItem.new()[1/3]

returns LineItem

Constructor.

Example:

lineitem = LineItem.new()
...
levelgen:addItem(lineitem)

LineItem.new(lineGeom)[2/3]

Arg types: lineGeom: Geom  |  returns LineItem

Constructor.

Example:

lineitem = LineItem.new(lineGeom)
...
levelgen:addItem(lineitem)

LineItem.new(lineGeom, teamIndex)[3/3]

Arg types: lineGeom: Geom, teamIndex: int  |  returns LineItem

Constructor.

Example:

lineitem = LineItem.new(lineGeom, teamIndex)
...
levelgen:addItem(lineitem)

Member Function Documentation

getGeom()

returns Geom

inherited from BfObject

Returns an object's geometry.

Returns

A geometry as described on the Geom page

getGlobal()

returns bool

Returns the LineItem's global parameter.

Returns

true if global is enabled, false if not.

getId()

returns int

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.

Returns

The object's id.

getObjType()

returns ObjType

inherited from BfObject

Gets an object's ObjType.

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

See ObjType for a list of possible return values.

Returns

The object's ObjType.

getOwner()

returns PlayerInfo

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.

Returns

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

getPos()

returns point

inherited from BfObject

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.

getTeamIndex()

returns int

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.

Note

Remember that in Lua, indices start with 1!

Returns

Team index of the object.

isSelected()

returns bool

inherited from BfObject

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.

removeFromGame()

returns nothing

inherited from BfObject

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

inherited from BfObject

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.

setGlobal(global)

Arg types: global: bool  |  returns nothing

Sets the LineItem's global parameter.

LineItems are normally viewable by all players in a game. If you wish to only let the LineItem be viewable to the owning team, set to false. You must call setTeam() on the LineItem before using this method. Global is true by default.

Parameters

global

false if this LineItem should be viewable only by the owning team; 'true' makes it viewable by all teams.

setId(id)

Arg types: id: int  |  returns nothing

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

setOwner(playerName)

Arg types: playerName: string  |  returns nothing

inherited from BfObject

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

inherited from BfObject

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.

setSelected(selected)

Arg types: selected: bool  |  returns nothing

inherited from BfObject

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

inherited from BfObject

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.