Health, HitBoxes, HurtBoxes and HitScans screenshot 1
C

Publisher

clutteredcode

Health, HitBoxes, HurtBoxes and HitScans

Tools
Health Damage Hitbox Hurtbox Collision Combat 2D 3D

2D and 3D Components to manage health, damage, and healing

Download Latest (5.0.1)
Source Repository

Godot Health, HitBoxes, HurtBoxes, and HitScans

Godot LICENSE Current Release actions Downloads

Live Example ko-fi

[!CAUTION] A lot changed in v5.0.0. It is recommended to update to v4.4.0 before going to v5.0.0 to avoid issues with component name changes. We're working hard to update the documentation. The components in the documentation are all now prefixed with "Basic". We added more complex variants to allow for multiple damage types and modifiers. Thank for the support!

Documentation

Check out the Wiki for Documentation and tutorials!

Process and Data Flow

flowchart LR
  HitBox
  HitScan
  HurtBox
  Health

  HitBox -- detect collision and send **amount** --> HurtBox
  HitScan -- detect collision and send **amount** --> HurtBox
  HurtBox -- send **amount** and **multiplier** --> Health

Health Health

Health component tracks an entity's health and emits signals for various health realted changes.

Health inspector

HurtBox2D Hurtbox HurtBox3D

HurtBox2D and HurtBox3D components require a Collision Shape so it can be detected and is assigned a Health Health component to apply damage and healing when hit.

HurtBox2D Inspector

HitBox2D Hitbox HitBox3D

HitBox2D and HitBox3D components require a Collision Shape to detect collisions with a HurtBox2D HurtBox2D or HurtBox3D HurtBox3D to apply DAMAGE or HEAL.

HitBox2D Inspector

HitScan2D HitScan HitScan3D

HitScan2D and HitScan3D components extend RayCast2D and RayCast3D to detect collisions with a Hurtbox2D HurtBox2D or Hurtbox3D HurtBox3D to apply DAMAGE or HEAL.

HitScan2D Inspector

Live Example Demonstration

itch.io - godot-health-hitbox-hurtbox-hitscan

Installation

Asset Library Installation

  1. Open the AssetLib tab in the Godot Editor.
  2. Search for Health, HitBox, or HurtBox in the search bar.
  3. Click the download button next to the Health, HitBoxes, and HurtBoxes plugin.
  4. Once the installation is complete, go to Project -> Project Settings -> Plugins.
  5. Find the Health, HitBoxes, and HurtBoxes plugin in the list and check the box to enable it.

Usage

Player Structure

  1. Add a Health node to a Node that needs health (ie. CharacterBody2D or StaticBody3D)
  2. Add a HurtBox2D node with a CollisionShape2D to the same Node.
  3. Set the HurtBox2D collision layer.
  4. HitBox2D or HitScan2D
    • Create a projectile or melee weapon with a HitBox2D and set the collision mask to the same layer as the HurtBox2D collision layer. This will automatically apply damage and healing.
    • Create a gun with a HitScan2D extending from the barrel and set the collision mask to the same layer as the HurtBox2D collision layer. fire() needs to be called on the HitScan2D to apply damage and healing.

Issues

Submit issues to the Github Issues Page