mirror of
https://github.com/jimathy/jim_bridge.git
synced 2026-08-17 05:56:02 +01:00
better documentation layout
- seperated the 2000+ lines in ReadMe.md into seperate files. - useful if things expand - better readability for users - more organised layout
This commit is contained in:
28
documentation/main_functions/societybank.md
Normal file
28
documentation/main_functions/societybank.md
Normal file
@@ -0,0 +1,28 @@
|
||||
### societybank.lua
|
||||
|
||||
This module handles financial operations for society accounts, typically used for jobs or organizations.
|
||||
|
||||
- **getSocietyAccount(society)**
|
||||
|
||||
- Retrieves the current balance for the specified society.
|
||||
- **Example:**
|
||||
```lua
|
||||
local balance = getSocietyAccount("police")
|
||||
print("Police account balance: $"..balance)
|
||||
```
|
||||
|
||||
- **chargeSociety(society, amount)**
|
||||
|
||||
- Deducts a specified amount from the society's account.
|
||||
- **Example:**
|
||||
```lua
|
||||
chargeSociety("police", 500)
|
||||
```
|
||||
|
||||
- **fundSociety(society, amount)**
|
||||
|
||||
- Adds funds to a society’s account.
|
||||
- **Example:**
|
||||
```lua
|
||||
fundSociety("ambulance", 1200)
|
||||
```
|
||||
Reference in New Issue
Block a user