Usage

Qui aliqua commodo laborum ad consequat pariatur. Amet consequat pariatur ex et nostrud sint laborum duis aute. Cillum consequat amet occaecat id sint. Aliquip consequat do incididunt enim cillum elit reprehenderit incididunt ut in eu qui culpa.

Versioning

The API uses Semantic Versioning. This means that any non-backward compatible change will result in an increment of the major version (1.x.x --> 2.x.x). You can be confident that your integration will remain stable across updates, as long as the major version does not change. Versions correspond to the API Reference.

Changelogs

Version v1.x.x represents the initial release of the API.

Quick Start Guide

Adding the api to your project
Initializing the API
Amet ex quis magna ullamco amet.
Ad id quis proident dolore irure nostrud minim labore laboris anim sint.

Adding the api to your project

Download the Api file.
Put in your project directory, under /lua/api.
Do not rename it, or you will need to change require("api/BeamPermsAPI")!

If you did everything correctly, your project should look something like this:

my_plugin/
├── lua/
│   └── api/
│       └── BeamPermsAPI.lua
└── main.lua

Initializing the API

Requiring the API file
```
BP = require("api/BeamPermsAPI")
```

Checking if the API is available

if BP.isDisabled() then
  ... -- The API is not available, functions will not be registered!
end

Which gives us the final code for the API:

BP = require("api/BeamPermsAPI")

...

if BP.isDisabled() then
  print("BeamPermsAPI is disabled, ...")
end

You can now use the API