Home Commands Examples Getting Started With Scripts Global Keywords 1.21 Migration Guide
ArmorTrim TrimMaterial TrimPattern
Equipable IItemStack ItemCooldowns ItemDefinition ItemStack UseOnContext
BracketDumpers BracketHandlers BracketValidators ResourceLocationBracketHandler
Previous
TrimMaterial AdventureModePredicate
Next

TrimPattern

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.

script.zs
import crafttweaker.api.item.armortrim.TrimPattern;

Members

assetId
Getter
Gets the asset ID of the trim pattern.
script.zs
// TrimPattern.assetId as ResourceLocation
myTrimPattern.assetId

Return Type: ResourceLocation

commandString
Getter
Gets the command string of the trim pattern.
script.zs
// TrimPattern.commandString as string
myTrimPattern.commandString

Return Type: string

copyWithStyle
copyWithStyle(material as TrimMaterial) as Component
Copies the trim pattern's description with a given material's style.

Returns: The new trim pattern.

script.zs
// TrimPattern.copyWithStyle(material as TrimMaterial) as Component;
myTrimPattern.copyWithStyle(myTrimMaterial);

Parameters:

material Type: TrimMaterial - The material.

Return Type: Component

decal
Getter
Gets whether the trim pattern is a decal.
script.zs
// TrimPattern.decal as bool
myTrimPattern.decal

Return Type: bool

description
Getter
Gets the description of the trim pattern.
script.zs
// TrimPattern.description as Component
myTrimPattern.description

Return Type: Component

registryName
Getter
Gets the registry name of the trim pattern.
script.zs
// TrimPattern.registryName as ResourceLocation
myTrimPattern.registryName

Return Type: ResourceLocation

templateItem
Getter
Gets the template item of the trim pattern.
script.zs
// TrimPattern.templateItem as ItemDefinition
myTrimPattern.templateItem

Return Type: ItemDefinition

Previous
TrimMaterial AdventureModePredicate
Next