Skip to content

🎨 Health — Samples (Visual & Feedback Effects)

This folder contains example-only scripts used in demos and teachables to provide visual feedback for the Health system.

These scripts are not part of the supported runtime API.

If you use them in your own project, you are free to copy, modify, or discard them as needed — but they are not covered by compatibility guarantees.

📦 What These Samples Are

Samples are: - Visual / presentation helpers (VFX, SFX, material tweaks) - Event-driven listeners on top of HealthSystem - Intended for: - demos - teachable panels - quick prototyping

Samples are NOT: - Core gameplay systems - Required dependencies - Guaranteed to work with all shaders / render pipelines - A stable API surface

Health works perfectly without anything in this folder.

🎥 Included Examples

Typical scripts in this folder include:

  • DamageFlashOnHit

  • Brief material tint or emission flash when damage is taken

  • DeathFadeToBlack

  • Gradual fade of a renderer on death, restored on revive

  • DeathReviveBasicFX

  • Lightweight tint / scale feedback for death & revive

  • ReviveBurst

  • Spawns a prefab-based VFX when a unit revives

These are intentionally simple and readable so you can: - learn from them - adapt them - or replace them entirely

🧠 Usage Guidance

Best Practices

  • Treat these scripts as starting points, not finished systems
  • Prefer driving visuals from C# events (Died, Damaged, Revived)
  • Avoid baking gameplay logic into visual effects
  • Expect to rewrite or specialise these for your own art pipeline

⚠️ Support Boundary

These scripts: - may change or be removed in future versions - are not tested across all render pipelines or custom shaders - are provided "as-is" for learning and demonstration

If you need production-grade visuals, build your own effects on top of the public Health events and handlers.

🔗 See Also