Jacob Schmidt c8d81ba3bb
All checks were successful
Build / Build (push) Successful in 39s
docs: Update README.md with detailed documentation
This commit significantly enhances the `README.md` file, providing comprehensive documentation for the ArmaDragonflyClient.

Key changes:

*   **Detailed Function Categories:** Categorized functions for better organization (Core, Basic Data Operations, Hash Operations, List Operations).
*   **Usage Examples:** Added clear and concise usage examples for basic operations, hash operations (context and ID-specific), and list operations.
*   **Function Documentation Structure:** Outlined the structure for individual function documentation.
*   **License Information:** Updated the license information.
2025-03-30 17:15:35 -05:00

44 lines
1.3 KiB
Markdown

---
title: ArmaDragonflyClient - Initialization
icon: mdi:file-text-outline
excerpt: Initial Extension settings.
---
# dragonfly_db_fnc_init
## Description
Initializes the ArmaDragonflyClient extension and sets up the initial settings. This function loads the extension, checks its version, sets the buffer size, and logs the initialization status. It is automatically called during mission startup.
## Syntax
```sqf
// This function is automatically called during initialization and doesn't need to be called directly
```
## Parameters
None. This function does not require any parameters.
## Return Value
None. The function sets up internal variables and logs initialization information.
## Examples
This function is automatically executed during framework initialization and doesn't need to be called manually.
## Notes
- Sets the global buffer size to 10240 bytes (10KB)
- Logs the DLL version number for reference
- Confirms successful loading of all functions
- Outputs initialization status to the RPT logs
- This is one of the first functions called when the framework loads
## Related Functions
- `dragonfly_db_fnc_save`: Saves database data to disk
## Links
[Add Task](addTask.md) |
[Handler](handler.md) |
[Init](init.md) |
[Print Addon Name](printAddonName.md) |
[Process Queue](processQueue.md) |
[Scheduler](scheduler.md) |
[Test](test.md)