Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace DamageModule

Module to register new entity damage sources and death causes, also containing new method to deal damage to the entity, with wider parameters object than in InnerCore's Entity.damageEntity method.

since

3.0

Index

Classes

Interfaces

Functions

Functions

damageEntity

  • damageEntity(entity: number, damage: number, cause: number, params?: DamageDealingParams): void

  • Deals damage to the given entity. Successor to InnerCore's Entity.damageEntity method, but with wider additional parameters object.

    since

    3.0

    Parameters

    • entity: number

      unique ID of the entity to deal damage to

    • damage: number

      amount of damage (2 damage points = 1 heart)

    • cause: number

      numeric ID of the damage cause, can be one of KEX.EDamageCause values, or CustomCause.id field

    • Optional params: DamageDealingParams

      additional parameters object

    Returns void

isFire

  • isFire(id: number): boolean
  • since

    3.0

    Parameters

    • id: number

    Returns boolean

    whether the damage type of given numeric ID is a fire damage type

Generated using TypeDoc