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
3.0 KiB
TeX
44 lines
3.0 KiB
TeX
\doxysection{G\+:/ids/dragonfly/docs/hash Directory Reference}
|
|
\hypertarget{dir_1d1eabba2c636e67297dc8cee9bc9944}{}\label{dir_1d1eabba2c636e67297dc8cee9bc9944}\index{G:/ids/dragonfly/docs/hash Directory Reference@{G:/ids/dragonfly/docs/hash Directory Reference}}
|
|
|
|
|
|
\doxysubsection{Detailed Description}
|
|
This section contains documentation for the hash operations of Arma\+Dragonfly\+Client that allow for working with hash tables (key-\/value pairs within a namespace).\hypertarget{README.md_autotoc_md276}{}\doxysubsection{\texorpdfstring{Available Functions}{Available Functions}}\label{README.md_autotoc_md276}
|
|
|
|
\begin{DoxyItemize}
|
|
\item \doxysectlink{md__g_1_2ids_2dragonfly_2docs_2hash_2hash_get}{hash\+Get}{0} -\/ Get a field from a hash
|
|
\item \doxysectlink{md__g_1_2ids_2dragonfly_2docs_2hash_2hash_get_all}{hash\+Get\+All}{0} -\/ Get all fields from a hash
|
|
\item \doxysectlink{md__g_1_2ids_2dragonfly_2docs_2hash_2hash_get_all_id}{hash\+Get\+All\+Id}{0} -\/ Get all fields from a hash for a specific ID
|
|
\item \doxysectlink{md__g_1_2ids_2dragonfly_2docs_2hash_2hash_get_id}{hash\+Get\+Id}{0} -\/ Get a field from a hash for a specific ID
|
|
\item \doxysectlink{md__g_1_2ids_2dragonfly_2docs_2hash_2hash_set}{hash\+Set}{0} -\/ Set a field in a hash
|
|
\item \doxysectlink{md__g_1_2ids_2dragonfly_2docs_2hash_2hash_set_bulk}{hash\+Set\+Bulk}{0} -\/ Set multiple fields in a hash in one operation
|
|
\item \doxysectlink{md__g_1_2ids_2dragonfly_2docs_2hash_2hash_set_id}{hash\+Set\+Id}{0} -\/ Set a field in a hash for a specific ID
|
|
\item \doxysectlink{md__g_1_2ids_2dragonfly_2docs_2hash_2hash_set_id_bulk}{hash\+Set\+Id\+Bulk}{0} -\/ Set multiple fields in a hash for a specific ID in one operation
|
|
\end{DoxyItemize}\hypertarget{README.md_autotoc_md277}{}\doxysubsection{\texorpdfstring{Example Usage}{Example Usage}}\label{README.md_autotoc_md277}
|
|
|
|
\begin{DoxyCode}{0}
|
|
\DoxyCodeLine{//\ Context\ mode\ examples}
|
|
\DoxyCodeLine{["{}myField"{},\ [myValue]]\ call\ dragonfly\_db\_fnc\_hashSet;}
|
|
\DoxyCodeLine{["{}myField"{},\ "{}myFunction"{}]\ call\ dragonfly\_db\_fnc\_hashGet;}
|
|
\DoxyCodeLine{["{}myFunction"{}]\ call\ dragonfly\_db\_fnc\_hashGetAll;}
|
|
\DoxyCodeLine{}
|
|
\DoxyCodeLine{//\ Set\ multiple\ hash\ fields\ in\ one\ operation}
|
|
\DoxyCodeLine{[[}
|
|
\DoxyCodeLine{\ \ \ \ "{}loadout"{},\ [getUnitLoadout\ player],}
|
|
\DoxyCodeLine{\ \ \ \ "{}position"{},\ [getPosASL\ player],}
|
|
\DoxyCodeLine{\ \ \ \ "{}direction"{},\ [getDir\ player]}
|
|
\DoxyCodeLine{]]\ call\ dragonfly\_db\_fnc\_hashSetBulk;}
|
|
\DoxyCodeLine{}
|
|
\DoxyCodeLine{//\ ID-\/specific\ examples}
|
|
\DoxyCodeLine{["{}myHash"{},\ "{}myField"{},\ [myValue]]\ call\ dragonfly\_db\_fnc\_hashSetId;}
|
|
\DoxyCodeLine{["{}myHash"{},\ "{}myField"{},\ "{}myFunction"{}]\ call\ dragonfly\_db\_fnc\_hashGetId;}
|
|
\DoxyCodeLine{["{}myHash"{}]\ call\ dragonfly\_db\_fnc\_hashGetAllId;}
|
|
|
|
\end{DoxyCode}
|
|
\hypertarget{README.md_autotoc_md278}{}\doxysubsection{\texorpdfstring{Related Categories}{Related Categories}}\label{README.md_autotoc_md278}
|
|
|
|
\begin{DoxyItemize}
|
|
\item Core Functions
|
|
\item Basic Data Operations
|
|
\item List Operations
|
|
\end{DoxyItemize} |