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.
60 lines
6.4 KiB
TeX
60 lines
6.4 KiB
TeX
\chapter{hash\+Remove}
|
|
\hypertarget{md_docs_2hash_2hash_remove}{}\label{md_docs_2hash_2hash_remove}\index{hashRemove@{hashRemove}}
|
|
\hypertarget{md_docs_2hash_2hash_remove_autotoc_md260}{}\doxysubsection{\texorpdfstring{autotoc\+\_\+md260}{autotoc\+\_\+md260}}\label{md_docs_2hash_2hash_remove_autotoc_md260}
|
|
title\+: Arma\+RAMDb -\/ Hash Remove icon\+: mdi\+:file-\/text-\/outline \hypertarget{md_docs_2hash_2hash_remove_autotoc_md261}{}\doxysubsection{\texorpdfstring{excerpt\+: Remove a field from the current client\textquotesingle{}s hash table.}{excerpt\+: Remove a field from the current client\textquotesingle{}s hash table.}}\label{md_docs_2hash_2hash_remove_autotoc_md261}
|
|
\hypertarget{md_docs_2hash_2hash_remove_autotoc_md262}{}\doxysection{\texorpdfstring{ramdb\+\_\+db\+\_\+fnc\+\_\+hash\+Remove}{ramdb\+\_\+db\+\_\+fnc\+\_\+hash\+Remove}}\label{md_docs_2hash_2hash_remove_autotoc_md262}
|
|
\hypertarget{md_docs_2hash_2hash_remove_autotoc_md263}{}\doxysubsection{\texorpdfstring{Description}{Description}}\label{md_docs_2hash_2hash_remove_autotoc_md263}
|
|
Removes a specific field from the hash table associated with the current client/player. This function automatically determines the appropriate hash ID based on the caller\textquotesingle{}s identity, making it more convenient than {\ttfamily hash\+Remove\+Id} which requires manually specifying an ID. It deletes a single field and its associated value without affecting other fields in the client\textquotesingle{}s hash table.\hypertarget{md_docs_2hash_2hash_remove_autotoc_md264}{}\doxysubsection{\texorpdfstring{Syntax}{Syntax}}\label{md_docs_2hash_2hash_remove_autotoc_md264}
|
|
|
|
\begin{DoxyCode}{0}
|
|
\DoxyCodeLine{[\_keyField]\ call\ ramdb\_db\_fnc\_hashRemove}
|
|
|
|
\end{DoxyCode}
|
|
\hypertarget{md_docs_2hash_2hash_remove_autotoc_md265}{}\doxysubsection{\texorpdfstring{Parameters}{Parameters}}\label{md_docs_2hash_2hash_remove_autotoc_md265}
|
|
\tabulinesep=1mm
|
|
\begin{longtabu}spread 0pt [c]{*{4}{|X[-1]}|}
|
|
\hline
|
|
\PBS\centering \cellcolor{\tableheadbgcolor}\textbf{ Parameter }&\PBS\centering \cellcolor{\tableheadbgcolor}\textbf{ Type }&\PBS\centering \cellcolor{\tableheadbgcolor}\textbf{ Description }&\PBS\centering \cellcolor{\tableheadbgcolor}\textbf{ Default }\\\cline{1-4}
|
|
\endfirsthead
|
|
\hline
|
|
\endfoot
|
|
\hline
|
|
\PBS\centering \cellcolor{\tableheadbgcolor}\textbf{ Parameter }&\PBS\centering \cellcolor{\tableheadbgcolor}\textbf{ Type }&\PBS\centering \cellcolor{\tableheadbgcolor}\textbf{ Description }&\PBS\centering \cellcolor{\tableheadbgcolor}\textbf{ Default }\\\cline{1-4}
|
|
\endhead
|
|
{\ttfamily \+\_\+key\+Field} &String &Name of the field to be removed &"{}"{} \\\cline{1-4}
|
|
\end{longtabu}
|
|
\hypertarget{md_docs_2hash_2hash_remove_autotoc_md266}{}\doxysubsection{\texorpdfstring{Return Value}{Return Value}}\label{md_docs_2hash_2hash_remove_autotoc_md266}
|
|
None. The operation runs synchronously to remove the field.\hypertarget{md_docs_2hash_2hash_remove_autotoc_md267}{}\doxysubsection{\texorpdfstring{Examples}{Examples}}\label{md_docs_2hash_2hash_remove_autotoc_md267}
|
|
\hypertarget{md_docs_2hash_2hash_remove_autotoc_md268}{}\doxysubsubsection{\texorpdfstring{Remove a specific field\+:}{Remove a specific field\+:}}\label{md_docs_2hash_2hash_remove_autotoc_md268}
|
|
|
|
\begin{DoxyCode}{0}
|
|
\DoxyCodeLine{["{}loadout"{}]\ call\ ramdb\_db\_fnc\_hashRemove;}
|
|
|
|
\end{DoxyCode}
|
|
\hypertarget{md_docs_2hash_2hash_remove_autotoc_md269}{}\doxysubsubsection{\texorpdfstring{Remove a field remotely\+:}{Remove a field remotely\+:}}\label{md_docs_2hash_2hash_remove_autotoc_md269}
|
|
|
|
\begin{DoxyCode}{0}
|
|
\DoxyCodeLine{["{}playerSettings"{}]\ remoteExecCall\ ["{}ramdb\_db\_fnc\_hashRemove"{},\ 2,\ false];}
|
|
|
|
\end{DoxyCode}
|
|
\hypertarget{md_docs_2hash_2hash_remove_autotoc_md270}{}\doxysubsection{\texorpdfstring{Notes}{Notes}}\label{md_docs_2hash_2hash_remove_autotoc_md270}
|
|
|
|
\begin{DoxyItemize}
|
|
\item Only removes a single field from the current client\textquotesingle{}s hash table
|
|
\item Validates that the key field parameter is not empty before proceeding
|
|
\item Does not affect other fields in the hash table
|
|
\item If the field doesn\textquotesingle{}t exist, the operation has no effect
|
|
\item This function automatically determines which hash table to use based on the caller\textquotesingle{}s identity
|
|
\item Use {\ttfamily hash\+Remove\+Id} when you need to specify a particular hash table by ID
|
|
\item The operation is executed immediately and synchronously
|
|
\item All operations are logged for debugging purposes
|
|
\end{DoxyItemize}\hypertarget{md_docs_2hash_2hash_remove_autotoc_md271}{}\doxysubsection{\texorpdfstring{Related Functions}{Related Functions}}\label{md_docs_2hash_2hash_remove_autotoc_md271}
|
|
|
|
\begin{DoxyItemize}
|
|
\item {\ttfamily ramdb\+\_\+db\+\_\+fnc\+\_\+hash\+Remove\+Id}\+: Removes a specific field from a specific hash table (when you need to specify the ID)
|
|
\item {\ttfamily ramdb\+\_\+db\+\_\+fnc\+\_\+hash\+Delete}\+: Removes the current client\textquotesingle{}s hash table
|
|
\item {\ttfamily ramdb\+\_\+db\+\_\+fnc\+\_\+hash\+Delete\+Id}\+: Removes a specific hash table
|
|
\item {\ttfamily ramdb\+\_\+db\+\_\+fnc\+\_\+hash\+Set}\+: Sets a field value in the current client\textquotesingle{}s hash table
|
|
\item {\ttfamily ramdb\+\_\+db\+\_\+fnc\+\_\+hash\+Get}\+: Retrieves a field value from the current client\textquotesingle{}s hash table
|
|
\end{DoxyItemize}\hypertarget{md_docs_2hash_2hash_remove_autotoc_md272}{}\doxysubsection{\texorpdfstring{Links}{Links}}\label{md_docs_2hash_2hash_remove_autotoc_md272}
|
|
\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} |