ICollectionData
Link to icollectiondata
The ICollection data is used to represent a collection of IData like a List
Diese Klasse importieren
Link to diese-klasse-importieren
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.data.ICollectionData;
Implemented Interfaces
Link to implemented-interfaces
ICollectionData implements the following interfaces. That means all methods defined in these interfaces are also available in ICollectionData
Static Methods
Link to static-methods
Name: getFromMembers
Creates the most specific ICollectionData form possible for the provided members.
Tries to return (in order) ByteArrayData, IntArrayData, LongArrayData or if neither is applicable ListData
Return Type: ICollectionData
ZenScript CopyICollectionData.getFromMembers(members as IData[]) as ICollectionData
Parameter | Type | Beschreibung |
---|---|---|
Parameter members | Type IData[] | Beschreibung No Description Provided |
Casters
Link to casters
Result type | Is Implicit |
---|---|
Result type boolean | Is Implicit false |
Result type ICollectionData | Is Implicit false |
Result type INumberData | Is Implicit false |
Methoden
Link to methoden
Name: add
Return Type: void
ZenScript Copy// ICollectionData.add(value as IData) as void
new ListData(["Hello", "World"]).add("today");
Parameter | Type | Beschreibung |
---|---|---|
Parameter value | Type IData | Beschreibung The value to add to the list |
Name: add
Return Type: void
ZenScript Copy// ICollectionData.add(index as int, value as IData) as void
new ListData(["Hello", "World"]).add(1, "beautiful");
Parameter | Type | Beschreibung |
---|---|---|
Parameter index | Type int | Beschreibung The index to add to. Subsequent items will be moved one index higher |
Parameter value | Type IData | Beschreibung The value to add to the list |
Name: asBoolean
Return Type: boolean
ZenScript Copy// ICollectionData.asBoolean() as boolean
new ListData(["Hello", "World"]).asBoolean();
Name: asCollection
Return Type: ICollectionData
ZenScript Copy// ICollectionData.asCollection() as ICollectionData
new ListData(["Hello", "World"]).asCollection();
Name: asNumber
Return Type: INumberData
ZenScript Copy// ICollectionData.asNumber() as INumberData
new ListData(["Hello", "World"]).asNumber();
Name: asString
Gets the String representation of this IData
Returns: String that represents this IData (value and type).
Return Type: string
ZenScript Copy// ICollectionData.asString() as string
new ListData(["Hello", "World"]).asString();
Name: clear
Removes every element in the list
Return Type: void
ZenScript Copy// ICollectionData.clear() as void
new ListData(["Hello", "World"]).clear();
Name: contains
Checks if this IData contains another IData, mainly used in subclasses of ICollectionData, is the same as an equals check on other IData types
Returns: true if the given IData is contained in this IData
Return Type: boolean
ZenScript Copy// ICollectionData.contains(data as IData) as boolean
new ListData(["Hello", "World"]).contains("Display");
Parameter | Type | Beschreibung |
---|---|---|
Parameter data | Type IData | Beschreibung data to check if it is contained |
Name: getId
Gets the ID of the internal NBT tag.
Used to determine what NBT type is stored (in a list for example)
Returns: ID of the NBT tag that this data represents.
Return Type: byte
ZenScript Copy// ICollectionData.getId() as byte
new ListData(["Hello", "World"]).getId();
Name: getString
Gets the String representation of the internal INBT tag
Returns: String that represents the internal INBT of this IData.
Return Type: string
ZenScript Copy// ICollectionData.getString() as string
new ListData(["Hello", "World"]).getString();
Name: isEmpty
Return Type: boolean
ZenScript Copy// ICollectionData.isEmpty() as boolean
new ListData(["Hello", "World"]).isEmpty();
Name: setAt
Sets the item at the provided index to the given value
Returns: The replaced value
Return Type: IData
ZenScript Copy// ICollectionData.setAt(index as int, value as IData) as IData
new ListData(["Hello", "World"]).setAt(0, "Bye");
Parameter | Type | Beschreibung |
---|---|---|
Parameter index | Type int | Beschreibung The index to set (0-based) |
Parameter value | Type IData | Beschreibung The new Value |
Properties
Link to properties
Name | Type | Has Getter | Has Setter | Beschreibung |
---|---|---|---|---|
Name empty | Type boolean | Has Getter true | Has Setter false | Beschreibung No Description Provided |
Name size | Type int | Has Getter true | Has Setter false | Beschreibung No Description Provided |