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.3 KiB

Raw Permalink Blame History

title, icon, excerpt

title	icon	excerpt
ArmaDragonflyClient - Fetch	mdi:file-text-outline	Handles data chunks received from the database extension when data is too large to be returned in a single callback.

dragonfly_db_fnc_fetch

Description

Handles data chunks received from the database extension when data is too large to be returned in a single callback. This function collects all chunks of data, reassembles them in the correct order, and then passes the complete data to the handler function.

Syntax

[_uniqueID, _function, _index, _total, _datachunk, _call, _netId] call dragonfly_db_fnc_fetch

Parameters

Parameter	Type	Description
`_uniqueID`	String	Unique identifier for this data fetch operation
`_function`	String	Name of the function to call after data is assembled
`_index`	Number	Current chunk index (0-based)
`_total`	Number	Total number of chunks expected
`_datachunk`	String	The chunk of data being received
`_call`	Boolean	Whether to call the function directly (true) or spawn (false)
`_netId`	String	(Optional) NetID of the player to whom the data belongs

Return Value

None. When all chunks are received, the function will:

Assemble the complete data string
Parse it as a simple array
Call the specified handler function with the parsed data

Examples

This function is typically not called directly but is triggered by the extension's callback mechanism when large datasets are retrieved.

Notes

The function stores received chunks in the global array dragonfly_db_fetch_array
Chunks are sorted by their index to ensure correct assembly regardless of arrival order
After successful processing, the chunks for this uniqueID are removed from the array
This function is essential for handling large datasets that exceed the callback buffer limit

dragonfly_db_fnc_handler: Receives the assembled data and routes it to the appropriate function
dragonfly_db_fnc_scheduler: Manages the callback queue and triggers data fetching

2.3 KiB Raw Permalink Blame History