c8d81ba3bb
All checks were successful
Build / Build (push) Successful in 39s
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.
Hash Operations
This section contains documentation for the hash operations of ArmaDragonflyClient that allow for working with hash tables (key-value pairs within a namespace).
Available Functions
- hashGet - Get a field from a hash
- hashGetAll - Get all fields from a hash
- hashGetAllId - Get all fields from a hash for a specific ID
- hashGetId - Get a field from a hash for a specific ID
- hashSet - Set a field in a hash
- hashSetBulk - Set multiple fields in a hash in one operation
- hashSetId - Set a field in a hash for a specific ID
- hashSetIdBulk - Set multiple fields in a hash for a specific ID in one operation
Example Usage
// Context mode examples
["myField", [myValue]] call dragonfly_db_fnc_hashSet;
["myField", "myFunction"] call dragonfly_db_fnc_hashGet;
["myFunction"] call dragonfly_db_fnc_hashGetAll;
// Set multiple hash fields in one operation
[[
"loadout", [getUnitLoadout player],
"position", [getPosASL player],
"direction", [getDir player]
]] call dragonfly_db_fnc_hashSetBulk;
// ID-specific examples
["myHash", "myField", [myValue]] call dragonfly_db_fnc_hashSetId;
["myHash", "myField", "myFunction"] call dragonfly_db_fnc_hashGetId;
["myHash"] call dragonfly_db_fnc_hashGetAllId;