diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 0000000..e69de29 diff --git a/404.html b/404.html new file mode 100644 index 0000000..46c9821 --- /dev/null +++ b/404.html @@ -0,0 +1,963 @@ + + + +
+ + + + + + + + + + + + + + +This page is dedicated to the reference of the API.
+Here, you will find the all the events that are available with the API, what are their parameters and how to use them.
Information
+Please keep in mind that this page is for Experienced users, it requires some technical knowledge. Here is what you need to know:
+API Example Event
+sequenceDiagram
+participant API as API Implementation
+participant BP as BeamPerms
+
+Note over BP,API: This is an example of an API call <br><br> arg1: string <br> arg2: number <br><br> result1: string <br> result2: number
+API->>+BP: "eventName", arg1, arg2
+Note over BP: Process
+BP->>-API: result1,result2
+sequenceDiagram
+participant API as API Implementation
+participant BP as BeamPerms
+
+Note over BP,API: Check if BeamPerms is present <br> (If there is an endpoint for the API)
+API->>+BP: "checkBpPresence"
+alt
+ Note over BP: Endpoint Found
+ BP->>-API: true
+else
+ activate BP
+ Note over BP: Endpoint NOT Found <br> (By default BeamMP will return false)
+ BP--x-API: false
+end
+
+Note over BP,API: Check if API version is compatible <br><br> API_VERSION: string (Example: "v1.0.0")
+API->>+BP: "checkBpApiCompatibility", API_VERSION
+alt
+ Note over BP: Compatibility check is successful
+ BP->>-API: true
+else
+ activate BP
+ Note over BP: Compatibility check is NOT successful
+ BP->>-API: false
+end
+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.
+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.
v1.x.x
represents the initial release of the API./lua/api
.require("api/BeamPermsAPI")
!If you did everything correctly, your project should look something like this: +
+Which gives us the final code for the API: +
You can now use the API
+ + + + + + + + + + + + + +