LuaCustomChartTag

A custom tag that shows on the map view.

Attributes

icon

• Read: SignalID
• Write: SignalID
• Optional: true

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

last_user

• Read: LuaPlayer
• Write: PlayerIdentification
• Optional: true

The player who last edited this tag.

position

• Read: MapPosition
• Write: MapPosition
• Optional: false

The position of this tag.

text

• Read: string
• Write: string
• Optional: false

tag_number

• Read: uint32
• Write: unknown
• Optional: false

The unique ID for this tag on this force.

force

• Read: LuaForce
• Write: unknown
• Optional: false

The force this tag belongs to.

surface

• Read: LuaSurface
• Write: LuaSurface
• Optional: false

The surface this tag belongs to.

valid

• Read: boolean
• Write: unknown
• Optional: false

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

• Read: string
• Write: unknown
• Optional: false

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.

Methods

destroy

LuaCustomChartTag.destroy()

Call As

customChartTag.destroy()

Call Convention

• takes_table: false
• table_optional: false

Destroys this tag.