KnownTagManager<T : Object>

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.

script.zs
import crafttweaker.api.tag.manager.type.KnownTagManager;

Implemented Interfaces

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

Methods

script.zs
KnownTagManager.addElements(to as KnownTag<T>, values as T[])
ParameterType
Parameter
to
Type
KnownTag<T>
Parameter
values
Type
T[]

Gets the elements of the given tag.

Returns: The list of elements in the tag.
Return Type: stdlib.List<T>

script.zs
// KnownTagManager.elements(of as KnownTag<T>) as stdlib.List<T>
myKnownTagManager.elements(<tag:items:minecraft:dirt>);
ParameterTypeDescription
Parameter
of
Type
KnownTag<T>
Description
The tag to get the elements of.

Checks if a tag with the given id exists and is registered.

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

script.zs
// KnownTagManager.exists(id as ResourceLocation) as boolean
myKnownTagManager.exists(<resource:minecraft:wool>);
ParameterTypeDescription
Parameter
id
Type
ResourceLocation
Description
The id of the tag to check.

Checks if a tag with the given id exists and is registered.

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

script.zs
// KnownTagManager.exists(id as string) as boolean
myKnownTagManager.exists("minecraft:wool");
ParameterTypeDescription
Parameter
id
Type
string
Description
The id of the tag to check.

Checks if the given tag exists and is registered.

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

script.zs
// KnownTagManager.exists(tag as T) as boolean
myKnownTagManager.exists(<tag:items:minecraft:wool>);
ParameterTypeDescription
Parameter
tag
Type
T
Description
The tag to check.

Ges the tags that contain the given element.

Returns: The tags that contain the given elements.
Return Type: stdlib.List<T>

script.zs
KnownTagManager.getTagsFor(element as ResourceLocation) as stdlib.List<T>
ParameterType
Parameter
element
Type
ResourceLocation

Return Type: stdlib.List<KnownTag<T>>

script.zs
KnownTagManager.getTagsFor(element as T) as stdlib.List<KnownTag<T>>
ParameterType
Parameter
element
Type
T

Gets the ResourceLocation ids of the elements in the given tag.

Returns: A List of ResourceLocation ids of the elements in the given tag.
Return Type: stdlib.List<ResourceLocation>

script.zs
// KnownTagManager.idElements(of as T) as stdlib.List<ResourceLocation>
myKnownTagManager.idElements(<tag:items:minecraft:wool>);
ParameterTypeDescription
Parameter
of
Type
T
Description
The tag to get the elements of.
script.zs
KnownTagManager.removeElements(from as KnownTag<T>, values as T[])
ParameterType
Parameter
from
Type
KnownTag<T>
Parameter
values
Type
T[]
script.zs
KnownTagManager.removeId(from as KnownTag<T>, values as ResourceLocation[])
ParameterType
Parameter
from
Type
KnownTag<T>
Parameter
values
Type
ResourceLocation[]

Return Type: KnownTag<T>

script.zs
KnownTagManager.tag(id as ResourceLocation) as KnownTag<T>
ParameterType
Parameter
id
Type
ResourceLocation

Return Type: KnownTag<T>

script.zs
KnownTagManager.tag(id as string) as KnownTag<T>
ParameterType
Parameter
id
Type
string

Gets the tagFolder of this manager.

The tag folder is usually the folder on disk without the tags/ prefix.

Examples:

  • `tags/items` turns into `items`
  • `tags/potion` turns into `potion`
  • `tags/worldgen/biome` turns into `worldgen/biome`

Returns: The tag folder of this manager.
Return Type: string

script.zs
// KnownTagManager.tagFolder() as string
myKnownTagManager.tagFolder();

Return Type: KnownTag<T>[ResourceLocation]

script.zs
// KnownTagManager.tagMap() as KnownTag<T>[ResourceLocation]
myKnownTagManager.tagMap();

Ges the tags that this manager knows about.

Returns: The tags that this manager knows about.
Return Type: stdlib.List<T>

script.zs
// KnownTagManager.tags() as stdlib.List<T>
myKnownTagManager.tags();

Operators

Checks if a tag with the given id exists and is registered.

script.zs
id as string in myKnownTagManager
"minecraft:wool" in myKnownTagManager

Properties

NameTypeHas GetterHas SetterDescription
Name
tagFolder
Type
string
Has Getter
true
Has Setter
false
Description
Gets the tagFolder of this manager.

The tag folder is usually the folder on disk without the tags/ prefix.

Examples:

  • tags/items turns into items

  • tags/potion turns into potion

  • tags/worldgen/biome turns into worldgen/biome

Name
tagMap
Type
KnownTag<T>[ResourceLocation]
Has Getter
true
Has Setter
false
Description
Name
tags
Type
stdlib.List<T>
Has Getter
true
Has Setter
false
Description
Ges the tags that this manager knows about.