API Reference

This is the official API reference for PikeConsole!
Here you will find information about the framework and API in a more technical format. Since this is a Godot addon, and I am a sucker for Laws of UX, the docs are written in a somewhat similar syntax.

If you are looking for detailed breakdowns behind certain design decisions or just want an overview of the framework as a whole, head over to the Architecture & Framework tab!

New to PikeConsole?

If you're just getting started there's no need to dive head first into the API reference.
Instead, head over to the Getting Started guide to get PikeConsole up and running in less than 2 minutes!

Structure

The API reference is structured after the namespaces.
Thus some categories might feel more crammed than others, this is by design and allows for easier skimming.

Please note

These docs, whilst extensive, are curated to provide as smooth and frictionless of an experience as possible. Some systems are occluded from the API reference by design. This desn't mean the systems aren't doing anything, it simply means they weren't intended to be interacted with.