EntityProjectileComponent Class

Extends

• EntityComponent

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.

Examples

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);

Properties

airInertia

airInertia: number;

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

Type: number

Important

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

catchFireOnHurt

catchFireOnHurt: boolean;

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.

Type: boolean

Important

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

critParticlesOnProjectileHurt

critParticlesOnProjectileHurt: boolean;

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

Type: boolean

Important

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

destroyOnProjectileHurt

destroyOnProjectileHurt: boolean;

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

Type: boolean

Important

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

gravity

gravity: number;

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.

Type: number

Important

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

hitEntitySound

hitEntitySound?: string;

The sound that plays when the projectile hits an entity.

Type: string

Important

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

hitGroundSound

hitGroundSound?: string;

The sound that plays when the projectile hits a block.

Type: string

Important

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

hitParticle

hitParticle?: string;

The particle that spawns when the projectile hits something.

Type: string

Important

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

lightningStrikeOnHit

lightningStrikeOnHit: boolean;

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.

Type: boolean

Important

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

liquidInertia

liquidInertia: number;

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

Type: number

Important

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

onFireTime

onFireTime: number;

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

Type: number

Important

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

owner

owner?: Entity;

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.

Type: Entity

Important

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

shouldBounceOnHit

shouldBounceOnHit: boolean;

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

Type: boolean

Important

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

stopOnHit

stopOnHit: boolean;

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.

Type: boolean

Important

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

Methods

• shoot

shoot

shoot(velocity: Vector3, options?: ProjectileShootOptions): void

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

Parameters

• velocity: Vector3

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

• options?: ProjectileShootOptions = null

  Optional configuration for the shoot.

Important

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

Warning

This function can throw errors.

Throws if the component or entity no longer exist.

Constants

componentId

static read-only componentId = "minecraft:projectile";

Type: string

Examples

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);