Version:

Home Commands Examples Getting Started With Scripts Global Keywords

ExpandBlockTag ExpandEntityTypeTag ExpandFluidTagForge ExpandItemTag ExpandManyBlockTag ExpandManyEntityTypeTag ExpandManyFluidTagForge ExpandManyItemTag MCTag

BracketDumpers BracketHandlers BracketValidators ResourceLocationBracketHandler

KnownTag<T : Object>

A known tag is a tag whose element is known and has been registered as Taggable.

Known tags let you use the actual element to interact with the tag instead of using the registry key of the element

Importing the class

It might be required for you to import the package if you encounter any issues (like casting an Array), so better be safe than sorry and add the import at the very top of the file.

import crafttweaker.api.tag.type.KnownTag;

Implemented Interfaces

KnownTag implements the following interfaces. That means all methods defined in these interfaces are also available in KnownTag

MCTag
stdlib.Iterable<T>

Casters

Result Type	Is Implicit
Result Type Many<KnownTag<T>>	Is Implicit true
Result Type string	Is Implicit true

Methods

KnownTag.add(elements as T[])

Parameter	Type
Parameter elements	Type T[]

Adds the given tags to this tag.

// KnownTag.add(tags as MCTag[])

myKnownTag.add(<tag:items:minecraft:wool>);

Parameter	Type	Description
Parameter tags	Type MCTag[]	Description The tags to add.

Adds the elements that correspond to the given ResourceLocation to this tag.

// KnownTag.addId(elements as ResourceLocation[])

myKnownTag.addId(<resource:minecraft:diamond>);

Parameter	Type	Description
Parameter elements	Type ResourceLocation[]	Description The registry key of the elements to add.

Return Type: Many<KnownTag<T>>

// KnownTag.asTagWithAmount() as Many<KnownTag<T>>

myKnownTag.asTagWithAmount();

Removes all elements in this tag.

// KnownTag.clear()

myKnownTag.clear();

Return Type: boolean

KnownTag.contains(element as T) as boolean

Parameter	Type
Parameter element	Type T

Checks if this tag contains an element with the given id

Returns: true if it contains the element, false otherwise.
Return Type: boolean

// KnownTag.contains(id as ResourceLocation) as boolean

myKnownTag.contains(<resource:minecraft:white_wool>);

Parameter	Type	Description
Parameter id	Type ResourceLocation	Description The ID of the element to check.

Return Type: stdlib.List<T>

// KnownTag.elements() as stdlib.List<T>

myKnownTag.elements();

Checks if this tag equals the other tag.

Returns: true if the tags are equal, false otherwise.
Return Type: boolean

// KnownTag.equals(other as MCTag) as boolean

myKnownTag.equals(<tag:items:minecraft:wool>);

Parameter	Type	Description
Parameter other	Type MCTag	Description The tag to check against.

Checks if this tag exists.

Returns: true if this tag exists, false otherwise.
Return Type: boolean

// KnownTag.exists() as boolean

myKnownTag.exists();

Return Type: ResourceLocation

// KnownTag.id() as ResourceLocation

myKnownTag.id();

Gets the id’s of the elements in this tag.

Returns: The id’s elements in this tag.
Return Type: stdlib.List<ResourceLocation>

// KnownTag.idElements() as stdlib.List<ResourceLocation>

myKnownTag.idElements();

Return Type: KnownTagManager<T>

// KnownTag.manager() as KnownTagManager<T>

myKnownTag.manager();

KnownTag.remove(elements as T[])

Parameter	Type
Parameter elements	Type T[]

Removes the given tags from this tag.

// KnownTag.remove(tags as MCTag[])

myKnownTag.remove(<tag:items:minecraft:wool>);

Parameter	Type	Description
Parameter tags	Type MCTag[]	Description The tags to remove.

Removes the elements that correspond to the given ResourceLocation from this tag.

// KnownTag.removeId(elements as ResourceLocation[])

myKnownTag.removeId(<resource:minecraft:diamond>);

Parameter	Type	Description
Parameter elements	Type ResourceLocation[]	Description The registry key of the elements to remove.

Return Type: Many<KnownTag<T>>

KnownTag.withAmount(amount as int) as Many<KnownTag<T>>

Parameter	Type
Parameter amount	Type int

Operators

Checks if this tag contains an element with the given id

id as ResourceLocation in myKnownTag
<resource:minecraft:white_wool> in myKnownTag

Checks if this tag equals the other tag.

myKnownTag == other as MCTag
myKnownTag == <tag:items:minecraft:wool>

myKnownTag * amount as int

Properties

Name	Type	Has Getter	Has Setter	Description
Name elements	Type stdlib.List<T>	Has Getter true	Has Setter false	Description
Name exists	Type boolean	Has Getter true	Has Setter false	Description Checks if this tag exists.
Name id	Type ResourceLocation	Has Getter true	Has Setter false	Description
Name idElements	Type stdlib.List<ResourceLocation>	Has Getter true	Has Setter false	Description Gets the id’s of the elements in this tag.
Name manager	Type KnownTagManager<T>	Has Getter true	Has Setter false	Description