ee1dd91b7f
All checks were successful
Build / Build (push) Successful in 40s
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.
45 lines
5.5 KiB
TeX
45 lines
5.5 KiB
TeX
\chapter{hash\+Delete}
|
|
\hypertarget{md_docs_2hash_2hash_delete}{}\label{md_docs_2hash_2hash_delete}\index{hashDelete@{hashDelete}}
|
|
\hypertarget{md_docs_2hash_2hash_delete_autotoc_md177}{}\doxysubsection{\texorpdfstring{autotoc\+\_\+md177}{autotoc\+\_\+md177}}\label{md_docs_2hash_2hash_delete_autotoc_md177}
|
|
title\+: Arma\+RAMDb -\/ Hash Delete icon\+: mdi\+:file-\/text-\/outline \hypertarget{md_docs_2hash_2hash_delete_autotoc_md178}{}\doxysubsection{\texorpdfstring{excerpt\+: Remove the current client\textquotesingle{}s hash table from database.}{excerpt\+: Remove the current client\textquotesingle{}s hash table from database.}}\label{md_docs_2hash_2hash_delete_autotoc_md178}
|
|
\hypertarget{md_docs_2hash_2hash_delete_autotoc_md179}{}\doxysection{\texorpdfstring{ramdb\+\_\+db\+\_\+fnc\+\_\+hash\+Delete}{ramdb\+\_\+db\+\_\+fnc\+\_\+hash\+Delete}}\label{md_docs_2hash_2hash_delete_autotoc_md179}
|
|
\hypertarget{md_docs_2hash_2hash_delete_autotoc_md180}{}\doxysubsection{\texorpdfstring{Description}{Description}}\label{md_docs_2hash_2hash_delete_autotoc_md180}
|
|
Removes the hash table associated with the current client/player from the database. Unlike {\ttfamily hash\+Delete\+Id}, this function automatically retrieves the appropriate hash ID based on the caller\textquotesingle{}s identity, making it more convenient for removing the current client\textquotesingle{}s hash data. This is useful for cleanup operations when a player disconnects or when resetting a client\textquotesingle{}s stored data.\hypertarget{md_docs_2hash_2hash_delete_autotoc_md181}{}\doxysubsection{\texorpdfstring{Syntax}{Syntax}}\label{md_docs_2hash_2hash_delete_autotoc_md181}
|
|
|
|
\begin{DoxyCode}{0}
|
|
\DoxyCodeLine{[]\ call\ ramdb\_db\_fnc\_hashDelete}
|
|
|
|
\end{DoxyCode}
|
|
\hypertarget{md_docs_2hash_2hash_delete_autotoc_md182}{}\doxysubsection{\texorpdfstring{Parameters}{Parameters}}\label{md_docs_2hash_2hash_delete_autotoc_md182}
|
|
None. This function automatically determines the hash ID based on the calling client.\hypertarget{md_docs_2hash_2hash_delete_autotoc_md183}{}\doxysubsection{\texorpdfstring{Return Value}{Return Value}}\label{md_docs_2hash_2hash_delete_autotoc_md183}
|
|
None. The operation runs synchronously to delete the hash table for the current client.\hypertarget{md_docs_2hash_2hash_delete_autotoc_md184}{}\doxysubsection{\texorpdfstring{Examples}{Examples}}\label{md_docs_2hash_2hash_delete_autotoc_md184}
|
|
\hypertarget{md_docs_2hash_2hash_delete_autotoc_md185}{}\doxysubsubsection{\texorpdfstring{Delete the current client\textquotesingle{}s hash table\+:}{Delete the current client\textquotesingle{}s hash table\+:}}\label{md_docs_2hash_2hash_delete_autotoc_md185}
|
|
|
|
\begin{DoxyCode}{0}
|
|
\DoxyCodeLine{[]\ call\ ramdb\_db\_fnc\_hashDelete;}
|
|
|
|
\end{DoxyCode}
|
|
\hypertarget{md_docs_2hash_2hash_delete_autotoc_md186}{}\doxysubsubsection{\texorpdfstring{Delete a client\textquotesingle{}s hash table from the server\+:}{Delete a client\textquotesingle{}s hash table from the server\+:}}\label{md_docs_2hash_2hash_delete_autotoc_md186}
|
|
|
|
\begin{DoxyCode}{0}
|
|
\DoxyCodeLine{[]\ remoteExecCall\ ["{}ramdb\_db\_fnc\_hashDelete"{},\ 2,\ false];}
|
|
|
|
\end{DoxyCode}
|
|
\hypertarget{md_docs_2hash_2hash_delete_autotoc_md187}{}\doxysubsection{\texorpdfstring{Notes}{Notes}}\label{md_docs_2hash_2hash_delete_autotoc_md187}
|
|
|
|
\begin{DoxyItemize}
|
|
\item This function only removes the hash table for the current client/player, not all hash tables
|
|
\item It\textquotesingle{}s similar to {\ttfamily hash\+Delete\+Id} but automatically determines the appropriate ID
|
|
\item Cannot be undone unless you have a backup
|
|
\item Should be used during player disconnection or when resetting a player\textquotesingle{}s data
|
|
\item Useful for cleanup operations to prevent data buildup from disconnected players
|
|
\item More convenient than {\ttfamily hash\+Delete\+Id} when you want to remove the calling client\textquotesingle{}s data
|
|
\item All operations are logged for debugging purposes
|
|
\end{DoxyItemize}\hypertarget{md_docs_2hash_2hash_delete_autotoc_md188}{}\doxysubsection{\texorpdfstring{Related Functions}{Related Functions}}\label{md_docs_2hash_2hash_delete_autotoc_md188}
|
|
|
|
\begin{DoxyItemize}
|
|
\item {\ttfamily ramdb\+\_\+db\+\_\+fnc\+\_\+hash\+Delete\+Id}\+: Removes a specific hash ID (when you need to specify the ID)
|
|
\item {\ttfamily ramdb\+\_\+db\+\_\+fnc\+\_\+hash\+Set}\+: Sets a value in the hash table
|
|
\item {\ttfamily ramdb\+\_\+db\+\_\+fnc\+\_\+hash\+Get}\+: Retrieves a value from the hash table
|
|
\end{DoxyItemize}\hypertarget{md_docs_2hash_2hash_delete_autotoc_md189}{}\doxysubsection{\texorpdfstring{Links}{Links}}\label{md_docs_2hash_2hash_delete_autotoc_md189}
|
|
\doxysectlink{md_docs_2hash_2hash_delete}{Hash Delete}{0} \texorpdfstring{$\vert$}{|} \doxysectlink{md_docs_2hash_2hash_delete_id}{Hash Delete ID}{0} \texorpdfstring{$\vert$}{|} \doxysectlink{md_docs_2hash_2hash_get}{Hash Get}{0} \texorpdfstring{$\vert$}{|} \doxysectlink{md_docs_2hash_2hash_get_all}{Hash Get All}{0} \texorpdfstring{$\vert$}{|} \doxysectlink{md_docs_2hash_2hash_get_all_id}{Hash Get All ID}{0} \texorpdfstring{$\vert$}{|} \doxysectlink{md_docs_2hash_2hash_get_id}{Hash Get ID}{0} \texorpdfstring{$\vert$}{|} \doxysectlink{md_docs_2hash_2hash_remove}{Hash Remove}{0} \texorpdfstring{$\vert$}{|} \doxysectlink{md_docs_2hash_2hash_remove_id}{Hash Remove ID}{0} \texorpdfstring{$\vert$}{|} \doxysectlink{md_docs_2hash_2hash_set}{Hash Set}{0} \texorpdfstring{$\vert$}{|} \doxysectlink{md_docs_2hash_2hash_set_bulk}{Hash Set Bulk}{0} \texorpdfstring{$\vert$}{|} \doxysectlink{md_docs_2hash_2hash_set_id}{Hash Set ID}{0} \texorpdfstring{$\vert$}{|} \doxysectlink{md_docs_2hash_2hash_set_id_bulk}{Hash Set ID Bulk}{0} |