MEDLab
/
Modpol
mirror of https://gitlab.com/medlabboulder/modpol.git


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
    <title>Reference</title>
    <link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>

<div id="container">

<div id="product">
	<div id="product_logo"></div>
	<div id="product_name"><big><b></b></big></div>
	<div id="product_description"></div>
</div> <!-- id="product" -->


<div id="main">


<!-- Menu -->

<div id="navigation">
<br/>
<h1>Modpol</h1>

<ul>
  <li><a href="../index.html">Index</a></li>
</ul>

<h2>Contents</h2>
<ul>
<li><a href="#Functions">Functions</a></li>
</ul>


<h2>Modules</h2>
<ul class="nowrap">
  <li><strong>modpol.interactions</strong></li>
  <li><a href="../modules/add_child_org_consent.html">add_child_org_consent</a></li>
  <li><a href="../modules/change_modules.html">change_modules</a></li>
  <li><a href="../modules/change_modules.html">change_modules</a></li>
  <li><a href="../modules/consent.html">consent</a></li>
  <li><a href="../modules/create_token.html">create_token</a></li>
  <li><a href="../modules/defer_consent.html">defer_consent</a></li>
  <li><a href="../modules/display_processes.html">display_processes</a></li>
  <li><a href="../modules/join_org.html">join_org</a></li>
  <li><a href="../modules/join_org_consent.html">join_org_consent</a></li>
  <li><a href="../modules/leave_org.html">leave_org</a></li>
  <li><a href="../modules/message_org.html">message_org</a></li>
  <li><a href="../modules/randomizer.html">randomizer</a></li>
  <li><a href="../modules/remove_child_consent.html">remove_child_consent</a></li>
  <li><a href="../modules/remove_member_consent.html">remove_member_consent</a></li>
  <li><a href="../modules/remove_org.html">remove_org</a></li>
  <li><a href="../modules/remove_org_consent.html">remove_org_consent</a></li>
  <li><a href="../modules/remove_process.html">remove_process</a></li>
  <li><a href="../modules/rename_org_consent.html">rename_org_consent</a></li>
  <li><a href="../modules/send_token.html">send_token</a></li>
  <li><a href="../modules/module_template.html">module_template</a></li>
  <li><a href="../modules/tokenomics.html">tokenomics</a></li>
  <li><a href="../modules/modpol.orgs.base.html">modpol.orgs.base</a></li>
  <li><a href="../modules/modpol.orgs.process.html">modpol.orgs.process</a></li>
  <li><a href="../modules/modpol.util.misc.html">modpol.util.misc</a></li>
  <li><a href="../modules/modpol_minetest.api.html">modpol_minetest.api</a></li>
  <li><a href="../modules/priv_to_org.html">priv_to_org</a></li>
  <li><a href="../modules/modpol_minetest.overrides.interactions.html">modpol_minetest.overrides.interactions</a></li>
</ul>

</div>

<div id="content">

<h1>Module <code>modpol.interactions</code></h1>
<p>INTERACTIONS.LUA (CLI).</p>
<p>
 User interaction functions for Modular Politics
 Called by modpol.lua</p>


<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
	<tr>
	<td class="name" nowrap><a href="#modpol.interactions.dashboard">modpol.interactions.dashboard (user)</a></td>
	<td class="summary">Output: Display a menu of commands to the user</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#modpol.interactions.org_dashboard">modpol.interactions.org_dashboard (user, org_string)</a></td>
	<td class="summary">Output: Displays a menu of org-specific commands to the user</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#modpol.interactions.user_dashboard">modpol.interactions.user_dashboard (viewer, user, completion)</a></td>
	<td class="summary">Function: modpol.interactions.user_dashboard
 Displays a dashboard about a particular user</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#modpol.interactions.message">modpol.interactions.message (user, message)</a></td>
	<td class="summary">Prints message to CLI.</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#modpol.interactions.message_user">modpol.interactions.message_user (sender, recipient)</a></td>
	<td class="summary">Gets and sends a message from one user to another</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#modpol.interactions.display">modpol.interactions.display (user, title, message, done)</a></td>
	<td class="summary">Displays complex data to a user</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#modpol.interactions.text_query">modpol.interactions.text_query (User, Query, func)</a></td>
	<td class="summary">Applies "func" to user input.</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#modpol.interactions.dropdown_query">modpol.interactions.dropdown_query (user, label, options, func)</a></td>
	<td class="summary">Output: Calls func on choice.</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#modpol.interactions.checkbox_query">modpol.interactions.checkbox_query (user, label, options, func)</a></td>
	<td class="summary">Allows user to select from a set of options</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#modpol.interactions.binary_poll_user">modpol.interactions.binary_poll_user (user, question, func)</a></td>
	<td class="summary">Output: Applies "func" to user input.</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#modpol.interactions.message_org">modpol.interactions.message_org (initiator, org, message)</a></td>
	<td class="summary">Output: broadcasts message to all org members</td>
	</tr>
</table>

