Ironclad Engine Documentation - Table of Contents

This page provides a comprehensive index of all available documentation for the Ironclad Engine.

Ⅰ. Main Project & Documentation Overview

• Project README
• Documentation Homepage

Ⅱ. Conceptual Guides (/guide/)

This section contains guides explaining core concepts, how to use engine systems, and best practices.

1. Introduction & Setup

• What is Ironclad Engine?
• Getting Started with Ironclad Engine

2. Core Engine Systems

• The IroncladEngine Class
• Scene Management (SceneManager.js)
• Input System (InputManager.js, Keyboard, Mouse, Gamepad)
• Asset Management (AssetLoader.js)
• Audio Management (AudioManager.js)
• Event Management (EventManager.js)
• Effects Management (EffectsManager.js & FX Classes)
• Save/Load Management (SaveLoadManager.js)
• Game Loop (GameLoop.js)

3. Entity-Component-System (ECS)

• ECS Overview
• EntityManager (EntityManager.js)
• BaseEntity (BaseEntity.js)
• Components
• Systems (System.js & Game Systems)
• PrefabManager (PrefabManager.js)

4. Rendering

• Rendering Overview
• Camera (Camera.js)
• Sprites (Sprite.js)
• Tilemap Rendering (TileLayerRenderer.js)
• Animation System (AnimationSystem.js)

5. UI System

• UI Elements Overview
• BaseUIElement (BaseUIElement.js)
  • UI Components:
    • Label (Label.js)
    • Button (Button.js)
    • Checkbox (Checkbox.js)
    • Panel (Panel.js)
    • ValueBar (ValueBar.js)
    • Slider (Slider.js)
    • ScrollablePanel (ScrollablePanel.js)
    • TextInputField (TextInputField.js)

Ⅲ. API Reference (/api/)

This section provides direct links to the JSDoc-generated HTML documentation for each class and module.

• API Reference Landing Page
• Direct link to the full JSDoc HTML output:
• Open Full JSDoc API Reference