Skip to content

Health Teaching Support

This folder contains support-only helpers used by the Health teaching panels.

These files exist to keep the teaching panels readable, focused, and hostile-consumer-safe without pushing panel-only UI helpers into runtime or shared framework layers.

What Belongs Here

Files in this folder are typically:

  • panel-only formatting helpers
  • reason-to-text mappers for teaching/debug UI
  • small visual or text helpers shared by multiple Health panels
  • teaching-layer support code that is not part of the runtime API

Examples include:

  • HealthReasonText
  • panel-specific formatting helpers
  • shared teaching labels or lightweight UI mapping helpers

What Does Not Belong Here

This folder should not contain:

  • runtime gameplay logic
  • public framework APIs
  • .Internal runtime access helpers
  • reflection-based inspection tools
  • cross-system Common/UX utilities
  • sample/demo scene bootstrap code

If a helper is needed by the runtime system, it belongs in the runtime module.

If a helper is needed across multiple framework systems, it should be evaluated separately rather than placed here by convenience.

Why This Folder Exists

Health teachables often need small pieces of UI-facing support code, such as:

  • converting DamageRejectionReason into readable teaching text
  • formatting health/debug output for panels
  • avoiding repeated panel-only utility logic

Keeping these helpers here ensures:

  • the runtime Health API stays clean
  • teaching panels stay readable
  • hostile-consumer panels do not depend on unrelated shared UI layers
  • system boundaries remain clear

Relationship to Runtime

Files in this folder are teaching-layer helpers only.

They are:

  • not part of the public Health runtime API
  • not intended as required gameplay dependencies
  • not used to validate core runtime behaviour on their own

They exist to support the presentation and readability of teaching panels.

Relationship to Hostile Consumer Panels

Support helpers in this folder may be used by HostileConsumer panels, provided they remain:

  • local to the Health teaching layer
  • free from internal/runtime-only access
  • free from reflection and hidden coupling

These helpers should support hostile-consumer readability without weakening hostile-consumer purity.

Summary

This folder contains Health teaching support code.

It exists to help the teaching panels explain Health behaviour clearly, while keeping:

  • runtime code clean
  • system boundaries intact
  • teachable panel logic focused

If a helper only exists to support Health teaching panels, this is the right place for it.