MCTag
Link to mctag
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 Copyimport crafttweaker.api.tag.MCTag;
Implemented Interfaces
Link to implemented-interfaces
MCTag implements the following interfaces. That means all methods defined in these interfaces are also available in MCTag
- CommandStringDisplayable
- stdlib.Comparable<MCTag>
Methods
Link to methods
Name: add
Adds the given tags to this tag.
ZenScript Copy// MCTag.add(tags as MCTag[])
<tag:items:minecraft:wool>.add(<tag:items:minecraft:wool>);
Parameter | Type | Description |
---|---|---|
Parameter tags | Type MCTag[] | Description The tags to add. |
Name: addId
Adds the elements that correspond to the given ResourceLocation to this tag.
ZenScript Copy// MCTag.addId(elements as ResourceLocation[])
<tag:items:minecraft:wool>.addId(<resource:minecraft:diamond>);
Parameter | Type | Description |
---|---|---|
Parameter elements | Type ResourceLocation[] | Description The registry key of the elements to add. |
Name: clear
Removes all elements in this tag.
ZenScript Copy// MCTag.clear()
<tag:items:minecraft:wool>.clear();
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// MCTag.contains(id as ResourceLocation) as boolean
<tag:items:minecraft:wool>.contains(<resource:minecraft:white_wool>);
Parameter | Type | Description |
---|---|---|
Parameter id | Type ResourceLocation | Description The ID of the element to check. |
Name: equals
Checks if this tag equals the other tag.
Returns: true if the tags are equal, false otherwise.
Return Type: boolean
ZenScript Copy// MCTag.equals(other as MCTag) as boolean
<tag:items:minecraft:wool>.equals(<tag:items:minecraft:wool>);
Parameter | Type | Description |
---|---|---|
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// MCTag.exists() as boolean
<tag:items:minecraft:wool>.exists();
Name: id
Gets the id of this tag.
Returns: The id of this tag.
Return Type: ResourceLocation
ZenScript Copy// MCTag.id() as ResourceLocation
<tag:items:minecraft:wool>.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// MCTag.idElements() as stdlib.List<ResourceLocation>
<tag:items:minecraft:wool>.idElements();
Name: remove
Removes the given tags from this tag.
ZenScript Copy// MCTag.remove(tags as MCTag[])
<tag:items:minecraft:wool>.remove(<tag:items:minecraft:wool>);
Parameter | Type | Description |
---|---|---|
Parameter tags | Type MCTag[] | Description The tags to remove. |
Name: removeId
Removes the elements that correspond to the given ResourceLocation from this tag.
ZenScript Copy// MCTag.removeId(elements as ResourceLocation[])
<tag:items:minecraft:wool>.removeId(<resource:minecraft:diamond>);
Parameter | Type | Description |
---|---|---|
Parameter elements | Type ResourceLocation[] | Description The registry key of the elements to remove. |
Operators
Link to operators
Name: CONTAINS
Checks if this tag contains an element with the given id
ZenScript Copyid as ResourceLocation in myMCTag
<resource:minecraft:white_wool> in <tag:items:minecraft:wool>
Name: EQUALS
Checks if this tag equals the other tag.
ZenScript CopymyMCTag == other as MCTag
<tag:items:minecraft:wool> == <tag:items:minecraft:wool>
Properties
Link to properties
Name | Type | Has Getter | Has Setter | 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 Gets the id of this tag. |
Name idElements | Type stdlib.List<ResourceLocation> | Has Getter true | Has Setter false | Description Gets the id's of the elements in this tag. |