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.
44 lines
12 KiB
JavaScript
44 lines
12 KiB
JavaScript
var searchData=
|
|
[
|
|
['element_20from_20a_20list_20stored_20at_20a_20key_20in_20dragonflyclient_0',['excerpt: Remove an element from a list stored at a key in DragonflyClient.',['../d1/d22/md__g_1_2ids_2dragonfly_2docs_2list_2list_remove.html#autotoc_md319',1,'']]],
|
|
['element_20in_20a_20list_20stored_20at_20a_20key_20in_20dragonflyclient_1',['excerpt: Set an element in a list stored at a key in DragonflyClient.',['../d2/dc5/md__g_1_2ids_2dragonfly_2docs_2list_2list_set.html#autotoc_md330',1,'']]],
|
|
['element_20of_20list_20stored_20at_20key_20from_20dragonflyclient_2',['excerpt: Get element of list stored at key from DragonflyClient.',['../d3/ddf/md__g_1_2ids_2dragonfly_2docs_2list_2list_get.html#autotoc_md294',1,'']]],
|
|
['element_20to_20list_20stored_20at_20key_20from_20dragonflyclient_3',['excerpt: Add element to list stored at key from DragonflyClient.',['../da/d2c/md__g_1_2ids_2dragonfly_2docs_2list_2list_add.html#autotoc_md280',1,'']]],
|
|
['elements_20of_20a_20list_20stored_20at_20a_20key_20from_20dragonflyclient_4',['excerpt: Get all elements of a list stored at a key from DragonflyClient.',['../d9/db3/md__g_1_2ids_2dragonfly_2docs_2list_2list_load.html#autotoc_md308',1,'']]],
|
|
['entry_3a_5',['entry:',['../da/d2c/md__g_1_2ids_2dragonfly_2docs_2list_2list_add.html#autotoc_md287',1,'Add an event log entry:'],['../d3/ddf/md__g_1_2ids_2dragonfly_2docs_2list_2list_get.html#autotoc_md301',1,'Retrieve a specific event log entry:']]],
|
|
['environment_20for_20extension_6',['excerpt: Scheduled Environment for extension.',['../d0/df6/md__g_1_2ids_2dragonfly_2docs_2core_2scheduler.html#autotoc_md137',1,'']]],
|
|
['event_20log_20entry_3a_7',['event log entry:',['../da/d2c/md__g_1_2ids_2dragonfly_2docs_2list_2list_add.html#autotoc_md287',1,'Add an event log entry:'],['../d3/ddf/md__g_1_2ids_2dragonfly_2docs_2list_2list_get.html#autotoc_md301',1,'Retrieve a specific event log entry:']]],
|
|
['example_20usage_8',['Example Usage',['../G:/ids/dragonfly/docs/basic/README.md#autotoc_md38',1,'Example Usage'],['../G:/ids/dragonfly/docs/core/README.md#autotoc_md134',1,'Example Usage'],['../G:/ids/dragonfly/docs/hash/README.md#autotoc_md277',1,'Example Usage'],['../G:/ids/dragonfly/docs/list/README.md#autotoc_md342',1,'Example Usage']]],
|
|
['examples_9',['Examples',['../df/d12/md__g_1_2ids_2dragonfly_2docs_2basic_2delete.html#autotoc_md7',1,'Examples'],['../d4/d99/md__g_1_2ids_2dragonfly_2docs_2basic_2fetch.html#autotoc_md20',1,'Examples'],['../d3/dcb/md__g_1_2ids_2dragonfly_2docs_2basic_2get.html#autotoc_md30',1,'Examples'],['../d2/dce/md__g_1_2ids_2dragonfly_2docs_2basic_2save.html#autotoc_md47',1,'Examples'],['../d9/d9c/md__g_1_2ids_2dragonfly_2docs_2basic_2set.html#autotoc_md60',1,'Examples'],['../dd/d3b/md__g_1_2ids_2dragonfly_2docs_2core_2add_task.html#autotoc_md74',1,'Examples'],['../d4/d43/md__g_1_2ids_2dragonfly_2docs_2core_2handler.html#autotoc_md88',1,'Examples'],['../dc/d36/md__g_1_2ids_2dragonfly_2docs_2core_2init.html#autotoc_md102',1,'Examples'],['../d4/d7c/md__g_1_2ids_2dragonfly_2docs_2core_2print_addon_name.html#autotoc_md113',1,'Examples'],['../d0/d0e/md__g_1_2ids_2dragonfly_2docs_2core_2process_queue.html#autotoc_md126',1,'Examples'],['../d0/df6/md__g_1_2ids_2dragonfly_2docs_2core_2scheduler.html#autotoc_md143',1,'Examples'],['../d6/d7e/md__g_1_2ids_2dragonfly_2docs_2core_2test.html#autotoc_md156',1,'Examples'],['../d9/de8/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_get.html#autotoc_md170',1,'Examples'],['../da/d08/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_get_all.html#autotoc_md184',1,'Examples'],['../d2/d23/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_get_all_id.html#autotoc_md198',1,'Examples'],['../d2/d28/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_get_id.html#autotoc_md212',1,'Examples'],['../d0/df2/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_set.html#autotoc_md226',1,'Examples'],['../da/d74/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_set_bulk.html#autotoc_md240',1,'Examples'],['../d4/d99/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_set_id.html#autotoc_md254',1,'Examples'],['../de/da6/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_set_id_bulk.html#autotoc_md268',1,'Examples'],['../da/d2c/md__g_1_2ids_2dragonfly_2docs_2list_2list_add.html#autotoc_md286',1,'Examples'],['../d3/ddf/md__g_1_2ids_2dragonfly_2docs_2list_2list_get.html#autotoc_md300',1,'Examples'],['../d9/db3/md__g_1_2ids_2dragonfly_2docs_2list_2list_load.html#autotoc_md314',1,'Examples'],['../d1/d22/md__g_1_2ids_2dragonfly_2docs_2list_2list_remove.html#autotoc_md325',1,'Examples'],['../d2/dc5/md__g_1_2ids_2dragonfly_2docs_2list_2list_set.html#autotoc_md336',1,'Examples'],['../G:/ids/dragonfly/docs/README.md#autotoc_md350',1,'Usage Examples']]],
|
|
['excerpt_3a_20add_20element_20to_20list_20stored_20at_20key_20from_20dragonflyclient_10',['excerpt: Add element to list stored at key from DragonflyClient.',['../da/d2c/md__g_1_2ids_2dragonfly_2docs_2list_2list_add.html#autotoc_md280',1,'']]],
|
|
['excerpt_3a_20add_20task_20to_20queue_11',['excerpt: Add task to queue.',['../dd/d3b/md__g_1_2ids_2dragonfly_2docs_2core_2add_task.html#autotoc_md68',1,'']]],
|
|
['excerpt_3a_20displays_20the_20addon_20name_20in_20system_20chat_12',['excerpt: Displays the addon name in system chat.',['../d4/d7c/md__g_1_2ids_2dragonfly_2docs_2core_2print_addon_name.html#autotoc_md107',1,'']]],
|
|
['excerpt_3a_20get_20a_20field_20value_20from_20the_20current_20client_20s_20hash_20table_20in_20dragonflyclient_13',['excerpt: Get a field value from the current client's hash table in DragonflyClient.',['../d9/de8/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_get.html#autotoc_md164',1,'']]],
|
|
['excerpt_3a_20get_20all_20elements_20of_20a_20list_20stored_20at_20a_20key_20from_20dragonflyclient_14',['excerpt: Get all elements of a list stored at a key from DragonflyClient.',['../d9/db3/md__g_1_2ids_2dragonfly_2docs_2list_2list_load.html#autotoc_md308',1,'']]],
|
|
['excerpt_3a_20get_20all_20fields_20and_20values_20from_20the_20hash_20stored_20at_20key_20from_20dragonflyclient_15',['excerpt: Get all fields and values from the hash stored at key from DragonflyClient.',['../d2/d23/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_get_all_id.html#autotoc_md192',1,'']]],
|
|
['excerpt_3a_20get_20all_20fields_20from_20the_20current_20client_20s_20hash_20table_20in_20dragonflyclient_16',['excerpt: Get all fields 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_3a_20get_20element_20of_20list_20stored_20at_20key_20from_20dragonflyclient_17',['excerpt: Get element of list stored at key from DragonflyClient.',['../d3/ddf/md__g_1_2ids_2dragonfly_2docs_2list_2list_get.html#autotoc_md294',1,'']]],
|
|
['excerpt_3a_20get_20the_20value_20associated_20with_20field_20in_20hash_20stored_20at_20key_20from_20dragonflyclient_18',['excerpt: Get the value associated with field in hash stored at key from DragonflyClient.',['../d2/d28/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_get_id.html#autotoc_md206',1,'']]],
|
|
['excerpt_3a_20get_20the_20value_20of_20stored_20key_20from_20dragonflyclient_19',['excerpt: Get the value of stored key from DragonflyClient.',['../d3/dcb/md__g_1_2ids_2dragonfly_2docs_2basic_2get.html#autotoc_md24',1,'']]],
|
|
['excerpt_3a_20handle_20data_20from_20db_20',['excerpt: Handle data from DB.',['../d4/d43/md__g_1_2ids_2dragonfly_2docs_2core_2handler.html#autotoc_md82',1,'']]],
|
|
['excerpt_3a_20handles_20data_20chunks_20received_20from_20the_20database_20extension_20when_20data_20is_20too_20large_20to_20be_20returned_20in_20a_20single_20callback_21',['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,'']]],
|
|
['excerpt_3a_20initial_20extension_20settings_22',['excerpt: Initial Extension settings.',['../dc/d36/md__g_1_2ids_2dragonfly_2docs_2core_2init.html#autotoc_md96',1,'']]],
|
|
['excerpt_3a_20processes_20a_20queue_20of_20tasks_20to_20be_20executed_23',['excerpt: Processes a queue of tasks to be executed.',['../d0/d0e/md__g_1_2ids_2dragonfly_2docs_2core_2process_queue.html#autotoc_md120',1,'']]],
|
|
['excerpt_3a_20remove_20an_20element_20from_20a_20list_20stored_20at_20a_20key_20in_20dragonflyclient_24',['excerpt: Remove an element from a list stored at a key in DragonflyClient.',['../d1/d22/md__g_1_2ids_2dragonfly_2docs_2list_2list_remove.html#autotoc_md319',1,'']]],
|
|
['excerpt_3a_20remove_20the_20specified_20key_20from_20dragonflyclient_25',['excerpt: Remove the specified key from DragonflyClient.',['../df/d12/md__g_1_2ids_2dragonfly_2docs_2basic_2delete.html#autotoc_md1',1,'']]],
|
|
['excerpt_3a_20save_20db_20to_20disc_26',['excerpt: Save DB to disc.',['../d2/dce/md__g_1_2ids_2dragonfly_2docs_2basic_2save.html#autotoc_md41',1,'']]],
|
|
['excerpt_3a_20scheduled_20environment_20for_20extension_27',['excerpt: Scheduled Environment for extension.',['../d0/df6/md__g_1_2ids_2dragonfly_2docs_2core_2scheduler.html#autotoc_md137',1,'']]],
|
|
['excerpt_3a_20set_20a_20field_20value_20in_20the_20current_20client_20s_20hash_20table_20in_20dragonflyclient_28',['excerpt: Set a field value in the current client's hash table in DragonflyClient.',['../d0/df2/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_set.html#autotoc_md220',1,'']]],
|
|
['excerpt_3a_20set_20an_20element_20in_20a_20list_20stored_20at_20a_20key_20in_20dragonflyclient_29',['excerpt: Set an element in a list stored at a key in DragonflyClient.',['../d2/dc5/md__g_1_2ids_2dragonfly_2docs_2list_2list_set.html#autotoc_md330',1,'']]],
|
|
['excerpt_3a_20set_20multiple_20fields_20in_20the_20current_20client_20s_20hash_20table_20in_20dragonflyclient_30',['excerpt: Set multiple fields 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_3a_20set_20the_20specified_20field_20to_20the_20respective_20value_20in_20the_20hash_20stored_20at_20key_20from_20dragonflyclient_31',['excerpt: Set the specified field to the respective value in the hash stored at key from DragonflyClient.',['../d4/d99/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_set_id.html#autotoc_md248',1,'']]],
|
|
['excerpt_3a_20set_20the_20specified_20fields_20to_20their_20respective_20values_20in_20the_20hash_20stored_20at_20key_20from_20dragonflyclient_32',['excerpt: Set the specified fields to their respective values 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_3a_20set_20the_20value_20of_20stored_20key_20from_20dragonflyclient_33',['excerpt: Set the value of stored key from DragonflyClient.',['../d9/d9c/md__g_1_2ids_2dragonfly_2docs_2basic_2set.html#autotoc_md54',1,'']]],
|
|
['excerpt_3a_20test_20function_34',['excerpt: Test Function.',['../d6/d7e/md__g_1_2ids_2dragonfly_2docs_2core_2test.html#autotoc_md150',1,'']]],
|
|
['executed_35',['excerpt: Processes a queue of tasks to be executed.',['../d0/d0e/md__g_1_2ids_2dragonfly_2docs_2core_2process_queue.html#autotoc_md120',1,'']]],
|
|
['extension_36',['excerpt: Scheduled Environment for extension.',['../d0/df6/md__g_1_2ids_2dragonfly_2docs_2core_2scheduler.html#autotoc_md137',1,'']]],
|
|
['extension_20settings_37',['excerpt: Initial Extension settings.',['../dc/d36/md__g_1_2ids_2dragonfly_2docs_2core_2init.html#autotoc_md96',1,'']]],
|
|
['extension_20when_20data_20is_20too_20large_20to_20be_20returned_20in_20a_20single_20callback_38',['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,'']]],
|
|
['extension_3a_39',['Process a callback from the extension:',['../d0/df6/md__g_1_2ids_2dragonfly_2docs_2core_2scheduler.html#autotoc_md144',1,'']]]
|
|
];
|