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

Raw Blame History

title, icon, excerpt

title	icon	excerpt
ArmaDragonflyClient - Hash Get ID	mdi:file-text-outline	Get the value associated with field in hash stored at key from DragonflyClient.

dragonfly_db_fnc_hashGetId

Description

Retrieves the value of a specific field from a hash table identified by its key. This function allows targeted access to individual fields within a specific hash table, making it ideal for accessing particular attributes of player or entity data. The retrieved data is returned through a callback function.

Syntax

[_key, _keyField, _function, _call, _netId] call dragonfly_db_fnc_hashGetId

Parameters

Parameter	Type	Description	Default
`_key`	String	Identifier of the hash table	""
`_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 field:

[getPlayerUID player, "loadout", "dragonfly_db_fnc_test"] call dragonfly_db_fnc_hashGetId;

Retrieve a specific vehicle property with synchronous callback:

["vehicle_123", "fuel", "dragonfly_db_fnc_processFuelData", true] call dragonfly_db_fnc_hashGetId;

Retrieve data and send it to a specific client:

[getPlayerUID player, "stats", "dragonfly_db_fnc_test", false, netId player] remoteExecCall ["dragonfly_db_fnc_hashGetId", 2, false];

Notes

Retrieves a single field value from a specific hash table
All three primary parameters (key, keyField, and function) are required and validated
The data is retrieved asynchronously through the extension's callback system
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 targets both a specific hash table (_key) and a specific field (_keyField)
More efficient than retrieving all hash fields when only one is needed
Player UIDs are commonly used as keys to store player-specific data
All operations are logged for debugging purposes

dragonfly_db_fnc_hashGet: Retrieves a field value from the global hash table
dragonfly_db_fnc_hashGetAllId: Retrieves all fields from a specific hash table
dragonfly_db_fnc_hashGetAll: Retrieves all fields from the global hash table
dragonfly_db_fnc_hashSetId: Sets a field value in a specific hash table
dragonfly_db_fnc_scheduler: Processes the callback from the database extension

Links

3.3 KiB Raw Blame History