MutableDataComponentHolder
Importing the class
If you need to reference this type directly, like when casting an Array, or as a parameter, you will need to import it. Simply add the import at the top of the file.
import crafttweaker.neoforge.api.component.MutableDataComponentHolder;Description
An interface that stores DataComponentsImplements
MutableDataComponentHolder
implements the following interfaces:
Undocumented Interfaces
IDataComponentHolderExtension
Operators
in(type as DataComponentType<?>) as bool
Checks whether the holder contains the given DataComponent, which is indentified by the type. script.zs
myDataComponentType<?> in myMutableDataComponentHolderParameters:
Return Type:
bool
Members
applyComponents(components as DataComponentMap)
myMutableDataComponentHolder.applyComponents(myDataComponentMap);Parameters:
components: DataComponentMap Type: DataComponentMap applyComponents(patch as DataComponentPatch)
myMutableDataComponentHolder.applyComponents(myDataComponentPatch);Parameters:
patch: DataComponentPatch Type: DataComponentPatch Getter
Gets the internal map of ComponentType -> Data script.zs
// MutableDataComponentHolder.components as DataComponentMapmyMutableDataComponentHolder.components
Return Type:
DataComponentMap
copyFrom(src as DataComponentHolder, componentTypes as DataComponentType<?>[])
// MutableDataComponentHolder.copyFrom(src as DataComponentHolder, componentTypes as DataComponentType<?>[]);myMutableDataComponentHolder.copyFrom(myDataComponentHolder, myDataComponentType<?>[]);Parameters:
src: DataComponentHolder Type: DataComponentHolder componentTypes: DataComponentType<?>[] Type: DataComponentType<?>[] getComponent(type as DataComponentType<T>) as T
Gets the data identified by the given DataComponentType. If the ComponentHolder does not have the Component, then null is returned.script.zs
Returns: The value if it exists or null.
myMutableDataComponentHolder.getComponent<T>(<componenttype:minecraft:stack_size>);Parameters:
Return Type:
T
getJsonComponent(type as DataComponentType<T>) as IData
Get an arbitrary component by type. This is useful to interact with components added by mods that do not have a CraftTweaker method.
If the ComponentAccess does not have the type, an exception is thrown. If the ComponentAccess is not serializable, an exception is thrown.script.zs
If the ComponentAccess does not have the type, an exception is thrown. If the ComponentAccess is not serializable, an exception is thrown.
Returns: A IData representation of the Serialized DataComponent
myMutableDataComponentHolder.getJsonComponent(<componenttype:minecraft:stack_size>);Parameters:
Return Type:
IData
getOrDefault(type as DataComponentType<T>, defaultValue as T) as T
Gets the data identified by the given DataComponentType. If the ComponentHolder does not have the Component, then the default value is returned.script.zs
Returns: The value if it exists or the default value.
// MutableDataComponentHolder.getOrDefault<T>(type as DataComponentType<T>, defaultValue as T) as T;myMutableDataComponentHolder.getOrDefault<T>(<componenttype:minecraft:stack_size>, 64);Parameters:
defaultValue: T Type: T
- The default value to return in the event that the holder does not have the component.
Return Type:
T
has(type as DataComponentType<?>) as bool
Checks whether the holder contains the given DataComponent, which is indentified by the type. script.zs
Returns: Whether the holder contains the DataComponent.
myMutableDataComponentHolder.has(<componenttype:minecraft:stack_size>);Parameters:
Return Type:
bool
remove(componentType as DataComponentType<T>) as T?
myMutableDataComponentHolder.remove<T>(myDataComponentType);Parameters:
componentType: DataComponentType<T> Type: DataComponentType<T>
Return Type:
T?
setComponent(componentType as DataComponentType<T>, value as T?) as T?
// MutableDataComponentHolder.setComponent<T>(componentType as DataComponentType<T>, value as T?) as T?;myMutableDataComponentHolder.setComponent<T>(myDataComponentType, myT);Parameters:
componentType: DataComponentType<T> Type: DataComponentType<T> value: T? Type: T?
Return Type:
T?
update(componentType as DataComponentType<T>, value as T, updater as UnaryOperator<T>) as T?
// MutableDataComponentHolder.update<T>(componentType as DataComponentType<T>, value as T, updater as UnaryOperator<T>) as T?;myMutableDataComponentHolder.update<T>(myDataComponentType, myT, myUnaryOperator);Parameters:
componentType: DataComponentType<T> Type: DataComponentType<T> value: T Type: T updater: UnaryOperator<T> Type: UnaryOperator<T>
Return Type:
T?
update(componentType as DataComponentType<T>, value as T, updateContext as U, updater as BiFunction<T, T, U>) as T?
// MutableDataComponentHolder.update<T, U>(componentType as DataComponentType<T>, value as T, updateContext as U, updater as BiFunction<T, T, U>) as T?;myMutableDataComponentHolder.update<T, U>(myDataComponentType, myT, myU, myBiFunction);Parameters:
componentType: DataComponentType<T> Type: DataComponentType<T> value: T Type: T updateContext: U Type: U updater: BiFunction<T, T, U> Type: BiFunction<T, T, U>
Return Type:
T?