Factorio.com|Forums|Wiki|Mod Portal|API Docs

# Factorio Runtime Docs Version 2.0.77

# LuaCustomChartTag - Runtime Docs

## Class LuaCustomChartTag

A custom tag that shows on the map view.

## Members

destroy() |  | Destroys this tag.
Destroys this tag.
icon | :: RW SignalID? | This tag's icon, if it has one. [...]
This tag's icon, if it has one. [...]
last_user | :: R LuaPlayer| W PlayerIdentification? | The player who last edited this tag.
The player who last edited this tag.
position | :: RW MapPosition | The position of this tag.
The position of this tag.
text | :: RW string |
tag_number | :: R uint32 | The unique ID for this tag on this force.
The unique ID for this tag on this force.
force | :: R LuaForce | The force this tag belongs to.
The force this tag belongs to.
surface | :: RW LuaSurface | The surface this tag belongs to.
The surface this tag belongs to.
valid | :: R boolean | Is this object valid? [...]
Is this object valid? [...]
object_name | :: R string | The class name of this object. [...]
The class name of this object. [...]

## Methods

### destroy()

Destroys this tag.

## Attributes

### icon :: Read|Write SignalID?

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

### last_user :: Read LuaPlayer| Write PlayerIdentification?

The player who last edited this tag.

### position :: Read|Write MapPosition

The position of this tag.

### text :: Read|Write string

### tag_number :: Read uint32

The unique ID for this tag on this force.

### force :: Read LuaForce

The force this tag belongs to.

### surface :: Read|Write LuaSurface

The surface this tag belongs to.

### valid :: Read boolean

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

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.

Class used in

- LuaForce::add_chart_tag()
- LuaForce::find_chart_tags()
- RegistrationTarget
- on_chart_tag_added
- on_chart_tag_modified
- on_chart_tag_removed