Build / Build (push) Successful in 39s

Details

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

2.0 KiB

Raw Permalink Blame History

title, icon, excerpt

title	icon	excerpt
ArmaDragonflyClient - Scheduler	mdi:file-text-outline	Scheduled Environment for extension.

dragonfly_db_fnc_scheduler

Description

Manages the callback system for the ArmaDragonflyClient extension. This function receives task IDs from the extension's asynchronous callbacks, parses them, and registers them in a hashmap for later processing. It acts as the bridge between the extension's asynchronous operations and the game's execution environment.

Syntax

[_taskID] call dragonfly_db_fnc_scheduler

Parameters

Parameter	Type	Description	Default
`_taskID`	String	Task identifier returned from extension callback	""

Return Value

None. The function registers the task ID in a hashmap for later processing.

Examples

Process a callback from the extension:

["1689524160123_get"] call dragonfly_db_fnc_scheduler;

Forward a callback to the server:

["1689524160123_hgetall"] remoteExecCall ["dragonfly_db_fnc_scheduler", 2, false];

Notes

Parses the task ID to extract the timestamp and operation type
Registers the task in a type-specific hashmap using the mission namespace
Each operation type (get, hgetall, etc.) has its own hashmap for tracking
The format of task IDs is typically: [timestamp]_[operation]
This function is automatically called by the extension callback mechanism
Creates hashmaps on demand if they don't already exist
Critical for handling asynchronous database operations

dragonfly_db_fnc_fetch: Assembles data chunks for large datasets
dragonfly_db_fnc_handler: Processes the data retrieved from database operations
dragonfly_db_fnc_processQueue: Executes queued database operations

Links

2.0 KiB Raw Permalink Blame History