NbtList<T extends NbtTag> class

Represents a list of unnamed NbtTags. Can only be a single type of NbtTag, e.g. only a list of NbtInt.

Inheritance
Implementers

Constructors

NbtList({required String name, required List<T> children, NbtTagType nbtTagType = NbtTagType.TAG_LIST})
Creates a basic NbtList with given parent. nbtTagType defaults to NbtTagType.TAG_LIST and only NbtTagType.TAG_COMPOUND or NbtTagType.TAG_LIST should be used here.

Properties

children ↔ List<T>
The list of children this array has. All functions implemented with ListMixin are referencing of of this List.
getter/setter pairinherited
childrenTagType ↔ NbtTagType
The NbtTagType for all of the children of this list.
getter/setter pair
first ↔ T
The first element.
getter/setter pairinherited
hashCode → int
The hash code for this object.
no setterinherited
hasLength → bool
If the tag is a List and has a length
no setterinherited
hasValue → bool
If this tag directly has a value.
no setterinherited
isEmpty → bool
Whether this collection has no elements.
no setterinherited
isNotEmpty → bool
Whether this collection has at least one element.
no setterinherited
iterator → Iterator<T>
A new Iterator that allows iterating the elements of this Iterable.
no setterinherited
last ↔ T
The last element.
getter/setter pairinherited
length ↔ int
The number of objects in this list.
getter/setter pairinherited
name ↔ String
The name of this tag. Inside of Lists or Arrays, this is 'None'.
getter/setter pairinherited
nbtTagType → NbtTagType
The type of this tag.
no setterinherited
parent ↔ NbtTag?
The parent of this tag. Can only be null for the root NbtCompound.
getter/setter pairinherited
reversed → Iterable<T>
An Iterable of the objects in this list in reverse order.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
single → T
Checks that this iterable has only one element, and returns that element.
no setterinherited
value ↔ List<T>
The value of this tag. Can vary depending on tag type, obtainable from nbtTagType.
getter/setter pairinherited-getter

Methods

add(T element) → void
Adds value to the end of this list, extending the length by one.
inherited
addAll(Iterable<T> iterable) → void
Appends all objects of iterable to the end of this list.
inherited
any(bool test(T element)) → bool
Checks whether any element of this iterable satisfies test.
inherited
asMap() → Map<int, T>
An unmodifiable Map view of this list.
inherited
cast<R>() → List<R>
Returns a view of this list as a list of R instances.
inherited
clear() → void
Removes all objects from this list; the length of the list becomes zero.
inherited
contains(Object? element) → bool
Whether the collection contains an element equal to element.
inherited
elementAt(int index) → T
Returns the indexth element.
inherited
every(bool test(T element)) → bool
Checks whether every element of this iterable satisfies test.
inherited
expand<T>(Iterable<T> f(T element)) → Iterable<T>
Expands each element of this Iterable into zero or more elements.
inherited
fillRange(int start, int end, [T? fill]) → void
Overwrites a range of elements with fillValue.
inherited
firstWhere(bool test(T element), {T orElse()?}) → T
The first element that satisfies the given predicate test.
inherited
fold<T>(T initialValue, T combine(T previousValue, T element)) → T
Reduces a collection to a single value by iteratively combining each element of the collection with an existing value
inherited
followedBy(Iterable<T> other) → Iterable<T>
Creates the lazy concatenation of this iterable and other.
inherited
forEach(void action(T element)) → void
Invokes action on each element of this iterable in iteration order.
inherited
getRange(int start, int end) → Iterable<T>
Creates an Iterable that iterates over a range of elements.
inherited
indexOf(Object? element, [int start = 0]) → int
The first index of element in this list.
inherited
indexWhere(bool test(T element), [int start = 0]) → int
The first index in the list that satisfies the provided test.
inherited
insert(int index, T element) → void
Inserts element at position index in this list.
inherited
insertAll(int index, Iterable<T> iterable) → void
Inserts all objects of iterable at position index in this list.
inherited
join([String separator = ""]) → String
Converts each element to a String and concatenates the strings.
inherited
lastIndexOf(Object? element, [int? start]) → int
The last index of element in this list.
inherited
lastIndexWhere(bool test(T element), [int? start]) → int
The last index in the list that satisfies the provided test.
inherited
lastWhere(bool test(T element), {T orElse()?}) → T
The last element that satisfies the given predicate test.
inherited
map<T>(T f(T element)) → Iterable<T>
The current elements of this iterable modified by toElement.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
readTag(NbtReader nbtReader, {bool withName = true}) → NbtList<NbtTag>
Reads a NbtTag from fileReader. If the parent is a NbtList or NbtArray, withName should be set to false to avoid reading the name of this Tag.
override
reduce(T combine(T previousValue, T element)) → T
Reduces a collection to a single value by iteratively combining elements of the collection using the provided function.
inherited
remove(Object? element) → bool
Removes the first occurrence of value from this list.
inherited
removeAt(int index) → T
Removes the object at position index from this list.
inherited
removeLast() → T
Removes and returns the last object in this list.
inherited
removeRange(int start, int end) → void
Removes a range of elements from the list.
inherited
removeWhere(bool test(T element)) → void
Removes all objects from this list that satisfy test.
inherited
replaceRange(int start, int end, Iterable<T> newContents) → void
Replaces a range of elements with the elements of replacements.
inherited
retainWhere(bool test(T element)) → void
Removes all objects from this list that fail to satisfy test.
inherited
setAll(int index, Iterable<T> iterable) → void
Overwrites elements with the objects of iterable.
inherited
setRange(int start, int end, Iterable<T> iterable, [int skipCount = 0]) → void
Writes some elements of iterable into a range of this list.
inherited
shuffle([Random? random]) → void
Shuffles the elements of this list randomly.
inherited
singleWhere(bool test(T element), {T orElse()?}) → T
The single element that satisfies test.
inherited
skip(int count) → Iterable<T>
Creates an Iterable that provides all but the first count elements.
inherited
skipWhile(bool test(T element)) → Iterable<T>
Creates an Iterable that skips leading elements while test is satisfied.
inherited
sort([int compare(T a, T b)?]) → void
Sorts this list according to the order specified by the compare function.
inherited
sublist(int start, [int? end]) → List<T>
Returns a new list containing the elements between start and end.
inherited
take(int count) → Iterable<T>
Creates a lazy iterable of the count first elements of this iterable.
inherited
takeWhile(bool test(T element)) → Iterable<T>
Creates a lazy iterable of the leading elements satisfying test.
inherited
toList({bool growable = true}) → List<T>
Creates a List containing the elements of this Iterable.
inherited
toSet() → Set<T>
Creates a Set containing the same elements as this iterable.
inherited
toString() → String
A string representation of this object.
inherited
where(bool test(T element)) → Iterable<T>
Creates a new lazy Iterable with all elements that satisfy the predicate test.
inherited
whereType<T>() → Iterable<T>
Creates a new lazy Iterable with all elements that have type T.
inherited
writeTag(NbtWriter nbtWriter, {bool withName = true, bool withType = true}) → void
Writes a NbtTag from fileReader. If the parent is a NbtList or NbtArray, withName should be set to false to avoid writing any names of this Tag.
override

Operators

operator +(List<T> other) → List<T>
Returns the concatenation of this list and other.
inherited
operator ==(Object other) → bool
The equality operator.
inherited
operator [](int index) → T
The object at the given index in the list.
inherited
operator []=(int index, T value) → void
Sets the value at the given index in the list to value.
inherited