Ironclad Engine API Reference
Disclaimer: This site is a work in progress. Not all links will work
Welcome to the API Reference for the Ironclad Engine. This section provides detailed documentation for all core engine modules, classes, methods, and properties.
The API documentation is automatically generated from JSDoc comments in the source code.
Browse the API
All engine components are documented, including:
- Core Systems:
Ironclad Engine,SceneManager,AssetLoader,InputManager,EventManager,AudioManager,EffectsManager,SaveLoadManager,GameLoop,Keyboard,Mouse,GamepadHandler(assuming Gamepad.js contains GamepadHandler). - Entity-Component-System (ECS):
EntityManager,BaseEntity,System,PrefabManager. - Rendering:
Camera,Sprite,TileLayerRenderer. - UI Elements:
BaseUIElement,Label,Button,Checkbox,Panel,ValueBar,Slider,ScrollablePanel,TextInputField. - Effects (FX):
BaseEffect,ShakeEffect,FlashEffect,TintEffect.
You are viewing the full detailed API documentation
How to Use
Each link in the JSDoc documentation will take you to the detailed page for that specific class or module, outlining its purpose, constructor, properties, and methods with their parameters and return types.
If you are looking for higher-level guides on how to use these systems, please refer to the Conceptual Guides.