<br/>
<br/>


    <h2 class="section-header "><a name="Functions"></a>Functions</h2>

    <dl class="function">
    <dt>
    <a name = "modpol.interactions.dashboard"></a>
    <strong>modpol.interactions.dashboard (user)</strong>
    </dt>
    <dd>
    Output: Display a menu of commands to the user


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">user</span>
         (string)
        </li>
    </ul>


</dd>
    <dt>
    <a name = "modpol.interactions.org_dashboard"></a>
    <strong>modpol.interactions.org_dashboard (user, org_string)</strong>
    </dt>
    <dd>
    Output: Displays a menu of org-specific commands to the user


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">user</span>
         (string)
        </li>
        <li><span class="parameter">org_string</span>
         (string or id)
        </li>
    </ul>


</dd>
    <dt>
    <a name = "modpol.interactions.user_dashboard"></a>
    <strong>modpol.interactions.user_dashboard (viewer, user, completion)</strong>
    </dt>
    <dd>
    Function: modpol.interactions.user_dashboard
 Displays a dashboard about a particular user


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">viewer</span>
         Name of user viewing the dashboard (string)
        </li>
        <li><span class="parameter">user</span>
         Name of user being viewed (string)
        </li>
        <li><span class="parameter">completion</span>
         Optional function to call on Done button
        </li>
    </ul>


</dd>
    <dt>
    <a name = "modpol.interactions.message"></a>
    <strong>modpol.interactions.message (user, message)</strong>
    </dt>
    <dd>
    Prints message to CLI.
 Buttons: message, done


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">user</span>
         (string)
        </li>
        <li><span class="parameter">message</span>
         (string)
        </li>
    </ul>


</dd>
    <dt>
    <a name = "modpol.interactions.message_user"></a>
    <strong>modpol.interactions.message_user (sender, recipient)</strong>
    </dt>
    <dd>
    Gets and sends a message from one user to another


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">sender</span>
         Name of user sending (string)
        </li>
        <li><span class="parameter">recipient</span>
         Name of user receiving (string)
        </li>
    </ul>


</dd>
    <dt>
    <a name = "modpol.interactions.display"></a>
    <strong>modpol.interactions.display (user, title, message, done)</strong>
    </dt>
    <dd>
    Displays complex data to a user


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">user</span>
         Name of target user (string)
        </li>
        <li><span class="parameter">title</span>
         Title of display (string)
        </li>
        <li><span class="parameter">message</span>
         Content of message (string or table of strings)
        </li>
        <li><span class="parameter">done</span>
         Optional function for what happens when user is done
        </li>
    </ul>


</dd>
    <dt>
    <a name = "modpol.interactions.text_query"></a>
    <strong>modpol.interactions.text_query (User, Query, func)</strong>
    </dt>
    <dd>
    Applies "func" to user input.
 Func input: user input (string)


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">User</span>
         (string)
        </li>
        <li><span class="parameter">Query</span>
         (string)
        </li>
        <li><span class="parameter">func</span>
         (function)
        </li>
    </ul>


</dd>
    <dt>
    <a name = "modpol.interactions.dropdown_query"></a>
    <strong>modpol.interactions.dropdown_query (user, label, options, func)</strong>
    </dt>
    <dd>
    Output: Calls func on choice.
 Func input: choice (string)


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">user</span>
         (string)
        </li>
        <li><span class="parameter">label</span>
         (string)
        </li>
        <li><span class="parameter">options</span>
         (table of strings)
        </li>
        <li><span class="parameter">func</span>
         (choice) (function)
        </li>
    </ul>


</dd>
    <dt>
    <a name = "modpol.interactions.checkbox_query"></a>
    <strong>modpol.interactions.checkbox_query (user, label, options, func)</strong>
    </dt>
    <dd>
    Allows user to select from a set of options


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">user</span>
         Name of user (string)
        </li>
        <li><span class="parameter">label</span>
         Query for user before options (string)
        </li>
        <li><span class="parameter">options</span>
         Table of options and their checked status in the form {{"option_1_string", true}, {"option_2_string", false}}
        </li>
        <li><span class="parameter">func</span>
         Function to be called with param "input", made up of the corrected table in the same format as the param options
        </li>
    </ul>


</dd>
    <dt>
    <a name = "modpol.interactions.binary_poll_user"></a>
    <strong>modpol.interactions.binary_poll_user (user, question, func)</strong>
    </dt>
    <dd>
    Output: Applies "func" to user input.
 Func input: user input (string: y/n)


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">user</span>
         (string)
        </li>
        <li><span class="parameter">question</span>
         (string)
        </li>
        <li><span class="parameter">func</span>
         (function)
        </li>
    </ul>


</dd>
    <dt>
    <a name = "modpol.interactions.message_org"></a>
    <strong>modpol.interactions.message_org (initiator, org, message)</strong>
    </dt>
    <dd>
    Output: broadcasts message to all org members


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">initiator</span>
         (string)
        </li>
        <li><span class="parameter">org</span>
         (number or string)
        </li>
        <li><span class="parameter">message</span>
         (string)
        </li>
    </ul>


</dd>
</dl>


</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2022-01-23 18:18:51 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>