Miroirs/pinnacle
1
0
Fork 0
mirror of https://github.com/pinnacle-comp/pinnacle.git synced 2025-01-17 18:11:30 +01:00
Code Issues Projects Releases Packages Wiki Activity

Add note

Browse source
This commit is contained in:
Ottatop 2024-01-16 16:24:34 -06:00
parent 643f694478
commit 048835837d
1 changed files with 4 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
api/lua/pinnacle.lua
View file

@ -35,7 +35,10 @@ end
---Setup Pinnacle. ---Setup Pinnacle.
--- ---
---You must pass in a function that takes in the `Pinnacle` module (it's more like a class but it's pretty much a module). The module is how you'll access the other config modules. ---You must pass in a function that takes in the `Pinnacle` module object. The module is how you'll access the other config modules.
---
---Note: All the config modules are object instantiations, and their methods require you to use the colon operator
---instead of the dot operator to call them.
--- ---
---If you want to do a multi-file config, you should have other files return a function taking in necessary modules. ---If you want to do a multi-file config, you should have other files return a function taking in necessary modules.
---Or you could cheat and stick the modules into globals :TrollFace: ---Or you could cheat and stick the modules into globals :TrollFace: