Class EntityProjectileComponent

The projectile component controls the properties of a projectile entity and allows it to be shot in a given direction. This component is present when the entity has the minecraft:projectile component.

Example

shootArrow.ts 

import { world, Vector3 } from '@minecraft/server';

const location: Vector3 = { x: 0, y: -59, z: 0 }; // Replace with the coordinates of where you want to spawn the arrow
const velocity: Vector3 = { x: 0, y: 0, z: 5 };
const arrow = world.getDimension('overworld').spawnEntity('minecraft:arrow', location);
const projectileComp = arrow.getComponent('minecraft:projectile');
projectileComp?.shoot(velocity);

Hierarchy

Constructors

constructor

Properties

airInertia catchFireOnHurt critParticlesOnProjectileHurt destroyOnProjectileHurt entity gravity hitEntitySound? hitGroundSound? hitParticle? lightningStrikeOnHit liquidInertia onFireTime owner? shouldBounceOnHit stopOnHit typeId componentId

Methods

isValid shoot

Constructors

Private constructor

Properties

airInertia

airInertia: number

Remarks

The fraction of the projectile's speed maintained every tick while traveling through air.

This property can't be edited in read-only mode.

catchFireOnHurt

catchFireOnHurt: boolean

Remarks

If true, the entity will be set on fire when hurt. The default burn duration is 5 seconds. This duration can be modified via the onFireTime property. The entity will not catch fire if immune or if the entity is wet.

This property can't be edited in read-only mode.

critParticlesOnProjectileHurt

critParticlesOnProjectileHurt: boolean

Remarks

If true, the projectile will spawn crit particles when hit by a player. E.g. Player attacking a Shulker bullet.

This property can't be edited in read-only mode.

destroyOnProjectileHurt

destroyOnProjectileHurt: boolean

Remarks

If true, the projectile will be destroyed when it takes damage. E.g. Player attacking a Shulker bullet.

This property can't be edited in read-only mode.

Readonly entity

entity: Entity

Remarks

The entity that owns this component. The entity will be undefined if it has been removed.

gravity

gravity: number

Remarks

The gravity applied to the projectile. When the entity is not on the ground, subtracts this amount from the projectile’s change in vertical position every tick. The higher the value, the faster the projectile falls. If negative, the entity will rise instead of fall.

This property can't be edited in read-only mode.

Optional hitEntitySound

hitEntitySound?: string

Remarks

The sound that plays when the projectile hits an entity.

This property can't be edited in read-only mode.

Optional hitGroundSound

hitGroundSound?: string

Remarks

The sound that plays when the projectile hits a block.

This property can't be edited in read-only mode.

Optional hitParticle

hitParticle?: string

Remarks

The particle that spawns when the projectile hits something.

This property can't be edited in read-only mode.

lightningStrikeOnHit

lightningStrikeOnHit: boolean

Remarks

If true and the weather is thunder and the entity has line of sight to the sky, the entity will be struck by lightning when hit. E.g. A thrown Trident with the Channeling enchantment.

This property can't be edited in read-only mode.

liquidInertia

liquidInertia: number

Remarks

The fraction of the projectile's speed maintained every tick while traveling through a liquid.

This property can't be edited in read-only mode.

onFireTime

onFireTime: number

Remarks

Duration in seconds that the entity hit will be on fire for when catchFireOnHurt is set to true.

This property can't be edited in read-only mode.

Optional owner

owner?: Entity

Remarks

The owner of the projectile. This is used to determine what the projectile can collide with and damage. It also determines which entity is assigned as the attacker.

This property can't be edited in read-only mode.

shouldBounceOnHit

shouldBounceOnHit: boolean

Remarks

If true, the projectile will bounce off mobs when no damage is taken. E.g. A spawning wither.

This property can't be edited in read-only mode.

stopOnHit

stopOnHit: boolean

Remarks

If true, the projectile will stop moving when an entity is hit as thought it had been blocked. E.g. Thrown trident on hit behavior.

This property can't be edited in read-only mode.

Readonly typeId

typeId: string

Remarks

Identifier of the component.

Static Readonly componentId

componentId: "minecraft:projectile" = 'minecraft:projectile'

Methods

isValid

  • Returns boolean

    Whether the component is valid.

    Remarks

    Returns whether the component is valid. A component is considered valid if its owner is valid, in addition to any addition to any additional validation required by the component.

shoot

  • Parameters

    • velocity: Vector3

      The velocity to fire the projectile. This controls both the speed and direction which which the projectile will be shot.

    • Optional options: ProjectileShootOptions

      Optional configuration for the shoot.

      Optional

    Returns void

    Remarks

    Shoots the projectile with a given velocity. The projectile will be shot from its current location.

    This function can't be called in read-only mode.

    Throws

    Throws if the component or entity no longer exist.

Settings

Member Visibility

Theme

On This Page