Struct LuaCustomChartTag 

pub struct LuaCustomChartTag;

A custom tag that shows on the map view.

Implementations

impl LuaCustomChartTag

pub fn force(&self) -> LuaForce

The force this tag belongs to.

pub fn icon(&self) -> SignalID

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

pub fn set_icon(&self, value: SignalID)

Set the icon attribute (Lua: self.icon = value).

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

pub fn last_user(&self) -> LuaPlayer

The player who last edited this tag.

pub fn set_last_user(&self, value: PlayerIdentification)

Set the last_user attribute (Lua: self.last_user = value).

The player who last edited this tag.

pub fn object_name(&self) -> &'static str

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.

pub fn position(&self) -> MapPosition

The position of this tag.

pub fn set_position(&self, value: MapPosition)

Set the position attribute (Lua: self.position = value).

The position of this tag.

pub fn surface(&self) -> LuaSurface

The surface this tag belongs to.

pub fn set_surface(&self, value: LuaSurface)

Set the surface attribute (Lua: self.surface = value).

The surface this tag belongs to.

pub fn tag_number(&self) -> u32

The unique ID for this tag on this force.

pub fn text(&self) -> &'static str

pub fn set_text(&self, value: &'static str)

Set the text attribute (Lua: self.text = value).

pub fn valid(&self) -> bool

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.

pub fn destroy(&self)

Destroys this tag.

Trait Implementations

impl Clone for LuaCustomChartTag

fn clone(&self) -> LuaCustomChartTag

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for LuaCustomChartTag

impl Debug for LuaCustomChartTag

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for LuaCustomChartTag

fn default() -> LuaCustomChartTag

Returns the “default value” for a type.

impl Eq for LuaCustomChartTag

impl From<LuaCustomChartTag> for LuaAny

fn from(_: LuaCustomChartTag) -> Self

Converts to this type from the input type.

impl From<LuaCustomChartTag> for RegistrationTarget

fn from(value: LuaCustomChartTag) -> Self

Converts to this type from the input type.

impl LuaObject for LuaCustomChartTag

impl PartialEq for LuaCustomChartTag

fn eq(&self, other: &LuaCustomChartTag) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for LuaCustomChartTag