Arrow - CraftTweaker Documentation

Version:

Language:

Home Commands Examples Getting Started With Scripts Global Keywords

Importing the class

It might be required for you to import the package if you encounter any issues (like casting an Array), so better be safe than sorry and add the import at the very top of the file.

ZenScript
 Copy
import crafttweaker.api.entity.type.projectile.arrow.Arrow;

Extending Projectile

Arrow extends Projectile. That means all methods available in Projectile are also available in Arrow

Methods

getBaseDamage

Name: getBaseDamage

Gets the base damage that this arrow does.

Returns: The base damage of this arrow.
Return Type: double

ZenScript
 Copy
// Arrow.getBaseDamage() as double

myArrow.getBaseDamage();

getKnockback

Name: getKnockback

Gets the knockback of this arrow.

Returns: The knockback of this arrow.
Return Type: int

ZenScript
 Copy
// Arrow.getKnockback() as int

myArrow.getKnockback();

getPierceLevel

Name: getPierceLevel

Gets the pierce level of this arrow.

Returns: the pierce level of this arrow.
Return Type: byte

ZenScript
 Copy
// Arrow.getPierceLevel() as byte

myArrow.getPierceLevel();

isCritArrow

Name: isCritArrow

Checks whether this arrow is a crit arrow.

Returns: true if this is a crit arrow, false otherwise.
Return Type: boolean

ZenScript
 Copy
// Arrow.isCritArrow() as boolean

myArrow.isCritArrow();

isNoPhysics

Name: isNoPhysics

Checks if this arrow has physics or not.

Returns: true if this arrow doesn't have physics, false otherwise.
Return Type: boolean

ZenScript
 Copy
// Arrow.isNoPhysics() as boolean

myArrow.isNoPhysics();

setBaseDamage

Name: setBaseDamage

Sets the base damage that this arrow does.

ZenScript
 Copy
// Arrow.setBaseDamage(damage as double)

myArrow.setBaseDamage(0.5);

Parameter	Type	Description
Parameter damage	Type double	Description The base damage.

setCritArrow

Name: setCritArrow

Sets this the crit value of this arrow.

ZenScript
 Copy
// Arrow.setCritArrow(crit as boolean)

myArrow.setCritArrow(true);

Parameter	Type	Description
Parameter crit	Type boolean	Description The crit value to set.

setEnchantmentEffectsFromEntity

Name: setEnchantmentEffectsFromEntity

Sets the values of this arrow based on the enchantments the given entity has. This handles setting the knockback if the bow has a knockback enchantment.

ZenScript
 Copy
// Arrow.setEnchantmentEffectsFromEntity(entity as LivingEntity, distanceFactor as float)

myArrow.setEnchantmentEffectsFromEntity(entity, 1);

Parameter	Type	Description
Parameter entity	Type LivingEntity	Description The entity that fired the arrow
Parameter distanceFactor	Type float	Description How charged is the bow.

setKnockback

Name: setKnockback

Sets the knockback of this arrow.

ZenScript
 Copy
// Arrow.setKnockback(knockback as int)

myArrow.setKnockback(5);

Parameter	Type	Description
Parameter knockback	Type int	Description The knockback value.

setNoPhysics

Name: setNoPhysics

Sets if this arrow has physics or not.

ZenScript
 Copy
// Arrow.setNoPhysics(noPhysics as boolean)

myArrow.setNoPhysics(true);

Parameter	Type	Description
Parameter noPhysics	Type boolean	Description If this arrow has physics or not.

setPierceLevel

Name: setPierceLevel

Sets the pierce level of this arrow.

ZenScript
 Copy
Arrow.setPierceLevel(pieceLevel as byte)

Parameter	Type	Description
Parameter pieceLevel	Type byte	Description The pierce level of this arrow.

setShotFromCrossbow

Name: setShotFromCrossbow

Sets if this arrow was shot from a crossbow or not.

ZenScript
 Copy
// Arrow.setShotFromCrossbow(shotFromCrossbow as boolean)

myArrow.setShotFromCrossbow(true);

Parameter	Type	Description
Parameter shotFromCrossbow	Type boolean	Description If this arrow was shot from a crossbow or not.

setSoundEvent

Name: setSoundEvent

Sets the sound event that this arrow plays when it hits an entity or block.

ZenScript
 Copy
Arrow.setSoundEvent(event as SoundEvent)

Parameter	Type	Description
Parameter event	Type SoundEvent	Description The sound event to play when

shotFromCrossbow

Name: shotFromCrossbow

Checks if this arrow was shot from a crossbow.

Returns: true if it was shot from a crossbow, false otherwise.
Return Type: boolean

ZenScript
 Copy
// Arrow.shotFromCrossbow() as boolean

myArrow.shotFromCrossbow();

Properties

Name	Type	Has Getter	Has Setter	Description
Name baseDamage	Type Arrow	Has Getter true	Has Setter true	Description Sets the base damage that this arrow does.
Name isCritArrow	Type Arrow	Has Getter true	Has Setter true	Description Sets this the crit value of this arrow.
Name isNoPhysics	Type Arrow	Has Getter true	Has Setter true	Description Sets if this arrow has physics or not.
Name knockback	Type Arrow	Has Getter true	Has Setter true	Description Sets the knockback of this arrow.
Name pierceLevel	Type Arrow	Has Getter true	Has Setter true	Description Sets the pierce level of this arrow.
Name shotFromCrossbow	Type Arrow	Has Getter false	Has Setter true	Description Sets if this arrow was shot from a crossbow or not.
Name soundEvent	Type Arrow	Has Getter false	Has Setter true	Description Sets the sound event that this arrow plays when it hits an entity or block.