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

3.2 KiB

Raw Blame History

title, icon, excerpt

title	icon	excerpt
ArmaDragonflyClient - Hash Get	mdi:file-text-outline	Get a field value from the current client's hash table in DragonflyClient.

dragonfly_db_fnc_hashGet

Description

Retrieves the value associated with a specific field in the hash table of the current client/player. This function automatically determines the appropriate hash ID based on the caller's identity, making it more convenient than hashGetId which requires manually specifying an ID. It accesses hash data asynchronously and returns the result through a callback function.

Syntax

[_keyField, _function, _call, _netId] call dragonfly_db_fnc_hashGet

Parameters

Parameter	Type	Description	Default
`_keyField`	String	Name of the field in the hash to retrieve	""
`_function`	String	Name of the function to receive the retrieved data	""
`_call`	Boolean	Whether to call the function directly (true) or spawn (false)	false
`_netId`	String	(Optional) NetID of the player to receive the data	""

Return Value

None. The retrieved data is passed to the specified callback function asynchronously.

Examples

Retrieve a player's loadout:

["loadout", "dragonfly_db_fnc_test"] call dragonfly_db_fnc_hashGet;

Retrieve data with synchronous callback:

["playerScore", "dragonfly_db_fnc_processScore", true] call dragonfly_db_fnc_hashGet;

Retrieve data and send it to a specific client:

["loadout", "dragonfly_db_fnc_test", false, netId player] remoteExecCall ["dragonfly_db_fnc_hashGet", 2, false];

Notes

Retrieves a value from the current client's hash table
The data is retrieved asynchronously through the extension's callback system
Both the field name and callback function name must be provided
Input validation ensures both required parameters are non-empty
When a netId is provided, the data is sent to that specific client
The _call parameter determines whether the function is called directly (synchronous) or spawned (asynchronous)
This function automatically determines which hash table to use based on the caller's identity
Use hashGetId when you need to specify a particular hash table by ID
All operations are logged for debugging purposes

dragonfly_db_fnc_hashGetId: Retrieves a field value from a specific hash table (when you need to specify the ID)
dragonfly_db_fnc_hashGetAll: Retrieves all fields from the current client's hash table
dragonfly_db_fnc_hashGetAllId: Retrieves all fields from a specific hash table
dragonfly_db_fnc_hashSet: Sets a field value in the current client's hash table
dragonfly_db_fnc_scheduler: Processes the callback from the database extension

Links

3.2 KiB Raw Blame History