ZionGames Docs

Home / Zion Modules / Zion Stats

๐Ÿงฉ Zion Stats

Health, Stamina, Mana & XP Module for ZionTPS

Setup Wizard

The Zion Stats Setup Wizard installs the module on a ZionTPS player, applies a stat preset, creates or assigns configuration, and can generate a HUD and optional testing helper.

Step 1 โ€” Player

Assign the generated ZionTPS player root. You can also select a model or mesh child inside the player hierarchy; the wizard resolves the correct player root automatically.

The player must include ZionPlayer and ThirdPersonBrain.

Step 2 โ€” Presets & Config

Choose a preset, then assign an existing StatsConfig asset or allow the wizard to create one. The selected preset configures which optional stats are enabled.

Available Presets

  • Health + Stamina โ€” Health, sprint drain, action costs and stamina regeneration.
  • Health + Stamina + Mana โ€” Adds Mana for abilities, spells, tools or special actions.
  • Health + Stamina + XP โ€” Adds XP tracking for progression and rewards.
  • RPG Starter โ€” Adds Health, Stamina, Mana and XP.

Step 3 โ€” HUD

The wizard can optionally create a preset-aware HUD. Choose between UI Toolkit and uGUI.

  • Create Stats HUD โ€” Creates a HUD in the active scene.
  • UI Toolkit โ€” Uses UIDocument, ZionStatsHUD.uxml and a UI Toolkit binder.
  • uGUI โ€” Creates a Canvas-based fill-bar HUD.
  • Replace existing Zion Stats HUD โ€” Prevents duplicate generated HUDs.
  • Fallback to uGUI โ€” Uses uGUI if the UI Toolkit UXML asset is not available.

Optional Test Helper

The optional test helper is intended for development and screenshots. It gives you keyboard controls and an on-screen guide for testing the configured stats in Play Mode.

Remove or disable the helper before a finished game build unless you specifically want the test controls available.

Step 4 โ€” Review

Check the player, preset, config and HUD choice, then click Install. The wizard displays warnings when required player components or HUD assets cannot be found.