Factorio API Docs

1.1.67 <>

Class LuaCustomChartTag

A custom tag that shows on the map view.

Destroys this tag.


help()
string

All methods and properties that this object supports.


[RW]

This tag's icon, if it has one.


:: LuaPlayer?
[RW]

The player who last edited this tag.


[R]

The position of this tag.


:: string
[RW]

:: uint
[R]

The unique ID for this tag on this force.


[R]

The force this tag belongs to.


[R]

The surface this tag belongs to.


:: boolean
[R]

Is this object valid?


:: string
[R]

The class name of this object.

Methods

destroy()

Destroys this tag.


help() → string

All methods and properties that this object supports.

Attributes

icon :: SignalID [Read/Write]

This tag's icon, if it has one. Writing nil removes it.


last_user :: LuaPlayer? [Read/Write]

The player who last edited this tag.


position :: MapPosition [Read]

The position of this tag.


text :: string [Read/Write]


tag_number :: uint [Read]

The unique ID for this tag on this force.


force :: LuaForce [Read]

The force this tag belongs to.


surface :: LuaSurface [Read]

The surface this tag belongs to.


valid :: boolean [Read]

Is this object valid? This Lua object holds a reference to an object within the game engine. It is possible that the game-engine object is removed whilst a mod still holds the corresponding Lua object. If that happens, the object becomes invalid, i.e. this attribute will be false. Mods are advised to check for object validity if any change to the game state might have occurred between the creation of the Lua object and its access.


object_name :: string [Read]

The class name of this object. Available even when valid is false. For LuaStruct objects it may also be suffixed with a dotted path to a member of the struct.

|<

Classes

Events

Concepts

Defines

Builtin types

>|