Ylands:Tile - YEntity - Throw Entity

From Bohemia Interactive Community
Jump to navigation Jump to search

Throw Entity(Instigator, Entity template, Origin, Direction, Speed, Gravity, Damage, Damage type, Destroy on hit, On entity hit, On ground hit, On missed)

YlandsTile-637.png

static throwEntity(instigator: YEntity, entityTemplate: YEntityTemplate, origin: YVector3, direction: YVector3, speed: number, useGravity: boolean, damage: number, damageType: YDamageType, destroyOnHit: boolean, onEntityHit: (entity: YEntity, hitPosition: YVector3) => void, onGroundHit: (hitPosition: YVector3) => void, onMissed: () => void): void;

Parameters

instigator

Instigator of the throw (optional)

entityTemplate

Entity template of the projectile

origin

Origin of the projectile

direction

Direction of the throw (vector)

speed

Speed of the throw (m/s)

useGravity

Whether the throw respect gravity

damage

Amount of damage caused by the projectile

damageType

Type of damage caused by the projectile

destroyOnHit

Whether the projectile should be destroyed on hit

onEntityHit

What should happen if an entity is hit

onGroundHit

What should happen if ground is hit

onMissed

What should happen if nothing is hit

Availability

Server

Description

Throws a projectile spawned from the entity template.

Notes

  • Instigator will be listed as the source of the damage, if the throw hits something