Version:

Language:

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.

ZenScript
 Copy
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

add

Name: add

ZenScript
 Copy
KnownTag.add(elements as T[])

Parameter	Type
Parameter elements	Type T[]

add

Name: add

Adds the given tags to this tag.

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

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

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

addId

Name: addId

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

ZenScript
 Copy
// 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.

asTagWithAmount

Name: asTagWithAmount

Return Type: Many<KnownTag<T>>

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

myKnownTag.asTagWithAmount();

clear

Name: clear

Removes all elements in this tag.

ZenScript
 Copy
// KnownTag.clear()

myKnownTag.clear();

contains

Name: contains

Return Type: boolean

ZenScript
 Copy
KnownTag.contains(element as T) as boolean

Parameter	Type
Parameter element	Type T

contains

Name: contains

Checks if this tag contains an element with the given id

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

ZenScript
 Copy
// 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.

elements

Name: elements

Return Type: stdlib.List<T>

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

myKnownTag.elements();

equals

Name: equals

Checks if this tag equals the other tag.

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

ZenScript
 Copy
// 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.

exists

Name: exists

Checks if this tag exists.

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

ZenScript
 Copy
// KnownTag.exists() as boolean

myKnownTag.exists();

Name: id

Return Type: ResourceLocation

ZenScript
 Copy
// KnownTag.id() as ResourceLocation

myKnownTag.id();

idElements

Name: idElements

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

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

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

myKnownTag.idElements();

manager

Name: manager

Return Type: KnownTagManager<T>

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

myKnownTag.manager();

remove

Name: remove

ZenScript
 Copy
KnownTag.remove(elements as T[])

Parameter	Type
Parameter elements	Type T[]

remove

Name: remove

Removes the given tags from this tag.

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

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

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

removeId

Name: removeId

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

ZenScript
 Copy
// 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.

withAmount

Name: withAmount

Return Type: Many<KnownTag<T>>

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

Parameter	Type
Parameter amount	Type int

Operators

CONTAINS

Name: CONTAINS

Checks if this tag contains an element with the given id

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

EQUALS

Name: EQUALS

Checks if this tag equals the other tag.

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

MUL

Name: MUL

ZenScript
 Copy
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