Jacob Schmidt c8d81ba3bb
All checks were successful
Build / Build (push) Successful in 39s
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

21 lines
3.9 KiB
JavaScript

var searchData=
[
['handle_20data_20from_20db_0',['excerpt: Handle data from DB.',['../d4/d43/md__g_1_2ids_2dragonfly_2docs_2core_2handler.html#autotoc_md82',1,'']]],
['handler_1',['handler',['../d4/d43/md__g_1_2ids_2dragonfly_2docs_2core_2handler.html',1,'']]],
['handles_20data_20chunks_20received_20from_20the_20database_20extension_20when_20data_20is_20too_20large_20to_20be_20returned_20in_20a_20single_20callback_2',['excerpt: Handles data chunks received from the database extension when data is too large to be returned in a single callback.',['../d4/d99/md__g_1_2ids_2dragonfly_2docs_2basic_2fetch.html#autotoc_md14',1,'']]],
['hash_20data_3a_3',['hash data:',['../d2/d23/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_get_all_id.html#autotoc_md199',1,'Retrieve a player's complete hash data:'],['../da/d08/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_get_all.html#autotoc_md185',1,'Retrieve all client hash data:']]],
['hash_20operations_4',['Hash Operations',['../G:/ids/dragonfly/docs/README.md#autotoc_md348',1,'@ref "G:/ids/dragonfly/docs/hash/README.md" "Hash Operations"'],['../G:/ids/dragonfly/docs/README.md#autotoc_md352',1,'Hash Operations']]],
['hash_20readme_20md_20hash_20operations_5',['@ref "G:/ids/dragonfly/docs/hash/README.md" "Hash Operations"',['../G:/ids/dragonfly/docs/README.md#autotoc_md348',1,'']]],
['hash_20stored_20at_20key_20from_20dragonflyclient_6',['hash stored at key from DragonflyClient',['../d2/d23/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_get_all_id.html#autotoc_md192',1,'excerpt: Get all fields and values from the hash stored at key from DragonflyClient.'],['../d2/d28/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_get_id.html#autotoc_md206',1,'excerpt: Get the value associated with field in hash stored at key from DragonflyClient.'],['../d4/d99/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_set_id.html#autotoc_md248',1,'excerpt: Set the specified field to the respective value in the hash stored at key from DragonflyClient.'],['../de/da6/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_set_id_bulk.html#autotoc_md262',1,'excerpt: Set the specified fields to their respective values in the hash stored at key from DragonflyClient.']]],
['hash_20table_20in_20dragonflyclient_7',['hash table in DragonflyClient',['../d9/de8/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_get.html#autotoc_md164',1,'excerpt: Get a field value from the current client's hash table in DragonflyClient.'],['../da/d08/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_get_all.html#autotoc_md178',1,'excerpt: Get all fields from the current client's hash table in DragonflyClient.'],['../d0/df2/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_set.html#autotoc_md220',1,'excerpt: Set a field value in the current client's hash table in DragonflyClient.'],['../da/d74/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_set_bulk.html#autotoc_md234',1,'excerpt: Set multiple fields in the current client's hash table in DragonflyClient.']]],
['hash_20table_20retrieval_20task_3a_8',['Add a hash table retrieval task:',['../dd/d3b/md__g_1_2ids_2dragonfly_2docs_2core_2add_task.html#autotoc_md75',1,'']]],
['hashget_9',['hashGet',['../d9/de8/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_get.html',1,'']]],
['hashgetall_10',['hashGetAll',['../da/d08/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_get_all.html',1,'']]],
['hashgetallid_11',['hashGetAllId',['../d2/d23/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_get_all_id.html',1,'']]],
['hashgetid_12',['hashGetId',['../d2/d28/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_get_id.html',1,'']]],
['hashset_13',['hashSet',['../d0/df2/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_set.html',1,'']]],
['hashsetbulk_14',['hashSetBulk',['../da/d74/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_set_bulk.html',1,'']]],
['hashsetid_15',['hashSetId',['../d4/d99/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_set_id.html',1,'']]],
['hashsetidbulk_16',['hashSetIdBulk',['../de/da6/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_set_id_bulk.html',1,'']]]
];