dragonfly/api/html/search/all_12.js
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

66 lines
18 KiB
JavaScript

var searchData=
[
['s_20complete_20hash_20data_3a_0',['Retrieve a player's complete hash data:',['../d2/d23/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_get_all_id.html#autotoc_md199',1,'']]],
['s_20hash_20table_20in_20dragonflyclient_1',['s 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.']]],
['s_20loadout_20field_3a_2',['Retrieve a player's loadout field:',['../d2/d28/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_get_id.html#autotoc_md213',1,'']]],
['s_20loadout_20under_20their_20uid_3a_3',['Store a player's loadout under their UID:',['../d4/d99/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_set_id.html#autotoc_md255',1,'']]],
['s_20loadout_3a_4',['s loadout:',['../d9/de8/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_get.html#autotoc_md171',1,'Retrieve a player's loadout:'],['../d0/df2/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_set.html#autotoc_md227',1,'Store a player's loadout:']]],
['save_5',['save',['../d2/dce/md__g_1_2ids_2dragonfly_2docs_2basic_2save.html',1,'']]],
['save_20db_20to_20disc_6',['excerpt: Save DB to disc.',['../d2/dce/md__g_1_2ids_2dragonfly_2docs_2basic_2save.html#autotoc_md41',1,'']]],
['save_20function_20remotely_20from_20a_20client_3a_7',['Call the save function remotely from a client:',['../d2/dce/md__g_1_2ids_2dragonfly_2docs_2basic_2save.html#autotoc_md49',1,'']]],
['save_20the_20database_20without_20creating_20a_20backup_3a_8',['Save the database without creating a backup:',['../d2/dce/md__g_1_2ids_2dragonfly_2docs_2basic_2save.html#autotoc_md48',1,'']]],
['scheduled_20environment_20for_20extension_9',['excerpt: Scheduled Environment for extension.',['../d0/df6/md__g_1_2ids_2dragonfly_2docs_2core_2scheduler.html#autotoc_md137',1,'']]],
['scheduler_10',['scheduler',['../d0/df6/md__g_1_2ids_2dragonfly_2docs_2core_2scheduler.html',1,'']]],
['script_3a_11',['Use in a welcome script:',['../d4/d7c/md__g_1_2ids_2dragonfly_2docs_2core_2print_addon_name.html#autotoc_md115',1,'']]],
['send_20data_20to_20a_20specific_20client_3a_12',['Send data to a specific client:',['../d4/d43/md__g_1_2ids_2dragonfly_2docs_2core_2handler.html#autotoc_md90',1,'']]],
['send_20it_20to_20a_20specific_20client_3a_13',['send it to a specific client:',['../d9/de8/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_get.html#autotoc_md173',1,'Retrieve data and send it to a specific client:'],['../da/d08/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_get_all.html#autotoc_md187',1,'Retrieve data and send it to a specific client:'],['../d2/d23/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_get_all_id.html#autotoc_md201',1,'Retrieve data and send it to a specific client:'],['../d2/d28/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_get_id.html#autotoc_md215',1,'Retrieve data and send it to a specific client:'],['../d3/ddf/md__g_1_2ids_2dragonfly_2docs_2list_2list_get.html#autotoc_md303',1,'Retrieve data and send it to a specific client:']]],
['send_20to_20a_20specific_20client_3a_14',['Retrieve data on the server and send to a specific client:',['../d3/dcb/md__g_1_2ids_2dragonfly_2docs_2basic_2get.html#autotoc_md32',1,'']]],
['server_20and_20send_20to_20a_20specific_20client_3a_15',['Retrieve data on the server and send to a specific client:',['../d3/dcb/md__g_1_2ids_2dragonfly_2docs_2basic_2get.html#autotoc_md32',1,'']]],
['server_20from_20a_20client_3a_16',['Delete a key on the server from a client:',['../df/d12/md__g_1_2ids_2dragonfly_2docs_2basic_2delete.html#autotoc_md9',1,'']]],
['server_3a_17',['server:',['../df/d12/md__g_1_2ids_2dragonfly_2docs_2basic_2delete.html#autotoc_md8',1,'Delete a key in singleplayer or on the server:'],['../d0/df6/md__g_1_2ids_2dragonfly_2docs_2core_2scheduler.html#autotoc_md145',1,'Forward a callback to the server:'],['../d3/dcb/md__g_1_2ids_2dragonfly_2docs_2basic_2get.html#autotoc_md31',1,'Retrieve data in singleplayer or on the server:'],['../d6/d7e/md__g_1_2ids_2dragonfly_2docs_2core_2test.html#autotoc_md159',1,'Test from client to server:']]],
['set_18',['set',['../d9/d9c/md__g_1_2ids_2dragonfly_2docs_2basic_2set.html',1,'']]],
['set_20a_20field_20value_20in_20the_20current_20client_20s_20hash_20table_20in_20dragonflyclient_19',['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,'']]],
['set_20an_20element_20in_20a_20list_20stored_20at_20a_20key_20in_20dragonflyclient_20',['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,'']]],
['set_20function_20remotely_20from_20a_20client_3a_21',['Call the set function remotely from a client:',['../d9/d9c/md__g_1_2ids_2dragonfly_2docs_2basic_2set.html#autotoc_md63',1,'']]],
['set_20multiple_20fields_20in_20the_20current_20client_20s_20hash_20table_20in_20dragonflyclient_22',['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,'']]],
['set_20the_20specified_20field_20to_20the_20respective_20value_20in_20the_20hash_20stored_20at_20key_20from_20dragonflyclient_23',['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,'']]],
['set_20the_20specified_20fields_20to_20their_20respective_20values_20in_20the_20hash_20stored_20at_20key_20from_20dragonflyclient_24',['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,'']]],
['set_20the_20value_20of_20stored_20key_20from_20dragonflyclient_25',['excerpt: Set the value of stored key from DragonflyClient.',['../d9/d9c/md__g_1_2ids_2dragonfly_2docs_2basic_2set.html#autotoc_md54',1,'']]],
['settings_26',['excerpt: Initial Extension settings.',['../dc/d36/md__g_1_2ids_2dragonfly_2docs_2core_2init.html#autotoc_md96',1,'']]],
['settings_3a_27',['Store multiple player settings:',['../da/d74/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_set_bulk.html#autotoc_md242',1,'']]],
['simple_20array_3a_28',['Store a simple array:',['../d9/d9c/md__g_1_2ids_2dragonfly_2docs_2basic_2set.html#autotoc_md61',1,'']]],
['simple_20string_3a_29',['Test with a simple string:',['../d6/d7e/md__g_1_2ids_2dragonfly_2docs_2core_2test.html#autotoc_md157',1,'']]],
['single_20callback_30',['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,'']]],
['singleplayer_20or_20on_20the_20server_3a_31',['singleplayer or on the server:',['../df/d12/md__g_1_2ids_2dragonfly_2docs_2basic_2delete.html#autotoc_md8',1,'Delete a key in singleplayer or on the server:'],['../d3/dcb/md__g_1_2ids_2dragonfly_2docs_2basic_2get.html#autotoc_md31',1,'Retrieve data in singleplayer or on the server:']]],
['specific_20client_3a_32',['specific client:',['../dd/d3b/md__g_1_2ids_2dragonfly_2docs_2core_2add_task.html#autotoc_md76',1,'Add a player-specific task that returns data to a specific client:'],['../d9/de8/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_get.html#autotoc_md173',1,'Retrieve data and send it to a specific client:'],['../da/d08/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_get_all.html#autotoc_md187',1,'Retrieve data and send it to a specific client:'],['../d2/d23/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_get_all_id.html#autotoc_md201',1,'Retrieve data and send it to a specific client:'],['../d2/d28/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_get_id.html#autotoc_md215',1,'Retrieve data and send it to a specific client:'],['../d3/ddf/md__g_1_2ids_2dragonfly_2docs_2list_2list_get.html#autotoc_md303',1,'Retrieve data and send it to a specific client:'],['../d3/dcb/md__g_1_2ids_2dragonfly_2docs_2basic_2get.html#autotoc_md32',1,'Retrieve data on the server and send to a specific client:'],['../d4/d43/md__g_1_2ids_2dragonfly_2docs_2core_2handler.html#autotoc_md90',1,'Send data to a specific client:']]],
['specific_20event_20log_20entry_3a_33',['Retrieve a specific event log entry:',['../d3/ddf/md__g_1_2ids_2dragonfly_2docs_2list_2list_get.html#autotoc_md301',1,'']]],
['specific_20task_20that_20returns_20data_20to_20a_20specific_20client_3a_34',['Add a player-specific task that returns data to a specific client:',['../dd/d3b/md__g_1_2ids_2dragonfly_2docs_2core_2add_task.html#autotoc_md76',1,'']]],
['specific_20vehicle_20property_20with_20synchronous_20callback_3a_35',['Retrieve a specific vehicle property with synchronous callback:',['../d2/d28/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_get_id.html#autotoc_md214',1,'']]],
['specified_20field_20to_20the_20respective_20value_20in_20the_20hash_20stored_20at_20key_20from_20dragonflyclient_36',['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,'']]],
['specified_20fields_20to_20their_20respective_20values_20in_20the_20hash_20stored_20at_20key_20from_20dragonflyclient_37',['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,'']]],
['specified_20key_20from_20dragonflyclient_38',['excerpt: Remove the specified key from DragonflyClient.',['../df/d12/md__g_1_2ids_2dragonfly_2docs_2basic_2delete.html#autotoc_md1',1,'']]],
['specifying_20this_20as_20callback_20function_3a_39',['Test database retrieval by specifying this as callback function:',['../d6/d7e/md__g_1_2ids_2dragonfly_2docs_2core_2test.html#autotoc_md158',1,'']]],
['start_20processing_20the_20queue_20manually_3a_40',['Start processing the queue manually:',['../d0/d0e/md__g_1_2ids_2dragonfly_2docs_2core_2process_queue.html#autotoc_md127',1,'']]],
['store_20a_20player_20s_20loadout_20under_20their_20uid_3a_41',['Store a player's loadout under their UID:',['../d4/d99/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_set_id.html#autotoc_md255',1,'']]],
['store_20a_20player_20s_20loadout_3a_42',['Store a player's loadout:',['../d0/df2/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_set.html#autotoc_md227',1,'']]],
['store_20a_20simple_20array_3a_43',['Store a simple array:',['../d9/d9c/md__g_1_2ids_2dragonfly_2docs_2basic_2set.html#autotoc_md61',1,'']]],
['store_20data_20from_20a_20client_3a_44',['Store data from a client:',['../d0/df2/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_set.html#autotoc_md229',1,'']]],
['store_20multiple_20player_20settings_3a_45',['Store multiple player settings:',['../da/d74/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_set_bulk.html#autotoc_md242',1,'']]],
['store_20multiple_20vehicle_20properties_3a_46',['Store multiple vehicle properties:',['../de/da6/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_set_id_bulk.html#autotoc_md270',1,'']]],
['store_20player_20data_20from_20a_20client_3a_47',['Store player data from a client:',['../da/d74/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_set_bulk.html#autotoc_md243',1,'Store player data from a client:'],['../d4/d99/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_set_id.html#autotoc_md257',1,'Store player data from a client:'],['../de/da6/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_set_id_bulk.html#autotoc_md271',1,'Store player data from a client:']]],
['store_20player_20data_20under_20their_20uid_3a_48',['Store player data under their UID:',['../d9/d9c/md__g_1_2ids_2dragonfly_2docs_2basic_2set.html#autotoc_md62',1,'']]],
['store_20player_20loadout_20and_20position_3a_49',['Store player loadout and position:',['../da/d74/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_set_bulk.html#autotoc_md241',1,'Store player loadout and position:'],['../de/da6/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_set_id_bulk.html#autotoc_md269',1,'Store player loadout and position:']]],
['store_20player_20preferences_3a_50',['Store player preferences:',['../d0/df2/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_set.html#autotoc_md228',1,'']]],
['store_20vehicle_20data_3a_51',['Store vehicle data:',['../d4/d99/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_set_id.html#autotoc_md256',1,'']]],
['stored_20at_20a_20key_20from_20dragonflyclient_52',['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,'']]],
['stored_20at_20a_20key_20in_20dragonflyclient_53',['stored at a key in DragonflyClient',['../d1/d22/md__g_1_2ids_2dragonfly_2docs_2list_2list_remove.html#autotoc_md319',1,'excerpt: Remove an element from a list stored at a key in DragonflyClient.'],['../d2/dc5/md__g_1_2ids_2dragonfly_2docs_2list_2list_set.html#autotoc_md330',1,'excerpt: Set an element in a list stored at a key in DragonflyClient.']]],
['stored_20at_20key_20from_20dragonflyclient_54',['stored at key from DragonflyClient',['../da/d2c/md__g_1_2ids_2dragonfly_2docs_2list_2list_add.html#autotoc_md280',1,'excerpt: Add element to list 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.'],['../d3/ddf/md__g_1_2ids_2dragonfly_2docs_2list_2list_get.html#autotoc_md294',1,'excerpt: Get element of list 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.']]],
['stored_20key_20from_20dragonflyclient_55',['stored key from DragonflyClient',['../d3/dcb/md__g_1_2ids_2dragonfly_2docs_2basic_2get.html#autotoc_md24',1,'excerpt: Get the value of stored key from DragonflyClient.'],['../d9/d9c/md__g_1_2ids_2dragonfly_2docs_2basic_2set.html#autotoc_md54',1,'excerpt: Set the value of stored key from DragonflyClient.']]],
['string_3a_56',['Test with a simple string:',['../d6/d7e/md__g_1_2ids_2dragonfly_2docs_2core_2test.html#autotoc_md157',1,'']]],
['structure_57',['Function Documentation Structure',['../G:/ids/dragonfly/docs/README.md#autotoc_md354',1,'']]],
['synchronous_20_3a_58',['Process data with direct call (synchronous):',['../d4/d43/md__g_1_2ids_2dragonfly_2docs_2core_2handler.html#autotoc_md91',1,'']]],
['synchronous_20callback_3a_59',['synchronous callback:',['../d2/d28/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_get_id.html#autotoc_md214',1,'Retrieve a specific vehicle property with synchronous callback:'],['../d9/de8/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_get.html#autotoc_md172',1,'Retrieve data with synchronous callback:'],['../da/d08/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_get_all.html#autotoc_md186',1,'Retrieve data with synchronous callback:'],['../d3/ddf/md__g_1_2ids_2dragonfly_2docs_2list_2list_get.html#autotoc_md302',1,'Retrieve data with synchronous callback:'],['../d2/d23/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_get_all_id.html#autotoc_md200',1,'Retrieve vehicle data with synchronous callback:']]],
['syntax_60',['Syntax',['../df/d12/md__g_1_2ids_2dragonfly_2docs_2basic_2delete.html#autotoc_md4',1,'Syntax'],['../d4/d99/md__g_1_2ids_2dragonfly_2docs_2basic_2fetch.html#autotoc_md17',1,'Syntax'],['../d3/dcb/md__g_1_2ids_2dragonfly_2docs_2basic_2get.html#autotoc_md27',1,'Syntax'],['../d2/dce/md__g_1_2ids_2dragonfly_2docs_2basic_2save.html#autotoc_md44',1,'Syntax'],['../d9/d9c/md__g_1_2ids_2dragonfly_2docs_2basic_2set.html#autotoc_md57',1,'Syntax'],['../dd/d3b/md__g_1_2ids_2dragonfly_2docs_2core_2add_task.html#autotoc_md71',1,'Syntax'],['../d4/d43/md__g_1_2ids_2dragonfly_2docs_2core_2handler.html#autotoc_md85',1,'Syntax'],['../dc/d36/md__g_1_2ids_2dragonfly_2docs_2core_2init.html#autotoc_md99',1,'Syntax'],['../d4/d7c/md__g_1_2ids_2dragonfly_2docs_2core_2print_addon_name.html#autotoc_md110',1,'Syntax'],['../d0/d0e/md__g_1_2ids_2dragonfly_2docs_2core_2process_queue.html#autotoc_md123',1,'Syntax'],['../d0/df6/md__g_1_2ids_2dragonfly_2docs_2core_2scheduler.html#autotoc_md140',1,'Syntax'],['../d6/d7e/md__g_1_2ids_2dragonfly_2docs_2core_2test.html#autotoc_md153',1,'Syntax'],['../d9/de8/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_get.html#autotoc_md167',1,'Syntax'],['../da/d08/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_get_all.html#autotoc_md181',1,'Syntax'],['../d2/d23/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_get_all_id.html#autotoc_md195',1,'Syntax'],['../d2/d28/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_get_id.html#autotoc_md209',1,'Syntax'],['../d0/df2/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_set.html#autotoc_md223',1,'Syntax'],['../da/d74/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_set_bulk.html#autotoc_md237',1,'Syntax'],['../d4/d99/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_set_id.html#autotoc_md251',1,'Syntax'],['../de/da6/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_set_id_bulk.html#autotoc_md265',1,'Syntax'],['../da/d2c/md__g_1_2ids_2dragonfly_2docs_2list_2list_add.html#autotoc_md283',1,'Syntax'],['../d3/ddf/md__g_1_2ids_2dragonfly_2docs_2list_2list_get.html#autotoc_md297',1,'Syntax'],['../d9/db3/md__g_1_2ids_2dragonfly_2docs_2list_2list_load.html#autotoc_md311',1,'Syntax'],['../d1/d22/md__g_1_2ids_2dragonfly_2docs_2list_2list_remove.html#autotoc_md322',1,'Syntax'],['../d2/dc5/md__g_1_2ids_2dragonfly_2docs_2list_2list_set.html#autotoc_md333',1,'Syntax']]],
['system_20chat_61',['excerpt: Displays the addon name in system chat.',['../d4/d7c/md__g_1_2ids_2dragonfly_2docs_2core_2print_addon_name.html#autotoc_md107',1,'']]]
];