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.
271 lines
16 KiB
HTML
271 lines
16 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.13.2"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>ArmaDragonflyClient: G:/ids/dragonfly/docs Directory Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<script type="text/javascript" src="clipboard.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="cookie.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() { init_search(); });
|
|
/* @license-end */
|
|
</script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">ArmaDragonflyClient
|
|
</div>
|
|
</td>
|
|
<td> <div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"> </span>
|
|
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.13.2 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() { codefold.init(0); });
|
|
/* @license-end */
|
|
</script>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function(){initNavTree('dir_6b1f4820e2481aa5a1ea9b2275f196d9.html',''); initResizable(true); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="headertitle"><div class="title">docs Directory Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="subdirs" name="subdirs"></a>
|
|
Directories</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top"><span class="iconfclosed"></span> </td><td class="memItemRight" valign="bottom"><a class="el" href="dir_71f12be5768ca2af9c9f300d019944af.html">basic</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top"><span class="iconfclosed"></span> </td><td class="memItemRight" valign="bottom"><a class="el" href="dir_10eb6422e80bd721a9a7af022f58c68b.html">core</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top"><span class="iconfclosed"></span> </td><td class="memItemRight" valign="bottom"><a class="el" href="dir_1d1eabba2c636e67297dc8cee9bc9944.html">hash</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top"><span class="iconfclosed"></span> </td><td class="memItemRight" valign="bottom"><a class="el" href="dir_72c6efb7383bf0530aa073c1e7428252.html">list</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<p>This documentation provides details on all functions available in <code>ArmaDragonflyClient</code>. These functions allow you to interact with the in-memory database system for Arma 3.</p>
|
|
<h1><a class="anchor" id="autotoc_md345"></a>
|
|
Function Categories</h1>
|
|
<p>The functions are categorized by their purpose:</p>
|
|
<h2><a class="anchor" id="autotoc_md346"></a>
|
|
Core Functions</h2>
|
|
<ul>
|
|
<li><a class="el" href="dc/d36/md__g_1_2ids_2dragonfly_2docs_2core_2init.html">init</a> - Initialize the database system</li>
|
|
<li><a class="el" href="d4/d43/md__g_1_2ids_2dragonfly_2docs_2core_2handler.html">handler</a> - Handle callbacks from the extension</li>
|
|
<li><a class="el" href="d0/d0e/md__g_1_2ids_2dragonfly_2docs_2core_2process_queue.html">processQueue</a> - Process queued database operations</li>
|
|
<li><a class="el" href="d0/df6/md__g_1_2ids_2dragonfly_2docs_2core_2scheduler.html">scheduler</a> - Schedule database operations</li>
|
|
<li><a class="el" href="dd/d3b/md__g_1_2ids_2dragonfly_2docs_2core_2add_task.html">addTask</a> - Add a task to the scheduler</li>
|
|
<li><a class="el" href="d4/d7c/md__g_1_2ids_2dragonfly_2docs_2core_2print_addon_name.html">printAddonName</a> - Print the addon name</li>
|
|
<li><a class="el" href="d6/d7e/md__g_1_2ids_2dragonfly_2docs_2core_2test.html">test</a> - Test the database connection</li>
|
|
</ul>
|
|
<h2><a class="anchor" id="autotoc_md347"></a>
|
|
Basic Data Operations</h2>
|
|
<ul>
|
|
<li><a class="el" href="d3/dcb/md__g_1_2ids_2dragonfly_2docs_2basic_2get.html">get</a> - Get a value from the database</li>
|
|
<li><a class="el" href="d9/d9c/md__g_1_2ids_2dragonfly_2docs_2basic_2set.html">set</a> - Set a value in the database</li>
|
|
<li><a class="el" href="df/d12/md__g_1_2ids_2dragonfly_2docs_2basic_2delete.html">delete</a> - Delete a value from the database</li>
|
|
<li><a class="el" href="d2/dce/md__g_1_2ids_2dragonfly_2docs_2basic_2save.html">save</a> - Save the database to disk</li>
|
|
<li><a class="el" href="d4/d99/md__g_1_2ids_2dragonfly_2docs_2basic_2fetch.html">fetch</a> - Fetch a value from the database</li>
|
|
</ul>
|
|
<h2><a class="anchor" id="autotoc_md348"></a>
|
|
Hash Operations</h2>
|
|
<ul>
|
|
<li><a class="el" href="d9/de8/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_get.html">hashGet</a> - Get a field from a hash</li>
|
|
<li><a class="el" href="da/d08/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_get_all.html">hashGetAll</a> - Get all fields from a hash</li>
|
|
<li><a class="el" href="d2/d23/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_get_all_id.html">hashGetAllId</a> - Get all fields from a hash for a specific ID</li>
|
|
<li><a class="el" href="d2/d28/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_get_id.html">hashGetId</a> - Get a field from a hash for a specific ID</li>
|
|
<li><a class="el" href="d0/df2/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_set.html">hashSet</a> - Set a field in a hash</li>
|
|
<li><a class="el" href="da/d74/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_set_bulk.html">hashSetBulk</a> - Set multiple fields in a hash in one operation</li>
|
|
<li><a class="el" href="d4/d99/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_set_id.html">hashSetId</a> - Set a field in a hash for a specific ID</li>
|
|
<li><a class="el" href="de/da6/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_set_id_bulk.html">hashSetIdBulk</a> - Set multiple fields in a hash for a specific ID in one operation</li>
|
|
</ul>
|
|
<h2><a class="anchor" id="autotoc_md349"></a>
|
|
List Operations</h2>
|
|
<ul>
|
|
<li><a class="el" href="da/d2c/md__g_1_2ids_2dragonfly_2docs_2list_2list_add.html">listAdd</a> - Add an item to a list</li>
|
|
<li><a class="el" href="d3/ddf/md__g_1_2ids_2dragonfly_2docs_2list_2list_get.html">listGet</a> - Get items from a list</li>
|
|
<li><a class="el" href="d9/db3/md__g_1_2ids_2dragonfly_2docs_2list_2list_load.html">listLoad</a> - Load a list from the database</li>
|
|
<li><a class="el" href="d1/d22/md__g_1_2ids_2dragonfly_2docs_2list_2list_remove.html">listRemove</a> - Remove an item from a list</li>
|
|
<li><a class="el" href="d2/dc5/md__g_1_2ids_2dragonfly_2docs_2list_2list_set.html">listSet</a> - Set an item in a list</li>
|
|
</ul>
|
|
<h1><a class="anchor" id="autotoc_md350"></a>
|
|
Usage Examples</h1>
|
|
<h2><a class="anchor" id="autotoc_md351"></a>
|
|
Basic Usage</h2>
|
|
<div class="fragment"><div class="line">// Initialize the database</div>
|
|
<div class="line">[] call dragonfly_db_fnc_init;</div>
|
|
<div class="line"> </div>
|
|
<div class="line">// Set a value</div>
|
|
<div class="line">["myKey", [myValue]] call dragonfly_db_fnc_set;</div>
|
|
<div class="line"> </div>
|
|
<div class="line">// Get a value</div>
|
|
<div class="line">["myKey", "myFunction"] call dragonfly_db_fnc_get;</div>
|
|
<div class="line"> </div>
|
|
<div class="line">// Delete a key</div>
|
|
<div class="line">["myKey"] call dragonfly_db_fnc_delete;</div>
|
|
</div><!-- fragment --><h2><a class="anchor" id="autotoc_md352"></a>
|
|
Hash Operations</h2>
|
|
<div class="fragment"><div class="line">// Set a hash field (context mode)</div>
|
|
<div class="line">["myField", [myValue]] call dragonfly_db_fnc_hashSet;</div>
|
|
<div class="line"> </div>
|
|
<div class="line">// Get a hash field (context mode)</div>
|
|
<div class="line">["myField", "myFunction"] call dragonfly_db_fnc_hashGet;</div>
|
|
<div class="line"> </div>
|
|
<div class="line">// Get all hash fields (context mode)</div>
|
|
<div class="line">["myFunction"] call dragonfly_db_fnc_hashGetAll;</div>
|
|
<div class="line"> </div>
|
|
<div class="line">// Set multiple hash fields (context mode)</div>
|
|
<div class="line">[[</div>
|
|
<div class="line"> "loadout", [getUnitLoadout player],</div>
|
|
<div class="line"> "position", [getPosASL player],</div>
|
|
<div class="line"> "direction", [getDir player],</div>
|
|
<div class="line"> "stance", [stance player]</div>
|
|
<div class="line">]] call dragonfly_db_fnc_hashSetBulk;</div>
|
|
<div class="line"> </div>
|
|
<div class="line">// Remove a hash field (context mode)</div>
|
|
<div class="line">["myField"] call dragonfly_db_fnc_hashRemove;</div>
|
|
<div class="line"> </div>
|
|
<div class="line">// Delete a hash table (context mode)</div>
|
|
<div class="line">[] call dragonfly_db_fnc_hashDelete;</div>
|
|
</div><!-- fragment --> <div class="fragment"><div class="line">// Set a hash field for specific ID</div>
|
|
<div class="line">["myHash", "myField", [myValue]] call dragonfly_db_fnc_hashSetId;</div>
|
|
<div class="line"> </div>
|
|
<div class="line">// Get a hash field for specific ID</div>
|
|
<div class="line">["myHash", "myField", "myFunction"] call dragonfly_db_fnc_hashGetId;</div>
|
|
<div class="line"> </div>
|
|
<div class="line">// Get all hash fields for specific ID</div>
|
|
<div class="line">["myHash"] call dragonfly_db_fnc_hashGetAllId;</div>
|
|
<div class="line"> </div>
|
|
<div class="line">// Set multiple hash fields for specific ID</div>
|
|
<div class="line">[[</div>
|
|
<div class="line"> getPlayerUID player,</div>
|
|
<div class="line"> "loadout", [getUnitLoadout player],</div>
|
|
<div class="line"> "position", [getPosASL player],</div>
|
|
<div class="line"> "direction", [getDir player],</div>
|
|
<div class="line"> "stance", [stance player]</div>
|
|
<div class="line">]] call dragonfly_db_fnc_hashSetIdBulk;</div>
|
|
<div class="line"> </div>
|
|
<div class="line">// Remove a hash field for specific ID</div>
|
|
<div class="line">["myHash", "myField"] call dragonfly_db_fnc_hashRemoveId;</div>
|
|
<div class="line"> </div>
|
|
<div class="line">// Delete a hash table for specific ID</div>
|
|
<div class="line">["myHash"] call dragonfly_db_fnc_hashDeleteId;</div>
|
|
</div><!-- fragment --><h2><a class="anchor" id="autotoc_md353"></a>
|
|
List Operations</h2>
|
|
<div class="fragment"><div class="line">// Add an item to a list</div>
|
|
<div class="line">["myList", ["myItem"]] call dragonfly_db_fnc_listAdd;</div>
|
|
<div class="line"> </div>
|
|
<div class="line">// Set an item from a list</div>
|
|
<div class="line">["myList", 0, [myNewValue]] call dragonfly_db_fnc_listSet;</div>
|
|
<div class="line"> </div>
|
|
<div class="line">// Get an item from a list</div>
|
|
<div class="line">["myList", 0, "myFunction"] call dragonfly_db_fnc_listGet;</div>
|
|
<div class="line"> </div>
|
|
<div class="line">// Get items from a list</div>
|
|
<div class="line">["myList", "myFunction"] call dragonfly_db_fnc_listLoad;</div>
|
|
<div class="line"> </div>
|
|
<div class="line">// Remove an item from a list</div>
|
|
<div class="line">["myList", 0] call dragonfly_db_fnc_listRemove;</div>
|
|
<div class="line"> </div>
|
|
<div class="line">// Delete a list</div>
|
|
<div class="line">["myList"] call dragonfly_db_fnc_listDelete;</div>
|
|
</div><!-- fragment --><h1><a class="anchor" id="autotoc_md354"></a>
|
|
Function Documentation Structure</h1>
|
|
<p>Each function documentation includes:</p><ul>
|
|
<li>Function name and purpose</li>
|
|
<li>Parameters</li>
|
|
<li>Return value</li>
|
|
<li>Examples</li>
|
|
<li>Notes and warnings</li>
|
|
</ul>
|
|
<h1><a class="anchor" id="autotoc_md355"></a>
|
|
License</h1>
|
|
<p>This work is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License. To view a copy of this license, visit <a href="https://creativecommons.org/licenses/by-nc-sa/4.0/">https://creativecommons.org/licenses/by-nc-sa/4.0/</a> or send a letter to Creative Commons, <br />
|
|
PO Box 1866, Mountain View, CA 94042 </p>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_4373328136309bbaba010b91e95ca4c6.html">dragonfly</a></li><li class="navelem"><a class="el" href="dir_6b1f4820e2481aa5a1ea9b2275f196d9.html">docs</a></li>
|
|
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.2 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|