octacian 8b62f99c9a Add waypoint element API
Implements an API specifically for the purpose of manipulating waypoint HUD elements.
2017-03-27 22:24:46 -07:00
..
2017-03-27 17:19:26 -07:00
2017-03-27 17:19:26 -07:00
2017-03-27 19:05:05 -07:00
2017-03-27 19:36:03 -07:00
2017-03-14 20:28:48 -07:00
2017-03-27 19:35:22 -07:00
2017-03-27 22:24:46 -07:00

API Documentation

HUDLib provides a rather extensive yet simplistic API for use in third party mods. The API is mainly divided into different files depending on the type of HUD element, however, there is one main file (api.lua) containing code suitable for all types of HUDs. Below an overview of each documentation file can be found.

API.md

The main API (api.lua) registers but a few functions allowing you to do things like view all the HUD elements attached to a player no matter their type or execute some code after a specific amount of time

HUD.md

This documents the API provided by hud.lua which currently indirectly supports all HUD elements.