ramdb/api/html/search/all_12.js
Jacob Schmidt ee1dd91b7f
All checks were successful
Build / Build (push) Successful in 40s
feat: Add documentation for fetch function
This commit adds documentation for the `ramdb_db_fnc_fetch` function. The documentation explains the function's purpose, which is to handle data chunks received from the database extension when data is too large to be returned in a single callback. The documentation includes a title, icon, and excerpt for better readability and understanding.
2025-03-30 17:16:31 -05:00

76 lines
18 KiB
JavaScript

var searchData=
[
['s_20complete_20hash_20data_3a_0',['Retrieve a player's complete hash data:',['../d3/d33/md_docs_2hash_2hash_get_all_id.html#autotoc_md240',1,'']]],
['s_20hash_20data_3a_1',['Delete a player's hash data:',['../dc/d95/md_docs_2hash_2hash_delete_id.html#autotoc_md199',1,'']]],
['s_20hash_20table_2',['excerpt: Remove a field from the current client's hash table.',['../d9/d12/md_docs_2hash_2hash_remove.html#autotoc_md261',1,'']]],
['s_20hash_20table_20from_20database_3',['excerpt: Remove the current client's hash table from database.',['../d7/d91/md_docs_2hash_2hash_delete.html#autotoc_md178',1,'']]],
['s_20hash_20table_20from_20the_20server_3a_4',['Delete a client's hash table from the server:',['../d7/d91/md_docs_2hash_2hash_delete.html#autotoc_md186',1,'']]],
['s_20hash_20table_20in_20ramdb_5',['s hash table in RAMDb',['../dc/dae/md_docs_2hash_2hash_get.html#autotoc_md205',1,'excerpt: Get a field value from the current client's hash table in RAMDb.'],['../d8/d96/md_docs_2hash_2hash_get_all.html#autotoc_md219',1,'excerpt: Get all fields from the current client's hash table in RAMDb.'],['../d0/d68/md_docs_2hash_2hash_set.html#autotoc_md288',1,'excerpt: Set a field value in the current client's hash table in RAMDb.'],['../d9/dc1/md_docs_2hash_2hash_set_bulk.html#autotoc_md302',1,'excerpt: Set multiple fields in the current client's hash table in RAMDb.']]],
['s_20hash_20table_3a_6',['Delete the current client's hash table:',['../d7/d91/md_docs_2hash_2hash_delete.html#autotoc_md185',1,'']]],
['s_20loadout_20field_3a_7',['s loadout field:',['../d9/dae/md_docs_2hash_2hash_remove_id.html#autotoc_md281',1,'Remove a player's loadout field:'],['../d5/d27/md_docs_2hash_2hash_get_id.html#autotoc_md254',1,'Retrieve a player's loadout field:']]],
['s_20loadout_20under_20their_20uid_3a_8',['Store a player's loadout under their UID:',['../dc/db9/md_docs_2hash_2hash_set_id.html#autotoc_md323',1,'']]],
['s_20loadout_3a_9',['s loadout:',['../dc/dae/md_docs_2hash_2hash_get.html#autotoc_md212',1,'Retrieve a player's loadout:'],['../d0/d68/md_docs_2hash_2hash_set.html#autotoc_md295',1,'Store a player's loadout:']]],
['save_10',['save',['../d8/d12/md_docs_2basic_2save.html',1,'']]],
['save_20db_20to_20disc_11',['excerpt: Save DB to disc.',['../d8/d12/md_docs_2basic_2save.html#autotoc_md54',1,'']]],
['save_20function_20remotely_20from_20a_20client_3a_12',['Call the save function remotely from a client:',['../d8/d12/md_docs_2basic_2save.html#autotoc_md63',1,'']]],
['save_20the_20database_20and_20create_20a_20backup_3a_13',['Save the database and create a backup:',['../d8/d12/md_docs_2basic_2save.html#autotoc_md62',1,'']]],
['save_20the_20database_20without_20creating_20a_20backup_3a_14',['Save the database without creating a backup:',['../d8/d12/md_docs_2basic_2save.html#autotoc_md61',1,'']]],
['scheduled_20environment_20for_20extension_15',['excerpt: Scheduled Environment for extension.',['../d8/df5/md_docs_2core_2scheduler.html#autotoc_md151',1,'']]],
['scheduler_16',['scheduler',['../d8/df5/md_docs_2core_2scheduler.html',1,'']]],
['script_3a_17',['Use in a welcome script:',['../d7/d81/md_docs_2core_2print_addon_name.html#autotoc_md129',1,'']]],
['send_20data_20to_20a_20specific_20client_3a_18',['Send data to a specific client:',['../df/d1b/md_docs_2core_2handler.html#autotoc_md104',1,'']]],
['send_20it_20to_20a_20specific_20client_3a_19',['send it to a specific client:',['../dc/dae/md_docs_2hash_2hash_get.html#autotoc_md214',1,'Retrieve data and send it to a specific client:'],['../d8/d96/md_docs_2hash_2hash_get_all.html#autotoc_md228',1,'Retrieve data and send it to a specific client:'],['../d3/d33/md_docs_2hash_2hash_get_all_id.html#autotoc_md242',1,'Retrieve data and send it to a specific client:'],['../d5/d27/md_docs_2hash_2hash_get_id.html#autotoc_md256',1,'Retrieve data and send it to a specific client:'],['../d7/d58/md_docs_2list_2list_get.html#autotoc_md382',1,'Retrieve data and send it to a specific client:']]],
['send_20to_20a_20specific_20client_3a_20',['Retrieve data on the server and send to a specific client:',['../d1/d9f/md_docs_2basic_2get.html#autotoc_md32',1,'']]],
['server_20and_20send_20to_20a_20specific_20client_3a_21',['Retrieve data on the server and send to a specific client:',['../d1/d9f/md_docs_2basic_2get.html#autotoc_md32',1,'']]],
['server_20from_20a_20client_3a_22',['Delete a key on the server from a client:',['../d6/dff/md_docs_2basic_2delete.html#autotoc_md9',1,'']]],
['server_3a_23',['server:',['../d7/d91/md_docs_2hash_2hash_delete.html#autotoc_md186',1,'Delete a client's hash table from the server:'],['../d6/dff/md_docs_2basic_2delete.html#autotoc_md8',1,'Delete a key in singleplayer or on the server:'],['../d8/df5/md_docs_2core_2scheduler.html#autotoc_md159',1,'Forward a callback to the server:'],['../da/d36/md_docs_2basic_2load.html#autotoc_md44',1,'Load the database on the server:'],['../d1/d9f/md_docs_2basic_2get.html#autotoc_md31',1,'Retrieve data in singleplayer or on the server:'],['../de/d91/md_docs_2core_2test.html#autotoc_md173',1,'Test from client to server:']]],
['set_24',['set',['../dc/d24/md_docs_2basic_2set.html',1,'']]],
['set_20a_20field_20value_20in_20the_20current_20client_20s_20hash_20table_20in_20ramdb_25',['excerpt: Set a field value in the current client's hash table in RAMDb.',['../d0/d68/md_docs_2hash_2hash_set.html#autotoc_md288',1,'']]],
['set_20an_20element_20in_20a_20list_20stored_20at_20a_20key_20in_20ramdb_26',['excerpt: Set an element in a list stored at a key in RAMDb.',['../d5/ddd/md_docs_2list_2list_set.html#autotoc_md409',1,'']]],
['set_20function_20remotely_20from_20a_20client_3a_27',['Call the set function remotely from a client:',['../dc/d24/md_docs_2basic_2set.html#autotoc_md77',1,'']]],
['set_20multiple_20fields_20in_20the_20current_20client_20s_20hash_20table_20in_20ramdb_28',['excerpt: Set multiple fields in the current client's hash table in RAMDb.',['../d9/dc1/md_docs_2hash_2hash_set_bulk.html#autotoc_md302',1,'']]],
['set_20the_20specified_20field_20to_20the_20respective_20value_20in_20the_20hash_20stored_20at_20key_20from_20ramdb_29',['excerpt: Set the specified field to the respective value in the hash stored at key from RAMDb.',['../dc/db9/md_docs_2hash_2hash_set_id.html#autotoc_md316',1,'']]],
['set_20the_20specified_20fields_20to_20their_20respective_20values_20in_20the_20hash_20stored_20at_20key_20from_20ramdb_30',['excerpt: Set the specified fields to their respective values in the hash stored at key from RAMDb.',['../d2/d02/md_docs_2hash_2hash_set_id_bulk.html#autotoc_md330',1,'']]],
['set_20the_20value_20of_20stored_20key_20from_20ramdb_31',['excerpt: Set the value of stored key from RAMDb.',['../dc/d24/md_docs_2basic_2set.html#autotoc_md68',1,'']]],
['settings_32',['excerpt: Initial Extension settings.',['../df/df2/md_docs_2core_2init.html#autotoc_md110',1,'']]],
['settings_3a_33',['Store multiple player settings:',['../d9/dc1/md_docs_2hash_2hash_set_bulk.html#autotoc_md310',1,'']]],
['simple_20array_3a_34',['Store a simple array:',['../dc/d24/md_docs_2basic_2set.html#autotoc_md75',1,'']]],
['simple_20string_3a_35',['Test with a simple string:',['../de/d91/md_docs_2core_2test.html#autotoc_md171',1,'']]],
['single_20callback_36',['excerpt: Handles data chunks received from the database extension when data is too large to be returned in a single callback.',['../d8/d05/md_docs_2basic_2fetch.html#autotoc_md14',1,'']]],
['singleplayer_20or_20on_20the_20server_3a_37',['singleplayer or on the server:',['../d6/dff/md_docs_2basic_2delete.html#autotoc_md8',1,'Delete a key in singleplayer or on the server:'],['../d1/d9f/md_docs_2basic_2get.html#autotoc_md31',1,'Retrieve data in singleplayer or on the server:']]],
['specific_20client_3a_38',['specific client:',['../d3/df8/md_docs_2core_2add_task.html#autotoc_md90',1,'Add a player-specific task that returns data to a specific client:'],['../dc/dae/md_docs_2hash_2hash_get.html#autotoc_md214',1,'Retrieve data and send it to a specific client:'],['../d8/d96/md_docs_2hash_2hash_get_all.html#autotoc_md228',1,'Retrieve data and send it to a specific client:'],['../d3/d33/md_docs_2hash_2hash_get_all_id.html#autotoc_md242',1,'Retrieve data and send it to a specific client:'],['../d5/d27/md_docs_2hash_2hash_get_id.html#autotoc_md256',1,'Retrieve data and send it to a specific client:'],['../d7/d58/md_docs_2list_2list_get.html#autotoc_md382',1,'Retrieve data and send it to a specific client:'],['../d1/d9f/md_docs_2basic_2get.html#autotoc_md32',1,'Retrieve data on the server and send to a specific client:'],['../df/d1b/md_docs_2core_2handler.html#autotoc_md104',1,'Send data to a specific client:']]],
['specific_20event_20log_20entry_3a_39',['Retrieve a specific event log entry:',['../d7/d58/md_docs_2list_2list_get.html#autotoc_md380',1,'']]],
['specific_20field_3a_40',['Remove a specific field:',['../d9/d12/md_docs_2hash_2hash_remove.html#autotoc_md268',1,'']]],
['specific_20hash_20table_41',['excerpt: Remove a field from a specific hash table.',['../d9/dae/md_docs_2hash_2hash_remove_id.html#autotoc_md274',1,'']]],
['specific_20hash_20table_20from_20database_42',['excerpt: Remove a specific hash table from database.',['../dc/d95/md_docs_2hash_2hash_delete_id.html#autotoc_md191',1,'']]],
['specific_20hash_20table_3a_43',['Delete a specific hash table:',['../dc/d95/md_docs_2hash_2hash_delete_id.html#autotoc_md198',1,'']]],
['specific_20task_20that_20returns_20data_20to_20a_20specific_20client_3a_44',['Add a player-specific task that returns data to a specific client:',['../d3/df8/md_docs_2core_2add_task.html#autotoc_md90',1,'']]],
['specific_20vehicle_20property_20with_20synchronous_20callback_3a_45',['Retrieve a specific vehicle property with synchronous callback:',['../d5/d27/md_docs_2hash_2hash_get_id.html#autotoc_md255',1,'']]],
['specified_20field_20to_20the_20respective_20value_20in_20the_20hash_20stored_20at_20key_20from_20ramdb_46',['excerpt: Set the specified field to the respective value in the hash stored at key from RAMDb.',['../dc/db9/md_docs_2hash_2hash_set_id.html#autotoc_md316',1,'']]],
['specified_20fields_20to_20their_20respective_20values_20in_20the_20hash_20stored_20at_20key_20from_20ramdb_47',['excerpt: Set the specified fields to their respective values in the hash stored at key from RAMDb.',['../d2/d02/md_docs_2hash_2hash_set_id_bulk.html#autotoc_md330',1,'']]],
['specified_20key_20from_20ramdb_48',['excerpt: Remove the specified key from RAMDb.',['../d6/dff/md_docs_2basic_2delete.html#autotoc_md1',1,'']]],
['specifying_20this_20as_20callback_20function_3a_49',['Test database retrieval by specifying this as callback function:',['../de/d91/md_docs_2core_2test.html#autotoc_md172',1,'']]],
['start_20processing_20the_20queue_20manually_3a_50',['Start processing the queue manually:',['../de/dc8/md_docs_2core_2process_queue.html#autotoc_md141',1,'']]],
['store_20a_20player_20s_20loadout_20under_20their_20uid_3a_51',['Store a player's loadout under their UID:',['../dc/db9/md_docs_2hash_2hash_set_id.html#autotoc_md323',1,'']]],
['store_20a_20player_20s_20loadout_3a_52',['Store a player's loadout:',['../d0/d68/md_docs_2hash_2hash_set.html#autotoc_md295',1,'']]],
['store_20a_20simple_20array_3a_53',['Store a simple array:',['../dc/d24/md_docs_2basic_2set.html#autotoc_md75',1,'']]],
['store_20data_20from_20a_20client_3a_54',['Store data from a client:',['../d0/d68/md_docs_2hash_2hash_set.html#autotoc_md297',1,'']]],
['store_20multiple_20player_20settings_3a_55',['Store multiple player settings:',['../d9/dc1/md_docs_2hash_2hash_set_bulk.html#autotoc_md310',1,'']]],
['store_20multiple_20vehicle_20properties_3a_56',['Store multiple vehicle properties:',['../d2/d02/md_docs_2hash_2hash_set_id_bulk.html#autotoc_md338',1,'']]],
['store_20player_20data_20from_20a_20client_3a_57',['Store player data from a client:',['../d9/dc1/md_docs_2hash_2hash_set_bulk.html#autotoc_md311',1,'Store player data from a client:'],['../dc/db9/md_docs_2hash_2hash_set_id.html#autotoc_md325',1,'Store player data from a client:'],['../d2/d02/md_docs_2hash_2hash_set_id_bulk.html#autotoc_md339',1,'Store player data from a client:']]],
['store_20player_20data_20under_20their_20uid_3a_58',['Store player data under their UID:',['../dc/d24/md_docs_2basic_2set.html#autotoc_md76',1,'']]],
['store_20player_20loadout_20and_20position_3a_59',['Store player loadout and position:',['../d9/dc1/md_docs_2hash_2hash_set_bulk.html#autotoc_md309',1,'Store player loadout and position:'],['../d2/d02/md_docs_2hash_2hash_set_id_bulk.html#autotoc_md337',1,'Store player loadout and position:']]],
['store_20player_20preferences_3a_60',['Store player preferences:',['../d0/d68/md_docs_2hash_2hash_set.html#autotoc_md296',1,'']]],
['store_20vehicle_20data_3a_61',['Store vehicle data:',['../dc/db9/md_docs_2hash_2hash_set_id.html#autotoc_md324',1,'']]],
['stored_20at_20a_20key_20from_20ramdb_62',['stored at a key from RAMDb',['../d1/d1c/md_docs_2list_2list_delete.html#autotoc_md362',1,'excerpt: Delete an entire list stored at a key from RAMDb.'],['../d1/d93/md_docs_2list_2list_load.html#autotoc_md387',1,'excerpt: Get all elements of a list stored at a key from RAMDb.']]],
['stored_20at_20a_20key_20in_20ramdb_63',['stored at a key in RAMDb',['../d6/d64/md_docs_2list_2list_remove.html#autotoc_md398',1,'excerpt: Remove an element from a list stored at a key in RAMDb.'],['../d5/ddd/md_docs_2list_2list_set.html#autotoc_md409',1,'excerpt: Set an element in a list stored at a key in RAMDb.']]],
['stored_20at_20key_20from_20ramdb_64',['stored at key from RAMDb',['../dd/dca/md_docs_2list_2list_add.html#autotoc_md348',1,'excerpt: Add element to list stored at key from RAMDb.'],['../d3/d33/md_docs_2hash_2hash_get_all_id.html#autotoc_md233',1,'excerpt: Get all fields and values from the hash stored at key from RAMDb.'],['../d7/d58/md_docs_2list_2list_get.html#autotoc_md373',1,'excerpt: Get element of list stored at key from RAMDb.'],['../d5/d27/md_docs_2hash_2hash_get_id.html#autotoc_md247',1,'excerpt: Get the value associated with field in hash stored at key from RAMDb.'],['../dc/db9/md_docs_2hash_2hash_set_id.html#autotoc_md316',1,'excerpt: Set the specified field to the respective value in the hash stored at key from RAMDb.'],['../d2/d02/md_docs_2hash_2hash_set_id_bulk.html#autotoc_md330',1,'excerpt: Set the specified fields to their respective values in the hash stored at key from RAMDb.']]],
['stored_20key_20from_20ramdb_65',['stored key from RAMDb',['../d1/d9f/md_docs_2basic_2get.html#autotoc_md24',1,'excerpt: Get the value of stored key from RAMDb.'],['../dc/d24/md_docs_2basic_2set.html#autotoc_md68',1,'excerpt: Set the value of stored key from RAMDb.']]],
['string_3a_66',['Test with a simple string:',['../de/d91/md_docs_2core_2test.html#autotoc_md171',1,'']]],
['structure_67',['Function Documentation Structure',['../G:/ids/ramdb/docs/README.md#autotoc_md433',1,'']]],
['synchronous_20_3a_68',['Process data with direct call (synchronous):',['../df/d1b/md_docs_2core_2handler.html#autotoc_md105',1,'']]],
['synchronous_20callback_3a_69',['synchronous callback:',['../d5/d27/md_docs_2hash_2hash_get_id.html#autotoc_md255',1,'Retrieve a specific vehicle property with synchronous callback:'],['../dc/dae/md_docs_2hash_2hash_get.html#autotoc_md213',1,'Retrieve data with synchronous callback:'],['../d8/d96/md_docs_2hash_2hash_get_all.html#autotoc_md227',1,'Retrieve data with synchronous callback:'],['../d7/d58/md_docs_2list_2list_get.html#autotoc_md381',1,'Retrieve data with synchronous callback:'],['../d3/d33/md_docs_2hash_2hash_get_all_id.html#autotoc_md241',1,'Retrieve vehicle data with synchronous callback:']]],
['syntax_70',['Syntax',['../d6/dff/md_docs_2basic_2delete.html#autotoc_md4',1,'Syntax'],['../d8/d05/md_docs_2basic_2fetch.html#autotoc_md17',1,'Syntax'],['../d1/d9f/md_docs_2basic_2get.html#autotoc_md27',1,'Syntax'],['../da/d36/md_docs_2basic_2load.html#autotoc_md40',1,'Syntax'],['../d8/d12/md_docs_2basic_2save.html#autotoc_md57',1,'Syntax'],['../dc/d24/md_docs_2basic_2set.html#autotoc_md71',1,'Syntax'],['../d3/df8/md_docs_2core_2add_task.html#autotoc_md85',1,'Syntax'],['../df/d1b/md_docs_2core_2handler.html#autotoc_md99',1,'Syntax'],['../df/df2/md_docs_2core_2init.html#autotoc_md113',1,'Syntax'],['../d7/d81/md_docs_2core_2print_addon_name.html#autotoc_md124',1,'Syntax'],['../de/dc8/md_docs_2core_2process_queue.html#autotoc_md137',1,'Syntax'],['../d8/df5/md_docs_2core_2scheduler.html#autotoc_md154',1,'Syntax'],['../de/d91/md_docs_2core_2test.html#autotoc_md167',1,'Syntax'],['../d7/d91/md_docs_2hash_2hash_delete.html#autotoc_md181',1,'Syntax'],['../dc/d95/md_docs_2hash_2hash_delete_id.html#autotoc_md194',1,'Syntax'],['../dc/dae/md_docs_2hash_2hash_get.html#autotoc_md208',1,'Syntax'],['../d8/d96/md_docs_2hash_2hash_get_all.html#autotoc_md222',1,'Syntax'],['../d3/d33/md_docs_2hash_2hash_get_all_id.html#autotoc_md236',1,'Syntax'],['../d5/d27/md_docs_2hash_2hash_get_id.html#autotoc_md250',1,'Syntax'],['../d9/d12/md_docs_2hash_2hash_remove.html#autotoc_md264',1,'Syntax'],['../d9/dae/md_docs_2hash_2hash_remove_id.html#autotoc_md277',1,'Syntax'],['../d0/d68/md_docs_2hash_2hash_set.html#autotoc_md291',1,'Syntax'],['../d9/dc1/md_docs_2hash_2hash_set_bulk.html#autotoc_md305',1,'Syntax'],['../dc/db9/md_docs_2hash_2hash_set_id.html#autotoc_md319',1,'Syntax'],['../d2/d02/md_docs_2hash_2hash_set_id_bulk.html#autotoc_md333',1,'Syntax'],['../dd/dca/md_docs_2list_2list_add.html#autotoc_md351',1,'Syntax'],['../d1/d1c/md_docs_2list_2list_delete.html#autotoc_md365',1,'Syntax'],['../d7/d58/md_docs_2list_2list_get.html#autotoc_md376',1,'Syntax'],['../d1/d93/md_docs_2list_2list_load.html#autotoc_md390',1,'Syntax'],['../d6/d64/md_docs_2list_2list_remove.html#autotoc_md401',1,'Syntax'],['../d5/ddd/md_docs_2list_2list_set.html#autotoc_md412',1,'Syntax']]],
['system_20chat_71',['excerpt: Displays the addon name in system chat.',['../d7/d81/md_docs_2core_2print_addon_name.html#autotoc_md121',1,'']]]
];