Show / Hide Table of Contents

Class TagDefinition

Tag definition which contains additional attributes for tag. May be used by Mods to configure tags for displaying in different sections or filters.

Inheritance
System.Object
TagDefinition
Namespace: Eco.Gameplay.Items
Assembly: Eco.Gameplay.dll
Syntax
public class TagDefinition : Object

Constructors

TagDefinition(String)

Declaration
public TagDefinition(string name)
Parameters
Type Name Description
System.String name

Properties

All

Contains mapping for all tag definitions. Where key is the lowercase tag name and value is TagDefinition itself.

Declaration
public static Dictionary<string, TagDefinition> All { get; }
Property Value
Type Description
System.Collections.Generic.Dictionary<System.String, TagDefinition>

AutoHighlight

If the tag should be auto highlighted (i.e. in chat).

Declaration
public bool AutoHighlight { get; set; }
Property Value
Type Description
System.Boolean

Hidden

Declaration
public bool Hidden { get; set; }
Property Value
Type Description
System.Boolean

Name

Tag name.

Declaration
public string Name { get; }
Property Value
Type Description
System.String

PluralName

Declaration
public LocString PluralName { get; set; }
Property Value
Type Description
LocString

ShowInEcopedia

If the tag should be shown in Ecopedia.

Declaration
public bool ShowInEcopedia { get; set; }
Property Value
Type Description
System.Boolean

ShowInFilter

If the tag should be should in filters.

Declaration
public bool ShowInFilter { get; set; }
Property Value
Type Description
System.Boolean

ShowInStore

If the tag should be shown as a selectable entry in store item/tag selectors.

Declaration
public bool ShowInStore { get; set; }
Property Value
Type Description
System.Boolean

Methods

Register(TagDefinition)

Registers new TagDefinition.

Declaration
public static void Register(TagDefinition tagDefinition)
Parameters
Type Name Description
TagDefinition tagDefinition

Extension Methods

TagUtils.TagNames(Object, Boolean)
TagUtils.TagDisplayNames(Object, Boolean)
ClientSetViewExtensions.SetClassOfProperty(Object, Player, String, String, Int32)
TypeTooltipExtensions.UILinkGeneric(Object)
☀
☾
In This Article
Back to top
Copyright (c) Strange Loop Games 2021
☀
☾