KnownTag<T : Object>

Link to knowntagt--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

Link to 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

Link to implemented-interfaces

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

  • MCTag
  • stdlib.Iterable<T>
Result typeIs Implicit
Result type
Many<KnownTag<T>>
Is Implicit
true
Result type
string
Is Implicit
true

Name: add

Return Type: void

ZenScript
Copy
KnownTag.add(elements as T[]) as void
ParameterTypeDescription
Parameter
elements
Type
T[]
Description
No Description Provided

Name: add

Adds the given tags to this tag.

Return Type: void

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

myKnownTag.add(<tag:items:minecraft:wool>);
ParameterTypeDescription
Parameter
tags
Type
MCTag[]
Description
The tags to add.

Name: addId

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

Return Type: void

ZenScript
Copy
// KnownTag.addId(elements as ResourceLocation[]) as void

myKnownTag.addId(<resource:minecraft:diamond>);
ParameterTypeDescription
Parameter
elements
Type
ResourceLocation[]
Description
The registry key of the elements to add.

Name: asTagWithAmount

Return Type: Many<KnownTag<T>>

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

myKnownTag.asTagWithAmount();

Name: clear

Removes all elements in this tag.

Return Type: void

ZenScript
Copy
// KnownTag.clear() as void

myKnownTag.clear();

Name: contains

Return Type: boolean

ZenScript
Copy
KnownTag.contains(element as T) as boolean
ParameterTypeDescription
Parameter
element
Type
T
Description
No Description Provided

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>);
ParameterTypeDescription
Parameter
id
Type
ResourceLocation
Description
The ID of the element to check.

Name: elements

Return Type: stdlib.List<T>

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

myKnownTag.elements();

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>);
ParameterTypeDescription
Parameter
other
Type
MCTag
Description
The tag to check against.

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();

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();

Name: manager

Return Type: KnownTagManager<T>

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

myKnownTag.manager();

Name: remove

Return Type: void

ZenScript
Copy
KnownTag.remove(elements as T[]) as void
ParameterTypeDescription
Parameter
elements
Type
T[]
Description
No Description Provided

Name: remove

Removes the given tags from this tag.

Return Type: void

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

myKnownTag.remove(<tag:items:minecraft:wool>);
ParameterTypeDescription
Parameter
tags
Type
MCTag[]
Description
The tags to remove.

Name: removeId

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

Return Type: void

ZenScript
Copy
// KnownTag.removeId(elements as ResourceLocation[]) as void

myKnownTag.removeId(<resource:minecraft:diamond>);
ParameterTypeDescription
Parameter
elements
Type
ResourceLocation[]
Description
The registry key of the elements to remove.

Name: withAmount

Return Type: Many<KnownTag<T>>

ZenScript
Copy
KnownTag.withAmount(amount as int) as Many<KnownTag<T>>
ParameterTypeDescription
Parameter
amount
Type
int
Description
No Description Provided

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

Name: EQUALS

Checks if this tag equals the other tag.

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

Name: MUL

ZenScript
Copy
myKnownTag * amount as int
NameTypeHas GetterHas SetterDescription
Name
elements
Type
stdlib.List<T>
Has Getter
true
Has Setter
false
Description
No Description Provided
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
No Description Provided
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
No Description Provided