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
DyedItemColor FireworkExplosionShape
Next

FireworkExplosion

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.FireworkExplosion;

Implements

Undocumented Interfaces

TooltipProvider

Members

colors
Getter
Gets the colors of the FireworkExplosion.
script.zs
// FireworkExplosion.colors as List<Integer>
myFireworkExplosion.colors

Return Type: List<Integer>

fadeColors
Getter
Gets the fade colors of the FireworkExplosion.
script.zs
// FireworkExplosion.fadeColors as List<Integer>
myFireworkExplosion.fadeColors

Return Type: List<Integer>

hasTrail
Getter
Gets whether the FireworkExplosion has a trail.
script.zs
// FireworkExplosion.hasTrail as bool
myFireworkExplosion.hasTrail

Return Type: bool

hasTwinkle
Getter
Gets whether the FireworkExplosion has twinkle.
script.zs
// FireworkExplosion.hasTwinkle as bool
myFireworkExplosion.hasTwinkle

Return Type: bool

of
static of(shape as Shape, colors as List<Integer>, fadeColors as List<Integer>, hasTrail as bool, hasTwinkle as bool) as FireworkExplosion
Creates a new FireworkExplosion with the given shape, colors, fade colors, whether it has a trail, and whether it has twinkle.

Returns: The new FireworkExplosion.

script.zs
// FireworkExplosion.of(shape as FireworkExplosionShape, colors as List<Integer>, fadeColors as List<Integer>, hasTrail as bool, hasTwinkle as bool) as FireworkExplosion;
FireworkExplosion.of(myShape, myList, myList, myBool, myBool);

Parameters:

shape Type: FireworkExplosionShape - The shape of the FireworkExplosion.
colors Type: List<Integer> - The colors of the FireworkExplosion.
fadeColors Type: List<Integer> - The fade colors of the FireworkExplosion.
hasTrail Type: bool - Whether the FireworkExplosion has a trail.
hasTwinkle Type: bool - Whether the FireworkExplosion has twinkle.

Return Type: FireworkExplosion

shape
Getter
Gets the shape of the FireworkExplosion.
script.zs
// FireworkExplosion.shape as FireworkExplosionShape
myFireworkExplosion.shape

Return Type: FireworkExplosionShape

withFadeColors
withFadeColors(colors as List<Integer>) as FireworkExplosion
Sets the fade colors of the FireworkExplosion.

Returns: The FireworkExplosion with the new fade colors.

script.zs
// FireworkExplosion.withFadeColors(colors as List<Integer>) as FireworkExplosion;
myFireworkExplosion.withFadeColors(myList);

Parameters:

colors Type: List<Integer> - The fade colors of the FireworkExplosion.

Return Type: FireworkExplosion

Previous
DyedItemColor FireworkExplosionShape
Next