⚙️Configuration

Comprehensive instructions on configuring files and utilizing export functions.

Prior experience as a developer or basic programming skills are recommended to effectively navigate this section of the documentation.

1. Banking Society Account Exports

These exports allow developers to retrieve, set, add, and remove money from a society account in crm-banking.

1. Get Society Account Balance

local balance = exports["crm-banking"]:crm_get_money(crm_name)

• Description: Returns the current balance of the specified society account.

• Parameters:

  • crm_name (string) – The name of the society account.

• Returns: (number) – The balance of the society account.

1. Set Society Account Balance

exports["crm-banking"]:crm_set_money(crm_name, crm_amount)

• Description: Sets the balance of the specified society account to a fixed amount.

• Parameters:

  • crm_name (string) – The name of the society account.

  • crm_amount (number) – The new balance to set.

1. Add Money to Society Account

exports["crm-banking"]:crm_add_money(crm_name, crm_amount)

• Description: Adds money to the specified society account.

• Parameters:

  • crm_name (string) – The name of the society account.

  • crm_amount (number) – The amount to add.

1. Remove Money from Society Account

exports["crm-banking"]:crm_remove_money(crm_name, crm_amount)

• Description: Removes money from the specified society account.

• Parameters:

  • crm_name (string) – The name of the society account.

  • crm_amount (number) – The amount to remove.

1. Add Transaction

exports["crm-banking"]:crm_add_transaction(crm_source, crm_charid, crm_sender, crm_receiver, crm_status, crm_amount, crm_type, crm_description)

• Description: Adds a transaction entry to the banking ledger with the specified details.

• Parameters:

  • crm_source (any, optional) – The player server ID that executed the transaction. Optional, can be nil if the transaction is not directly linked to a player.

  • crm_charid (number, optional) – The character ID related to the transaction.

  • crm_sender (string) – The iban of the transaction sender.

  • crm_receiver (string) – The iban of the transaction receiver.

  • crm_status (string) – Always set to "crm-done".

  • crm_amount (number) – The amount involved in the transaction.

  • crm_type (string) – The type of the transaction ("crm-withdrawal", "crm-deposit", "crm-transfer", "crm-loan").

  • crm_description (string) – A textual description of the transaction purpose or context.

1. Create New Society Account

exports["crm-banking"]:crm_create_society(crm_owner, crm_label, crm_budget)

• Description: Creates a new society account with the specified job or gang name, a label for display purposes, and an initial budget.

• Parameters:

  • crm_owner (string) – The name of the job or gang associated with the society (e.g., "police", "vagos").

  • crm_label (string) – The display label for the society account (e.g., "Police Department").

  • crm_budget (number) – The initial budget assigned to the society account.