Home Commands Examples Getting Started With Scripts Global Keywords 1.21 Migration Guide
AdventureModePredicate BlockItemStateProperties BookContent BundleContents ChargedProjectiles CustomData CustomModelData DebugStickState DyeColor DyedItemColor FireworkExplosion FireworkExplosionShape Fireworks Instrument ItemAttributeModifiers ItemAttributeModifiersBuilder ItemAttributeModifiersEntry ItemContainerContents ItemEnchantments ItemEnchantmentsMutable ItemLore LockCode LodestoneTracker MapDecorations MapDecorationsEntry MapId MapItemColor MapPostProcessing MutableBundleContents PotDecorations PotionContents ResolvableProfile SeededContainerLoot SuspiciousStewEffects SuspiciousStewEffectsEntry Tool ToolRule Unbreakable WritableBookContent WrittenBookContent
Equipable IItemStack ItemCooldowns ItemDefinition ItemStack UseOnContext
BracketDumpers BracketHandlers BracketValidators ResourceLocationBracketHandler
Previous
Fireworks ItemAttributeModifiers
Next

Instrument

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.component.Instrument;

Members

commandString
Getter
Gets the command string of the Instrument.
script.zs
// Instrument.commandString as string
myInstrument.commandString

Return Type: string

range
Getter
Gets the range of the Instrument.
script.zs
// Instrument.range as float
myInstrument.range

Return Type: float

registryName
Getter
Gets the registry name of the Instrument.
script.zs
// Instrument.registryName as ResourceLocation
myInstrument.registryName

Return Type: ResourceLocation

soundEvent
Getter
Gets the sound event of the Instrument.
script.zs
// Instrument.soundEvent as SoundEvent
myInstrument.soundEvent

Return Type: SoundEvent

useDuration
Getter
Gets the use duration of the Instrument.
script.zs
// Instrument.useDuration as int
myInstrument.useDuration

Return Type: int

Previous
Fireworks ItemAttributeModifiers
Next