API

Getting to know the UX API

Like what your seeing?

Support us as a GitHub Sponsor and get instant access to all our assets, exclusive tools and assets, escalated support and issue tracking and our gratitude. These articles are made possible by our GitHub Sponsors ... become a sponsor today!

Introduction

The UX API provides low level access to all of Heathen UX's features. API's members are all static classes and are used by higher level game object componenets to deliver the funcitonality of Heathen's UX. The UX API can be used to access features and funcitons of UX without the need of a GameObject reference and can be used to create tailor made systems and managers for your projects.

Features

Simple yet powerful

Clean simple, approchable static methods make most tasks a 1 liner

API.Cursors.SetState(state);

API.Windows.Focused.Maximize();

API.Log.SaveToTextFile(fileName);

Unity Native

Heathen's APIs are built with the Unity developer and programmer in mind. We make use of UnityEvents, Actions, ScriptableObjects and other standard Unity concepts and styles throughout the API.

Where nessisary the Heathen API handles the various options in Unity, for example API.Cursors and API.Windows is comptable with both the old and new Unity Input systems and automatically uses the appropreate option.