TagManager<T : Object>
Link to tagmanagert--object
TagManagers are used to handle the different types of Tags within the game. They can be retrieved directly with the TagManager BEP, and are also used indirectly when creating a tag with the Tag BEP.
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.TagManager;
Implemented Interfaces
Link to implemented-interfaces
TagManager implements the following interfaces. That means all methods defined in these interfaces are also available in TagManager
Methods
Link to methods
Name: exists
Checks if a tag already exists. Does the same as calling .exists
on a tag directly
Returns: Whether or not this tag already exists
Return Type: boolean
ZenScript CopyTagManager.exists(location as MCResourceLocation) as boolean
Parameter | Type | Description |
---|---|---|
Parameter location | Type MCResourceLocation | Description The resource location to check for |
Name: exists
Checks if a tag already exists. Does the same as calling .exists
on a tag directly
Returns: Whether or not this tag already exists
Return Type: boolean
ZenScript CopyTagManager.exists(name as string) as boolean
Parameter | Type | Description |
---|---|---|
Parameter name | Type string | Description The resource location to check for |
Name: getAllTags
Retrieves a list of all tags currently registered.
Return Type: stdlib.List<MCTag<T>>
ZenScript Copy// TagManager.getAllTags() as stdlib.List<MCTag<T>>
myTagManager.getAllTags();
Name: getAllTagsFor
Retrieves all tags contain the provided element
Return Type: stdlib.List<MCTag<T>>
ZenScript CopyTagManager.getAllTagsFor(element as T) as stdlib.List<MCTag<T>>
Parameter | Type | Description |
---|---|---|
Parameter element | Type T | Description The element whose tags should be returned |
Name: getTag
Retrieves a tag by its name. Will also be called by the BEP.
Note that this method does not yet create the tag if it does not exist. Adding something to the object created by this tag will create it for the game.
Returns: A Tag object.
Return Type: MCTag<T>
ZenScript CopyTagManager.getTag(location as MCResourceLocation) as MCTag<T>
Parameter | Type | Description |
---|---|---|
Parameter location | Type MCResourceLocation | Description The Resource location of the tag |
Name: getTag
Retrieves a tag by its name. Will also be called by the BEP.
Note that this method does not yet create the tag if it does not exist. Adding something to the object created by this tag will create it for the game.
Returns: A Tag object.
Return Type: MCTag<T>
ZenScript CopyTagManager.getTag(name as string) as MCTag<T>
Parameter | Type | Description |
---|---|---|
Parameter name | Type string | Description The Resource location of the tag |
Name: getTagFolder
Get the tag type. In a Bracket call, this will used to determine which TagManager to use.
<tag:{tag_type
:tag_location:tag_name>}
<tagManager:{tag_type
>}
Return Type: string
ZenScript Copy// TagManager.getTagFolder() as string
myTagManager.getTagFolder();
Operators
Link to operators
Name: CONTAINS
Checks if a tag already exists. Does the same as calling .exists
on a tag directly
ZenScript Copyname as string in myTagManager
Properties
Link to properties
Name | Type | Has Getter | Has Setter | Description |
---|---|---|---|---|
Name all | Type stdlib.List<MCTag<T>> | Has Getter true | Has Setter false | Description Retrieves a list of all tags currently registered. |
Name tagType | Type string | Has Getter true | Has Setter false | Description Get the tag type. In a Bracket call, this will used to determine which TagManager to use. <tag:{tag_type :tag_location:tag_name>} <tagManager:{tag_type >} |