From da7b996a8b04ea3f8de993ac8eedee7ccb08311c Mon Sep 17 00:00:00 2001 From: SkylarHew Date: Thu, 20 Jan 2022 11:04:44 -0700 Subject: [PATCH] Added ldoc comments for all lua modules and generated docs in documentation index.html --- documentation/config.ld | 2 + documentation/doc/index.html | 164 ++++++ documentation/doc/ldoc.css | 303 +++++++++++ .../doc/modules/add_child_org_consent.html | 144 ++++++ documentation/doc/modules/change_modules.html | 148 ++++++ documentation/doc/modules/consent.html | 149 ++++++ documentation/doc/modules/join_org.html | 125 +++++ .../doc/modules/join_org_consent.html | 145 ++++++ .../doc/modules/join_org_consent.lua.html | 145 ++++++ documentation/doc/modules/leave_org.html | 125 +++++ documentation/doc/modules/message_org.html | 125 +++++ .../doc/modules/modpol.interactions.html | 307 +++++++++++ .../doc/modules/modpol.orgs.base.html | 475 ++++++++++++++++++ .../doc/modules/modpol.orgs.process.html | 295 +++++++++++ .../doc/modules/modpol.util.misc.html | 159 ++++++ .../modpol_core.modules.join_org_consent.html | 145 ++++++ ...odpol_core.modules.remove_org_consent.html | 127 +++++ .../doc/modules/modpol_minetest.api.html | 90 ++++ .../doc/modules/module_template.html | 221 ++++++++ documentation/doc/modules/priv_to_org.html | 125 +++++ .../doc/modules/remove_child_consent.html | 127 +++++ .../doc/modules/remove_member_consent.html | 124 +++++ documentation/doc/modules/remove_org.html | 125 +++++ .../doc/modules/remove_org_consent.html | 127 +++++ .../doc/modules/rename_org_consent.html | 145 ++++++ documentation/headers_template.html | 63 +++ modpol_core/modules/add_child_org_consent.lua | 11 +- modpol_core/modules/change_modules.lua | 6 +- modpol_core/modules/consent.lua | 10 +- modpol_core/modules/join_org.lua | 5 + modpol_core/modules/join_org_consent.lua | 8 +- modpol_core/modules/leave_org.lua | 10 +- modpol_core/modules/message_org.lua | 5 +- modpol_core/modules/remove_child_consent.lua | 4 + modpol_core/modules/remove_member_consent.lua | 6 +- modpol_core/modules/remove_org.lua | 11 +- modpol_core/modules/remove_org_consent.lua | 4 + modpol_core/modules/rename_org_consent.lua | 6 + modpol_core/modules/template.lua | 2 +- modpol_core/util/misc.lua | 15 +- modpol_minetest/modules/priv_to_org.lua | 9 +- 41 files changed, 4307 insertions(+), 35 deletions(-) create mode 100644 documentation/config.ld create mode 100644 documentation/doc/index.html create mode 100644 documentation/doc/ldoc.css create mode 100644 documentation/doc/modules/add_child_org_consent.html create mode 100644 documentation/doc/modules/change_modules.html create mode 100644 documentation/doc/modules/consent.html create mode 100644 documentation/doc/modules/join_org.html create mode 100644 documentation/doc/modules/join_org_consent.html create mode 100644 documentation/doc/modules/join_org_consent.lua.html create mode 100644 documentation/doc/modules/leave_org.html create mode 100644 documentation/doc/modules/message_org.html create mode 100644 documentation/doc/modules/modpol.interactions.html create mode 100644 documentation/doc/modules/modpol.orgs.base.html create mode 100644 documentation/doc/modules/modpol.orgs.process.html create mode 100644 documentation/doc/modules/modpol.util.misc.html create mode 100644 documentation/doc/modules/modpol_core.modules.join_org_consent.html create mode 100644 documentation/doc/modules/modpol_core.modules.remove_org_consent.html create mode 100644 documentation/doc/modules/modpol_minetest.api.html create mode 100644 documentation/doc/modules/module_template.html create mode 100644 documentation/doc/modules/priv_to_org.html create mode 100644 documentation/doc/modules/remove_child_consent.html create mode 100644 documentation/doc/modules/remove_member_consent.html create mode 100644 documentation/doc/modules/remove_org.html create mode 100644 documentation/doc/modules/remove_org_consent.html create mode 100644 documentation/doc/modules/rename_org_consent.html create mode 100644 documentation/headers_template.html diff --git a/documentation/config.ld b/documentation/config.ld new file mode 100644 index 0000000..2a91e26 --- /dev/null +++ b/documentation/config.ld @@ -0,0 +1,2 @@ +project = 'modpol' +description = 'modpol core' \ No newline at end of file diff --git a/documentation/doc/index.html b/documentation/doc/index.html new file mode 100644 index 0000000..ee3531b --- /dev/null +++ b/documentation/doc/index.html @@ -0,0 +1,164 @@ + + + + + Reference + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ + +

modpol core

+ +

Modules

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
modpol.interactionsINTERACTIONS.LUA (CLI).
add_child_org_consentAdds a child org.
change_moduleschange_modules + Depends on consent
consentA utility module for checking consent
join_orgAdds a user to org
join_org_consentJoin org (consent).
leave_orgRemoves initiator from org
message_orgMessages all org members
remove_child_consentRemove child (consent) + A simple module that calls a consent process on an org to remove its child + Depends on the Consent module.
remove_member_consentCalls consent to remove member from org
remove_orgA simple module that removes an org.
remove_org_consentRemove org (consent) + A simple module that calls a consent process on an org to remove it.
rename_org_consentRename org (consent) + A simple module that calls a consent process on an org to rename it.
module_templateTemplate for module writers
modpol.orgs.baseBasic function for orgs
modpol.orgs.processProcess functions for orgs
modpol.util.miscMiscellaneous functions
modpol_minetest.apiScript for loading Minetest files
priv_to_orgSet privilege to org members + Allows initiator to grant a priv they have to all members of an org
+ +
+
+
+generated by LDoc 1.4.6 +Last updated 2022-01-20 10:54:01 +
+
+ + diff --git a/documentation/doc/ldoc.css b/documentation/doc/ldoc.css new file mode 100644 index 0000000..52c4ad2 --- /dev/null +++ b/documentation/doc/ldoc.css @@ -0,0 +1,303 @@ +/* BEGIN RESET + +Copyright (c) 2010, Yahoo! Inc. All rights reserved. +Code licensed under the BSD License: +http://developer.yahoo.com/yui/license.html +version: 2.8.2r1 +*/ +html { + color: #000; + background: #FFF; +} +body,div,dl,dt,dd,ul,ol,li,h1,h2,h3,h4,h5,h6,pre,code,form,fieldset,legend,input,button,textarea,p,blockquote,th,td { + margin: 0; + padding: 0; +} +table { + border-collapse: collapse; + border-spacing: 0; +} +fieldset,img { + border: 0; +} +address,caption,cite,code,dfn,em,strong,th,var,optgroup { + font-style: inherit; + font-weight: inherit; +} +del,ins { + text-decoration: none; +} +li { + margin-left: 20px; +} +caption,th { + text-align: left; +} +h1,h2,h3,h4,h5,h6 { + font-size: 100%; + font-weight: bold; +} +q:before,q:after { + content: ''; +} +abbr,acronym { + border: 0; + font-variant: normal; +} +sup { + vertical-align: baseline; +} +sub { + vertical-align: baseline; +} +legend { + color: #000; +} +input,button,textarea,select,optgroup,option { + font-family: inherit; + font-size: inherit; + font-style: inherit; + font-weight: inherit; +} +input,button,textarea,select {*font-size:100%; +} +/* END RESET */ + +body { + margin-left: 1em; + margin-right: 1em; + font-family: arial, helvetica, geneva, sans-serif; + background-color: #ffffff; margin: 0px; +} + +code, tt { font-family: monospace; font-size: 1.1em; } +span.parameter { font-family:monospace; } +span.parameter:after { content:":"; } +span.types:before { content:"("; } +span.types:after { content:")"; } +.type { font-weight: bold; font-style:italic } + +body, p, td, th { font-size: .95em; line-height: 1.2em;} + +p, ul { margin: 10px 0 0 0px;} + +strong { font-weight: bold;} + +em { font-style: italic;} + +h1 { + font-size: 1.5em; + margin: 20px 0 20px 0; +} +h2, h3, h4 { margin: 15px 0 10px 0; } +h2 { font-size: 1.25em; } +h3 { font-size: 1.15em; } +h4 { font-size: 1.06em; } + +a:link { font-weight: bold; color: #004080; text-decoration: none; } +a:visited { font-weight: bold; color: #006699; text-decoration: none; } +a:link:hover { text-decoration: underline; } + +hr { + color:#cccccc; + background: #00007f; + height: 1px; +} + +blockquote { margin-left: 3em; } + +ul { list-style-type: disc; } + +p.name { + font-family: "Andale Mono", monospace; + padding-top: 1em; +} + +pre { + background-color: rgb(245, 245, 245); + border: 1px solid #C0C0C0; /* silver */ + padding: 10px; + margin: 10px 0 10px 0; + overflow: auto; + font-family: "Andale Mono", monospace; +} + +pre.example { + font-size: .85em; +} + +table.index { border: 1px #00007f; } +table.index td { text-align: left; vertical-align: top; } + +#container { + margin-left: 1em; + margin-right: 1em; + background-color: #f0f0f0; +} + +#product { + text-align: center; + border-bottom: 1px solid #cccccc; + background-color: #ffffff; +} + +#product big { + font-size: 2em; +} + +#main { + background-color: #f0f0f0; + border-left: 2px solid #cccccc; +} + +#navigation { + float: left; + width: 14em; + vertical-align: top; + background-color: #f0f0f0; + overflow: visible; +} + +#navigation h2 { + background-color:#e7e7e7; + font-size:1.1em; + color:#000000; + text-align: left; + padding:0.2em; + border-top:1px solid #dddddd; + border-bottom:1px solid #dddddd; +} + +#navigation ul +{ + font-size:1em; + list-style-type: none; + margin: 1px 1px 10px 1px; +} + +#navigation li { + text-indent: -1em; + display: block; + margin: 3px 0px 0px 22px; +} + +#navigation li li a { + margin: 0px 3px 0px -1em; +} + +#content { + margin-left: 14em; + padding: 1em; + width: 700px; + border-left: 2px solid #cccccc; + border-right: 2px solid #cccccc; + background-color: #ffffff; +} + +#about { + clear: both; + padding: 5px; + border-top: 2px solid #cccccc; + background-color: #ffffff; +} + +@media print { + body { + font: 12pt "Times New Roman", "TimeNR", Times, serif; + } + a { font-weight: bold; color: #004080; text-decoration: underline; } + + #main { + background-color: #ffffff; + border-left: 0px; + } + + #container { + margin-left: 2%; + margin-right: 2%; + background-color: #ffffff; + } + + #content { + padding: 1em; + background-color: #ffffff; + } + + #navigation { + display: none; + } + pre.example { + font-family: "Andale Mono", monospace; + font-size: 10pt; + page-break-inside: avoid; + } +} + +table.module_list { + border-width: 1px; + border-style: solid; + border-color: #cccccc; + border-collapse: collapse; +} +table.module_list td { + border-width: 1px; + padding: 3px; + border-style: solid; + border-color: #cccccc; +} +table.module_list td.name { background-color: #f0f0f0; min-width: 200px; } +table.module_list td.summary { width: 100%; } + + +table.function_list { + border-width: 1px; + border-style: solid; + border-color: #cccccc; + border-collapse: collapse; +} +table.function_list td { + border-width: 1px; + padding: 3px; + border-style: solid; + border-color: #cccccc; +} +table.function_list td.name { background-color: #f0f0f0; min-width: 200px; } +table.function_list td.summary { width: 100%; } + +ul.nowrap { + overflow:auto; + white-space:nowrap; +} + +dl.table dt, dl.function dt {border-top: 1px solid #ccc; padding-top: 1em;} +dl.table dd, dl.function dd {padding-bottom: 1em; margin: 10px 0 0 20px;} +dl.table h3, dl.function h3 {font-size: .95em;} + +/* stop sublists from having initial vertical space */ +ul ul { margin-top: 0px; } +ol ul { margin-top: 0px; } +ol ol { margin-top: 0px; } +ul ol { margin-top: 0px; } + +/* make the target distinct; helps when we're navigating to a function */ +a:target + * { + background-color: #FF9; +} + + +/* styles for prettification of source */ +pre .comment { color: #558817; } +pre .constant { color: #a8660d; } +pre .escape { color: #844631; } +pre .keyword { color: #aa5050; font-weight: bold; } +pre .library { color: #0e7c6b; } +pre .marker { color: #512b1e; background: #fedc56; font-weight: bold; } +pre .string { color: #8080ff; } +pre .number { color: #f8660d; } +pre .operator { color: #2239a8; font-weight: bold; } +pre .preprocessor, pre .prepro { color: #a33243; } +pre .global { color: #800080; } +pre .user-keyword { color: #800080; } +pre .prompt { color: #558817; } +pre .url { color: #272fc2; text-decoration: underline; } + diff --git a/documentation/doc/modules/add_child_org_consent.html b/documentation/doc/modules/add_child_org_consent.html new file mode 100644 index 0000000..52ba72f --- /dev/null +++ b/documentation/doc/modules/add_child_org_consent.html @@ -0,0 +1,144 @@ + + + + + Reference + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module add_child_org_consent

+

Adds a child org.

+

+ Depends on `consent`

+ + +

Functions

+ + + + + + + + + +
initiate (result)Initiate consent for new child org
create_child_org ()Create a new child orgg
+ +
+
+ + +

Functions

+ +
+
+ + initiate (result) +
+
+ Initiate consent for new child org + + +

Parameters:

+
    +
  • result + +
    • +
+ + + + + +
+
+ + create_child_org () +
+
+ Create a new child orgg + + + + + + + +
+
+ + +
+
+
+generated by LDoc 1.4.6 +Last updated 2022-01-20 10:54:01 +
+
+ + diff --git a/documentation/doc/modules/change_modules.html b/documentation/doc/modules/change_modules.html new file mode 100644 index 0000000..4e043de --- /dev/null +++ b/documentation/doc/modules/change_modules.html @@ -0,0 +1,148 @@ + + + + + Reference + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module change_modules

+

change_modules + Depends on consent

+

+ + +

Functions

+ + + + + + + + + +
initiate ()Initiate change in modules.
propose_change (type, mod_text)propose_change
+ +
+
+ + +

Functions

+ +
+
+ + initiate () +
+
+ Initiate change in modules. + Either adds or removes module depending on user input + + + + + + + +
+
+ + propose_change (type, mod_text) +
+
+ propose_change + + +

Parameters:

+
    +
  • type + +
    • +
  • mod_text + +
    • +
+ + + + + +
+
+ + +
+
+
+generated by LDoc 1.4.6 +Last updated 2022-01-20 10:54:01 +
+
+ + diff --git a/documentation/doc/modules/consent.html b/documentation/doc/modules/consent.html new file mode 100644 index 0000000..88c1c28 --- /dev/null +++ b/documentation/doc/modules/consent.html @@ -0,0 +1,149 @@ + + + + + Reference + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module consent

+

A utility module for checking consent

+

+ + +

Functions

+ + + + + + + + + +
initiate (result)Initiate consent
callback (member)Callback
+ +
+
+ + +

Functions

+ +
+
+ + initiate (result) +
+
+ Initiate consent + + +

Parameters:

+
    +
  • result + +
    • +
+ + + + + +
+
+ + callback (member) +
+
+ Callback + + +

Parameters:

+
    +
  • member + +
    • +
+ + + + + +
+
+ + +
+
+
+generated by LDoc 1.4.6 +Last updated 2022-01-20 10:54:01 +
+
+ + diff --git a/documentation/doc/modules/join_org.html b/documentation/doc/modules/join_org.html new file mode 100644 index 0000000..bc279e9 --- /dev/null +++ b/documentation/doc/modules/join_org.html @@ -0,0 +1,125 @@ + + + + + Reference + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module join_org

+

Adds a user to org

+

+ + +

Functions

+ + + + + +
initiate (result)Adds the user to the org
+ +
+
+ + +

Functions

+ +
+
+ + initiate (result) +
+
+ Adds the user to the org + + +

Parameters:

+
    +
  • result + +
    • +
+ + + + + +
+
+ + +
+
+
+generated by LDoc 1.4.6 +Last updated 2022-01-20 10:54:01 +
+
+ + diff --git a/documentation/doc/modules/join_org_consent.html b/documentation/doc/modules/join_org_consent.html new file mode 100644 index 0000000..9e2bbc4 --- /dev/null +++ b/documentation/doc/modules/join_org_consent.html @@ -0,0 +1,145 @@ + + + + + Reference + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module join_org_consent

+

Join org (consent).

+

+ A simple module that calls a consent process on an org to add a member. + Depends on the Consent module.

+ + +

Functions

+ + + + + + + + + +
initiate (result)Initiate join org with consent
complete ()Adds member to org, notifies org, and deletes process
+ +
+
+ + +

Functions

+ +
+
+ + initiate (result) +
+
+ Initiate join org with consent + + +

Parameters:

+
    +
  • result + +
    • +
+ + + + + +
+
+ + complete () +
+
+ Adds member to org, notifies org, and deletes process + + + + + + + +
+
+ + +
+
+
+generated by LDoc 1.4.6 +Last updated 2022-01-20 10:54:01 +
+
+ + diff --git a/documentation/doc/modules/join_org_consent.lua.html b/documentation/doc/modules/join_org_consent.lua.html new file mode 100644 index 0000000..2949a4b --- /dev/null +++ b/documentation/doc/modules/join_org_consent.lua.html @@ -0,0 +1,145 @@ + + + + + Reference + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module join_org_consent.lua

+

Join org (consent).

+

+ A simple module that calls a consent process on an org to add a member. + Depends on the Consent module.

+ + +

Functions

+ + + + + + + + + +
join_org_consent:initiate (result)Initiate join org with consent
join_org_consent:complete ()Adds member to org, notifies org, and deletes process
+ +
+
+ + +

Functions

+ +
+
+ + join_org_consent:initiate (result) +
+
+ Initiate join org with consent + + +

Parameters:

+
    +
  • result + +
    • +
+ + + + + +
+
+ + join_org_consent:complete () +
+
+ Adds member to org, notifies org, and deletes process + + + + + + + +
+
+ + +
+
+
+generated by LDoc 1.4.6 +Last updated 2022-01-20 10:46:26 +
+
+ + diff --git a/documentation/doc/modules/leave_org.html b/documentation/doc/modules/leave_org.html new file mode 100644 index 0000000..760f967 --- /dev/null +++ b/documentation/doc/modules/leave_org.html @@ -0,0 +1,125 @@ + + + + + Reference + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module leave_org

+

Removes initiator from org

+

+ + +

Functions

+ + + + + +
initiate (result)Removes user from org
+ +
+
+ + +

Functions

+ +
+
+ + initiate (result) +
+
+ Removes user from org + + +

Parameters:

+
    +
  • result + +
    • +
+ + + + + +
+
+ + +
+
+
+generated by LDoc 1.4.6 +Last updated 2022-01-20 10:54:01 +
+
+ + diff --git a/documentation/doc/modules/message_org.html b/documentation/doc/modules/message_org.html new file mode 100644 index 0000000..e34e38d --- /dev/null +++ b/documentation/doc/modules/message_org.html @@ -0,0 +1,125 @@ + + + + + Reference + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module message_org

+

Messages all org members

+

+ + +

Functions

+ + + + + +
initiate (result)Allows user to send input message to all org members
+ +
+
+ + +

Functions

+ +
+
+ + initiate (result) +
+
+ Allows user to send input message to all org members + + +

Parameters:

+
    +
  • result + +
    • +
+ + + + + +
+
+ + +
+
+
+generated by LDoc 1.4.6 +Last updated 2022-01-20 10:54:01 +
+
+ + diff --git a/documentation/doc/modules/modpol.interactions.html b/documentation/doc/modules/modpol.interactions.html new file mode 100644 index 0000000..6c28f6c --- /dev/null +++ b/documentation/doc/modules/modpol.interactions.html @@ -0,0 +1,307 @@ + + + + + Reference + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module modpol.interactions

+

INTERACTIONS.LUA (CLI).

+

+ User interaction functions for Modular Politics + Called by modpol.lua

+ + +

Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
modpol.interactions.dashboard (user)Output: Display a menu of commands to the user
modpol.interactions.org_dashboard (user, org_string)Output: Displays a menu of org-specific commands to the user
modpol.interactions.message (user, message)Output: Prints message to CLI
modpol.interactions.text_query (user, query, func)Output: Applies "func" to user input.
modpol.interactions.dropdown_query (user, label, options, func)Output: Calls func on choice.
modpol.binary_poll_user (user, question, func)Output: Applies "func" to user input.
modpol.interactions.message_org (initiator, org, message)Output: broadcasts message to all org members
+ +
+
+ + +

Functions

+ +
+
+ + modpol.interactions.dashboard (user) +
+
+ Output: Display a menu of commands to the user + + +

Parameters:

+
    +
  • user + (string) +
    • +
+ + + + + +
+
+ + modpol.interactions.org_dashboard (user, org_string) +
+
+ Output: Displays a menu of org-specific commands to the user + + +

Parameters:

+
    +
  • user + (string) +
    • +
  • org_string + (string or id) +
    • +
+ + + + + +
+
+ + modpol.interactions.message (user, message) +
+
+ Output: Prints message to CLI + + +

Parameters:

+
    +
  • user + (string) +
    • +
  • message + (string) +
    • +
+ + + + + +
+
+ + modpol.interactions.text_query (user, query, func) +
+
+ Output: Applies "func" to user input. + Func input: user input (string) + + +

Parameters:

+
    +
  • user + (string) +
    • +
  • query + (string) +
    • +
  • func + (function) +
    • +
+ + + + + +
+
+ + modpol.interactions.dropdown_query (user, label, options, func) +
+
+ Output: Calls func on choice. + func input: choice (string) + + +

Parameters:

+
    +
  • user + (string) +
    • +
  • label + (string) +
    • +
  • options + (table of strings) +
    • +
  • func + (choice) (function) +
    • +
+ + + + + +
+
+ + modpol.binary_poll_user (user, question, func) +
+
+ Output: Applies "func" to user input. + Func input: user input (string: y/n) + + +

Parameters:

+
    +
  • user + (string) +
    • +
  • question + (string) +
    • +
  • func + (function) +
    • +
+ + + + + +
+
+ + modpol.interactions.message_org (initiator, org, message) +
+
+ Output: broadcasts message to all org members + + +

Parameters:

+
    +
  • initiator + (string) +
    • +
  • org + (number or string) +
    • +
  • message + (string) +
    • +
+ + + + + +
+
+ + +
+
+
+generated by LDoc 1.4.6 +Last updated 2022-01-20 10:54:01 +
+
+ + diff --git a/documentation/doc/modules/modpol.orgs.base.html b/documentation/doc/modules/modpol.orgs.base.html new file mode 100644 index 0000000..bb3c10a --- /dev/null +++ b/documentation/doc/modules/modpol.orgs.base.html @@ -0,0 +1,475 @@ + + + + + Reference + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module modpol.orgs.base

+

Basic function for orgs

+

+ + +

Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
modpol.orgs.get_org (arg)Return org when given its id or name
modpol.orgs.list_all ()Return a table list of all org names
modpol.orgs.user_orgs (user)Return the orgs of a user
modpol.orgs.reset ()Deletes all orgs except for the
modpol.orgs.init_instance ()Initializes the instance (root org) + can only be run once, as only one instance can exist
modpol.orgs:record ()Records a log message to the modpol ledger
modpol.orgs:add_org (name, user)Adds a new sub org to the org it is called on.
modpol.orgs:delete ()Recursively deletes an org and its suborgs + Leaves entry in modpol.orgs.array as a string "removed".
modpol.orgs:get_member_index (member)Internal function to get the index of a member name
modpol.orgs:add_member (user)Adds a user to an org
modpol.orgs:remove_member (user)Removes a user from an org
modpol.orgs:has_member (user)Boolean check whether user is an org
modpol.orgs:list_members ()
modpol.orgs:get_member_count ()Because member list uses lazy deletion, using #org.members will not show an accurate number
modpol.orgs:set_policy (policy_type, process_type, must_be_member)Adds a new policy to the policy table.
+ +
+
+ + +

Functions

+ +
+
+ + modpol.orgs.get_org (arg) +
+
+ Return org when given its id or name + + +

Parameters:

+
    +
  • arg + string for name of org or id of org +
    • +
+ +

Returns:

+
    + + org specified by id or name +
+ + + + +
+
+ + modpol.orgs.list_all () +
+
+ Return a table list of all org names + + + +

Returns:

+
    + + a table list of all org names +
+ + + + +
+
+ + modpol.orgs.user_orgs (user) +
+
+ Return the orgs of a user + + +

Parameters:

+
    +
  • user + string of user name +
    • +
+ +

Returns:

+
    + + table of strings of org names +
+ + + + +
+
+ + modpol.orgs.reset () +
+
+ Deletes all orgs except for the + + + + + + + +
+
+ + modpol.orgs.init_instance () +
+
+ Initializes the instance (root org) + can only be run once, as only one instance can exist + + + + + + + +
+
+ + modpol.orgs:record () +
+
+ Records a log message to the modpol ledger + + + + + + + +
+
+ + modpol.orgs:add_org (name, user) +
+
+ Adds a new sub org to the org it is called on. + Ex: instance:add_org('town hall') + + +

Parameters:

+
    +
  • name + (string) name of new org +
    • +
  • user + (string) +
    • +
+ +

Returns:

+
    + + child org created +
+ + + + +
+
+ + modpol.orgs:delete () +
+
+ Recursively deletes an org and its suborgs + Leaves entry in modpol.orgs.array as a string "removed". + Note: "reason" param was removed, can be added back + + + + + + + +
+
+ + modpol.orgs:get_member_index (member) +
+
+ Internal function to get the index of a member name + + +

Parameters:

+
    +
  • member + +
    • +
+ +

Returns:

+
    + + index of given member +
+ + + + +
+
+ + modpol.orgs:add_member (user) +
+
+ Adds a user to an org + + +

Parameters:

+
    +
  • user + +
    • +
+ + + + + +
+
+ + modpol.orgs:remove_member (user) +
+
+ Removes a user from an org + + +

Parameters:

+
    +
  • user + +
    • +
+ + + + + +
+
+ + modpol.orgs:has_member (user) +
+
+ Boolean check whether user is an org + + +

Parameters:

+
    +
  • user + +
    • +
+ +

Returns:

+
    + + true if user is in org, false if not +
+ + + + +
+
+ + modpol.orgs:list_members () +
+
+ + + + +

Returns:

+
    + + a table of the names (string) of members +
+ + + + +
+
+ + modpol.orgs:get_member_count () +
+
+ Because member list uses lazy deletion, using #org.members will not show an accurate number + + + +

Returns:

+
    + + numbers of members +
+ + + + +
+
+ + modpol.orgs:set_policy (policy_type, process_type, must_be_member) +
+
+ Adds a new policy to the policy table. + Must define the policy type, process associated with it, and whether the request must be made by an org member + + +

Parameters:

+
    +
  • policy_type + +
    • +
  • process_type + +
    • +
  • must_be_member + Boolean +
    • +
+ + + + + +
+
+ + +
+
+
+generated by LDoc 1.4.6 +Last updated 2022-01-20 10:54:01 +
+
+ + diff --git a/documentation/doc/modules/modpol.orgs.process.html b/documentation/doc/modules/modpol.orgs.process.html new file mode 100644 index 0000000..cd7fe4d --- /dev/null +++ b/documentation/doc/modules/modpol.orgs.process.html @@ -0,0 +1,295 @@ + + + + + Reference + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module modpol.orgs.process

+

Process functions for orgs

+

+ + +

Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
modpol.orgs.call_module (module_slug, intiator, config, result)Call modules
modpol.orgs:delete_process (id)Delete process by id
modpol.orgs:add_pending_action (process_id, user, callback)Add a new pending action
modpol.orgs:remove_pending_action (process_id, user)Remove a pending action
modpol.orgs:wipe_pending_actions (process_id)Wipe all pending actions for process
modpol.orgs:has_pending_actions (user)Check if there are pending actions for user
modpol.orgs:interact (process_id, user)Interact a user with given process
+ +
+
+ + +

Functions

+ +
+
+ + modpol.orgs.call_module (module_slug, intiator, config, result) +
+
+ Call modules + + +

Parameters:

+
    +
  • module_slug + Same as module name +
    • +
  • intiator + Initiator for module +
    • +
  • config + Config for module +
    • +
  • result + +
    • +
+ + + + + +
+
+ + modpol.orgs:delete_process (id) +
+
+ Delete process by id + + +

Parameters:

+
    +
  • id + Id of process +
    • +
+ + + + + +
+
+ + modpol.orgs:add_pending_action (process_id, user, callback) +
+
+ Add a new pending action + + +

Parameters:

+
    +
  • process_id + Process id +
    • +
  • user + User adding the action +
    • +
  • callback + +
    • +
+ + + + + +
+
+ + modpol.orgs:remove_pending_action (process_id, user) +
+
+ Remove a pending action + + +

Parameters:

+
    +
  • process_id + Process id to be removed +
    • +
  • user + +
    • +
+ + + + + +
+
+ + modpol.orgs:wipe_pending_actions (process_id) +
+
+ Wipe all pending actions for process + + +

Parameters:

+
    +
  • process_id + +
    • +
+ + + + + +
+
+ + modpol.orgs:has_pending_actions (user) +
+
+ Check if there are pending actions for user + + +

Parameters:

+
    +
  • user + User +
    • +
+ +

Returns:

+
    + + True if there are pending actions for a user, false if not +
+ + + + +
+
+ + modpol.orgs:interact (process_id, user) +
+
+ Interact a user with given process + + +

Parameters:

+
    +
  • process_id + +
    • +
  • user + +
    • +
+ + + + + +
+
+ + +
+
+
+generated by LDoc 1.4.6 +Last updated 2022-01-20 10:54:01 +
+
+ + diff --git a/documentation/doc/modules/modpol.util.misc.html b/documentation/doc/modules/modpol.util.misc.html new file mode 100644 index 0000000..a797dd2 --- /dev/null +++ b/documentation/doc/modules/modpol.util.misc.html @@ -0,0 +1,159 @@ + + + + + Reference + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module modpol.util.misc

+

Miscellaneous functions

+

+ + +

Functions

+ + + + + + + + + +
modpol.util.copy_table (t)Returns a copy of the table inputted
modpol.util.num_pairs (t)Returns the number of elements in a pairs table
+ +
+
+ + +

Functions

+ +
+
+ + modpol.util.copy_table (t) +
+
+ Returns a copy of the table inputted + + +

Parameters:

+
    +
  • t + table to copy +
    • +
+ +

Returns:

+
    + + copy of table +
+ + + + +
+
+ + modpol.util.num_pairs (t) +
+
+ Returns the number of elements in a pairs table + + +

Parameters:

+
    +
  • t + pairs table +
    • +
+ +

Returns:

+
    + + number of elements in pairs table +
+ + + + +
+
+ + +
+
+
+generated by LDoc 1.4.6 +Last updated 2022-01-20 10:54:01 +
+
+ + diff --git a/documentation/doc/modules/modpol_core.modules.join_org_consent.html b/documentation/doc/modules/modpol_core.modules.join_org_consent.html new file mode 100644 index 0000000..89dad99 --- /dev/null +++ b/documentation/doc/modules/modpol_core.modules.join_org_consent.html @@ -0,0 +1,145 @@ + + + + + Reference + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module modpol_core.modules.join_org_consent

+

Join org (consent).

+

+ A simple module that calls a consent process on an org to add a member. + Depends on the Consent module.

+ + +

Functions

+ + + + + + + + + +
initiate (result)Initiate join org with consent
complete ()Adds member to org, notifies org, and deletes process
+ +
+
+ + +

Functions

+ +
+
+ + initiate (result) +
+
+ Initiate join org with consent + + +

Parameters:

+
    +
  • result + +
    • +
+ + + + + +
+
+ + complete () +
+
+ Adds member to org, notifies org, and deletes process + + + + + + + +
+
+ + +
+
+
+generated by LDoc 1.4.6 +Last updated 2022-01-20 10:46:04 +
+
+ + diff --git a/documentation/doc/modules/modpol_core.modules.remove_org_consent.html b/documentation/doc/modules/modpol_core.modules.remove_org_consent.html new file mode 100644 index 0000000..a8108e6 --- /dev/null +++ b/documentation/doc/modules/modpol_core.modules.remove_org_consent.html @@ -0,0 +1,127 @@ + + + + + Reference + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module modpol_core.modules.remove_org_consent

+

Remove org (consent) + A simple module that calls a consent process on an org to remove it.

+

+ Depends on the Consent module.

+ + +

Functions

+ + + + + +
initiate (result)Remove org if all members consent
+ +
+
+ + +

Functions

+ +
+
+ + initiate (result) +
+
+ Remove org if all members consent + + +

Parameters:

+
    +
  • result + +
    • +
+ + + + + +
+
+ + +
+
+
+generated by LDoc 1.4.6 +Last updated 2022-01-20 10:30:14 +
+
+ + diff --git a/documentation/doc/modules/modpol_minetest.api.html b/documentation/doc/modules/modpol_minetest.api.html new file mode 100644 index 0000000..890d608 --- /dev/null +++ b/documentation/doc/modules/modpol_minetest.api.html @@ -0,0 +1,90 @@ + + + + + Reference + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module modpol_minetest.api

+

Script for loading Minetest files

+

+ + + +
+
+ + + + +
+
+
+generated by LDoc 1.4.6 +Last updated 2022-01-20 10:54:01 +
+
+ + diff --git a/documentation/doc/modules/module_template.html b/documentation/doc/modules/module_template.html new file mode 100644 index 0000000..5f53537 --- /dev/null +++ b/documentation/doc/modules/module_template.html @@ -0,0 +1,221 @@ + + + + + Reference + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module module_template

+

Template for module writers

+

+ + +

Functions

+ + + + + +
initiate (result)(Required): Initiate function + Modules have access to the following instance variables: +
  • self.org (the org the module was called in),
    • +
  • self.initiator (the user that callced the module),
    • +
  • self.id (the process id of the module instance)
    • +

    Tables

    + + + + + + + + + +
    data(Required) Data for module + Variables that module uses during the course of a process.
    config(Required): Config for module + Defines the input parameters to the module initiate function.
    +

    Fields

    + + + + + +
    modpol.modules.module_template(Required) Add to module table
    + +
    +
    + + +

    Functions

    + +
    +
    + + initiate (result) +
    +
    + (Required): Initiate function + Modules have access to the following instance variables: +
  • self.org (the org the module was called in),
    • +
  • self.initiator (the user that callced the module),
    • +
  • self.id (the process id of the module instance)
    • + + +

    Parameters:

    +
      +
    • result + (optional) Callback if this module is embedded in other modules +
      • +
    + + + + + +
    +
    +

    Tables

    + +
    +
    + + data +
    +
    + (Required) Data for module + Variables that module uses during the course of a process. + Can be blank + + + + + + + +
    +
    + + config +
    +
    + (Required): Config for module + Defines the input parameters to the module initiate function. + Can be blank + When calling a module from within another module, + variables not defined in config will be ignored. + Default values set in config can be overridden + + +

    Fields:

    +
      +
    • field_1 + ex: votes_required, default = 5 +
      • +
    • field_2 + ex: voting_type, default = "majority" +
      • +
    + + + + + +
    +
    +

    Fields

    + +
    +
    + + modpol.modules.module_template +
    +
    + (Required) Add to module table + + + + + + + +
    +
    + + +
    +
    +
    +generated by LDoc 1.4.6 +Last updated 2022-01-20 10:54:01 +
    +
    + + diff --git a/documentation/doc/modules/priv_to_org.html b/documentation/doc/modules/priv_to_org.html new file mode 100644 index 0000000..1d7e66d --- /dev/null +++ b/documentation/doc/modules/priv_to_org.html @@ -0,0 +1,125 @@ + + + + + Reference + + + + +
    + +
    + +
    +
    +
    + + +
    + + + + + + +
    + +

    Module priv_to_org

    +

    Set privilege to org members + Allows initiator to grant a priv they have to all members of an org

    +

    + + +

    Functions

    + + + + + +
    initiate (result)Initiate function
    + +
    +
    + + +

    Functions

    + +
    +
    + + initiate (result) +
    +
    + Initiate function + + +

    Parameters:

    +
      +
    • result + +
      • +
    + + + + + +
    +
    + + +
    +
    +
    +generated by LDoc 1.4.6 +Last updated 2022-01-20 10:54:01 +
    +
    + + diff --git a/documentation/doc/modules/remove_child_consent.html b/documentation/doc/modules/remove_child_consent.html new file mode 100644 index 0000000..cc003f3 --- /dev/null +++ b/documentation/doc/modules/remove_child_consent.html @@ -0,0 +1,127 @@ + + + + + Reference + + + + +
    + +
    + +
    +
    +
    + + +
    + + + + + + +
    + +

    Module remove_child_consent

    +

    Remove child (consent) + A simple module that calls a consent process on an org to remove its child + Depends on the Consent module.

    +

    + + +

    Functions

    + + + + + +
    initiate (result)Removes a child org with consent
    + +
    +
    + + +

    Functions

    + +
    +
    + + initiate (result) +
    +
    + Removes a child org with consent + + +

    Parameters:

    +
      +
    • result + +
      • +
    + + + + + +
    +
    + + +
    +
    +
    +generated by LDoc 1.4.6 +Last updated 2022-01-20 10:54:01 +
    +
    + + diff --git a/documentation/doc/modules/remove_member_consent.html b/documentation/doc/modules/remove_member_consent.html new file mode 100644 index 0000000..afc2639 --- /dev/null +++ b/documentation/doc/modules/remove_member_consent.html @@ -0,0 +1,124 @@ + + + + + Reference + + + + +
    + +
    + +
    +
    +
    + + +
    + + + + + + +
    + +

    Module remove_member_consent

    +

    Calls consent to remove member from org

    +

    + + +

    Functions

    + + + + + +
    initiate (result)Removes given member from org
    + +
    +
    + + +

    Functions

    + +
    +
    + + initiate (result) +
    +
    + Removes given member from org + + +

    Parameters:

    +
      +
    • result + +
      • +
    + + + + + +
    +
    + + +
    +
    +
    +generated by LDoc 1.4.6 +Last updated 2022-01-20 10:54:01 +
    +
    + + diff --git a/documentation/doc/modules/remove_org.html b/documentation/doc/modules/remove_org.html new file mode 100644 index 0000000..88c8ee8 --- /dev/null +++ b/documentation/doc/modules/remove_org.html @@ -0,0 +1,125 @@ + + + + + Reference + + + + +
    + +
    + +
    +
    +
    + + +
    + + + + + + +
    + +

    Module remove_org

    +

    A simple module that removes an org.

    +

    + + +

    Functions

    + + + + + +
    initiate (result)Removes org
    + +
    +
    + + +

    Functions

    + +
    +
    + + initiate (result) +
    +
    + Removes org + + +

    Parameters:

    +
      +
    • result + +
      • +
    + + + + + +
    +
    + + +
    +
    +
    +generated by LDoc 1.4.6 +Last updated 2022-01-20 10:54:01 +
    +
    + + diff --git a/documentation/doc/modules/remove_org_consent.html b/documentation/doc/modules/remove_org_consent.html new file mode 100644 index 0000000..d409d74 --- /dev/null +++ b/documentation/doc/modules/remove_org_consent.html @@ -0,0 +1,127 @@ + + + + + Reference + + + + +
    + +
    + +
    +
    +
    + + +
    + + + + + + +
    + +

    Module remove_org_consent

    +

    Remove org (consent) + A simple module that calls a consent process on an org to remove it.

    +

    + Depends on the Consent module.

    + + +

    Functions

    + + + + + +
    initiate (result)Remove org if all members consent
    + +
    +
    + + +

    Functions

    + +
    +
    + + initiate (result) +
    +
    + Remove org if all members consent + + +

    Parameters:

    +
      +
    • result + +
      • +
    + + + + + +
    +
    + + +
    +
    +
    +generated by LDoc 1.4.6 +Last updated 2022-01-20 10:54:01 +
    +
    + + diff --git a/documentation/doc/modules/rename_org_consent.html b/documentation/doc/modules/rename_org_consent.html new file mode 100644 index 0000000..29abba5 --- /dev/null +++ b/documentation/doc/modules/rename_org_consent.html @@ -0,0 +1,145 @@ + + + + + Reference + + + + +
    + +
    + +
    +
    +
    + + +
    + + + + + + +
    + +

    Module rename_org_consent

    +

    Rename org (consent) + A simple module that calls a consent process on an org to rename it.

    +

    + Depends on the Consent module.

    + + +

    Functions

    + + + + + + + + + +
    initiate (result)Renames the org after consent is reached
    complete ()Changes the name of the org after consent is reached
    + +
    +
    + + +

    Functions

    + +
    +
    + + initiate (result) +
    +
    + Renames the org after consent is reached + + +

    Parameters:

    +
      +
    • result + +
      • +
    + + + + + +
    +
    + + complete () +
    +
    + Changes the name of the org after consent is reached + + + + + + + +
    +
    + + +
    +
    +
    +generated by LDoc 1.4.6 +Last updated 2022-01-20 10:54:01 +
    +
    + + diff --git a/documentation/headers_template.html b/documentation/headers_template.html new file mode 100644 index 0000000..ce66f4a --- /dev/null +++ b/documentation/headers_template.html @@ -0,0 +1,63 @@ +

    Basic Functions

    + + +

    Core Modules

    + + +

    Minetest Modules

    + + + + +

    Basic Functions

    + + +

    Core Modules

    + + +

    Minetest Modules

    + \ No newline at end of file diff --git a/modpol_core/modules/add_child_org_consent.lua b/modpol_core/modules/add_child_org_consent.lua index e323e19..1c74729 100644 --- a/modpol_core/modules/add_child_org_consent.lua +++ b/modpol_core/modules/add_child_org_consent.lua @@ -1,6 +1,6 @@ ---- @module add_child_org_consent --- Adds a child org +--- Adds a child org. -- Depends on `consent` +-- @module add_child_org_consent local add_child_org_consent = { name = "Add child org (consent)", @@ -14,7 +14,9 @@ add_child_org_consent.data = { add_child_org_consent.config = { } --- @function initiate +--- Initiate consent for new child org +-- @function add_child_org_consent:initiate(result) +-- @param result function add_child_org_consent:initiate(result) modpol.interactions.text_query( self.initiator,"Child org name: ", @@ -61,6 +63,8 @@ function add_child_org_consent:initiate(result) ) end +--- Create a new child orgg +-- @function add_child_org_consent:create_child_org function add_child_org_consent:create_child_org() self.org:add_org(self.data.child_name, self.initiator) modpol.interactions.message_org( @@ -71,5 +75,4 @@ function add_child_org_consent:create_child_org() self.org:delete_process(self.id) end ---- (Required) Add to module table modpol.modules.add_child_org_consent = add_child_org_consent diff --git a/modpol_core/modules/change_modules.lua b/modpol_core/modules/change_modules.lua index 7b15417..7457ed5 100644 --- a/modpol_core/modules/change_modules.lua +++ b/modpol_core/modules/change_modules.lua @@ -1,6 +1,6 @@ --- change_modules --- @module change_modules -- Depends on consent +-- @module change_modules local change_modules = { name = "Change modules (consent)", @@ -16,6 +16,9 @@ change_modules.data = { change_modules.config = { } +--- Initiate change in modules. +-- Either adds or removes module depending on user input +-- @function change_modules:initiate function change_modules:initiate(result) self.data.result = result -- Step 1: add or remove? @@ -167,5 +170,4 @@ function change_modules:propose_change(type, mod_text) self.org:delete_process(self.id) end ---- (Required) Add to module table modpol.modules.change_modules = change_modules diff --git a/modpol_core/modules/consent.lua b/modpol_core/modules/consent.lua index 78deca1..cf1ec4c 100644 --- a/modpol_core/modules/consent.lua +++ b/modpol_core/modules/consent.lua @@ -1,5 +1,5 @@ ---- @module consent --- A utility module for checking consent +--- A utility module for checking consent +-- @module consent local consent = { name = "Consent process utility", @@ -17,6 +17,9 @@ consent.config = { votes_required = 1 } +--- Initiate consent +-- @function consent:initiate +-- @param result function consent:initiate(result) self.data.result = result -- if org is empty, consent is given automatically @@ -32,6 +35,9 @@ function consent:initiate(result) end end +--- Callback +-- @function consent:callback +-- @param member function consent:callback(member) modpol.interactions.binary_poll_user( member, diff --git a/modpol_core/modules/join_org.lua b/modpol_core/modules/join_org.lua index 23d277b..8405ac6 100644 --- a/modpol_core/modules/join_org.lua +++ b/modpol_core/modules/join_org.lua @@ -1,3 +1,5 @@ +--- Adds a user to org +-- @module join_org join_org = {} @@ -7,6 +9,9 @@ join_org.setup = { desc = "If consent process is passed, initiator joins this org." } +--- Adds the user to the org +-- @function join_org.initiate +-- @param result function join_org.initiate(result) modpol.interactions.binary_poll_user( initiator, diff --git a/modpol_core/modules/join_org_consent.lua b/modpol_core/modules/join_org_consent.lua index 9bfa437..14c886b 100644 --- a/modpol_core/modules/join_org_consent.lua +++ b/modpol_core/modules/join_org_consent.lua @@ -1,6 +1,7 @@ ---- Join org (consent) +--- Join org (consent). -- A simple module that calls a consent process on an org to add a member. -- Depends on the Consent module. +-- @module join_org_consent local join_org_consent = { name = "Join this org (consent)", @@ -15,6 +16,9 @@ join_org_consent.data = { join_org_consent.config = { } +--- Initiate join org with consent +-- @function join_org_consent:initiate +-- @param result function join_org_consent:initiate(result) if self.org:has_member(self.initiator) then modpol.interactions.message( @@ -38,6 +42,8 @@ function join_org_consent:initiate(result) end end +--- Adds member to org, notifies org, and deletes process +-- @function join_org_consent:complete function join_org_consent:complete() self.org:add_member(self.initiator) modpol.interactions.message_org( diff --git a/modpol_core/modules/leave_org.lua b/modpol_core/modules/leave_org.lua index d8e685d..2ba71ee 100644 --- a/modpol_core/modules/leave_org.lua +++ b/modpol_core/modules/leave_org.lua @@ -1,4 +1,4 @@ ---- leave_org +--- Removes initiator from org -- @module leave_org local leave_org = { @@ -13,10 +13,9 @@ leave_org.data = { leave_org.config = { } ---- (Required): initiate function --- Modules have access to the following instance variables: --- @param result (optional) Callback if this module is embedded in other modules --- @function initiate +--- Removes user from org +-- @function leave_org:initiate +-- @param result function leave_org:initiate(result) if self.org == modpol.instance then modpol.interactions.message( @@ -35,5 +34,4 @@ function leave_org:initiate(result) self.org:delete_process(self.id) end ---- (Required) Add to module table modpol.modules.leave_org = leave_org diff --git a/modpol_core/modules/message_org.lua b/modpol_core/modules/message_org.lua index 8262989..90f0263 100644 --- a/modpol_core/modules/message_org.lua +++ b/modpol_core/modules/message_org.lua @@ -1,4 +1,4 @@ ---- message_org +--- Messages all org members -- @module message_org local message_org = { @@ -14,7 +14,9 @@ message_org.data = { message_org.config = { } +--- Allows user to send input message to all org members -- @function initiate +-- @param result function message_org:initiate(result) modpol.interactions.text_query( self.initiator, "Message to all org members: ", @@ -34,5 +36,4 @@ function message_org:initiate(result) self.org:delete_process(self.id) end ---- (Required) Add to module table modpol.modules.message_org = message_org diff --git a/modpol_core/modules/remove_child_consent.lua b/modpol_core/modules/remove_child_consent.lua index ba3255e..64f33de 100644 --- a/modpol_core/modules/remove_child_consent.lua +++ b/modpol_core/modules/remove_child_consent.lua @@ -1,6 +1,7 @@ --- Remove child (consent) -- A simple module that calls a consent process on an org to remove its child -- Depends on the Consent module. +-- @module remove_child_consent local remove_child_consent = { name = "Remove child (consent)", @@ -16,6 +17,9 @@ remove_child_consent.data = { remove_child_consent.config = { } +--- Removes a child org with consent +-- @function remove_child_consent:initiate +-- @param result function remove_child_consent:initiate(result) local children = {} for i,v in ipairs(self.org.children) do diff --git a/modpol_core/modules/remove_member_consent.lua b/modpol_core/modules/remove_member_consent.lua index fc118e1..1aafe29 100644 --- a/modpol_core/modules/remove_member_consent.lua +++ b/modpol_core/modules/remove_member_consent.lua @@ -1,4 +1,4 @@ ---- remove_member_consent +--- Calls consent to remove member from org -- @module remove_member_consent local remove_member_consent = { @@ -15,6 +15,9 @@ remove_member_consent.data = { remove_member_consent.config = { } +--- Removes given member from org +-- @function remove_member_consent:initiate +-- @param result function remove_member_consent:initiate(result) -- Abort if in root org if self.org == modpol.instance then @@ -60,5 +63,4 @@ function remove_member_consent:complete() if self.data.result then self.data.result() end end ---- (Required) Add to module table modpol.modules.remove_member_consent = remove_member_consent diff --git a/modpol_core/modules/remove_org.lua b/modpol_core/modules/remove_org.lua index b2118d1..f7fa5d7 100644 --- a/modpol_core/modules/remove_org.lua +++ b/modpol_core/modules/remove_org.lua @@ -1,8 +1,6 @@ ---- @module Remove Org --- A simple module that removes an org. +--- A simple module that removes an org. +-- @module remove_org - ---- Main module table remove_org = { name = "Remove this org", slug = "remove_org", @@ -12,8 +10,9 @@ remove_org = { remove_org.config = {} remove_org.data = {} ---- Initiate function --- @function initiate +--- Removes org +-- @function remove_org:initiate +-- @param result function remove_org:initiate(result) if self.org == modpol.instance then modpol.interactions.message( diff --git a/modpol_core/modules/remove_org_consent.lua b/modpol_core/modules/remove_org_consent.lua index f9e8513..11b3c97 100644 --- a/modpol_core/modules/remove_org_consent.lua +++ b/modpol_core/modules/remove_org_consent.lua @@ -1,6 +1,7 @@ --- Remove org (consent) -- A simple module that calls a consent process on an org to remove it. -- Depends on the Consent module. +-- @module remove_org_consent local remove_org_consent = { name = "Remove this org (consent)", @@ -15,6 +16,9 @@ remove_org_consent.data = { remove_org_consent.config = { } +--- Remove org if all members consent +-- @function remove_org_consent:initiate +-- @param result function remove_org_consent:initiate(result) if self.org == modpol.instance then modpol.interactions.message( diff --git a/modpol_core/modules/rename_org_consent.lua b/modpol_core/modules/rename_org_consent.lua index 1b9aa47..8e4336e 100644 --- a/modpol_core/modules/rename_org_consent.lua +++ b/modpol_core/modules/rename_org_consent.lua @@ -1,6 +1,7 @@ --- Rename org (consent) -- A simple module that calls a consent process on an org to rename it. -- Depends on the Consent module. +-- @module rename_org_consent local rename_org_consent = { name = "Rename this org (consent)", @@ -16,6 +17,9 @@ rename_org_consent.data = { rename_org_consent.config = { } +--- Renames the org after consent is reached +-- @function rename_org_consent:initiate +-- @param result function rename_org_consent:initiate(result) modpol.interactions.text_query( self.initiator,"New org name: ", @@ -63,6 +67,8 @@ function rename_org_consent:initiate(result) ) end +--- Changes the name of the org after consent is reached +-- @funciton rename_org_consent function rename_org_consent:complete() modpol.interactions.message_org( self.initiator, diff --git a/modpol_core/modules/template.lua b/modpol_core/modules/template.lua index aeb1a04..fd8efb9 100644 --- a/modpol_core/modules/template.lua +++ b/modpol_core/modules/template.lua @@ -38,7 +38,7 @@ module_template.config = { --
  • self.initiator (the user that callced the module),
    • --
  • self.id (the process id of the module instance)
    • -- @param result (optional) Callback if this module is embedded in other modules --- @function initiate +-- @function module_template:initiate function module_template:initiate(result) -- call interaction functions here! diff --git a/modpol_core/util/misc.lua b/modpol_core/util/misc.lua index e213326..1cceeb8 100644 --- a/modpol_core/util/misc.lua +++ b/modpol_core/util/misc.lua @@ -1,7 +1,12 @@ +--- Miscellaneous functions +-- @module modpol.util.misc + modpol.util = {} ---- @function modpol.copy_table --- Returns a copy of the table inputted +--- Returns a copy of the table inputted +-- @function modpol.util.copy_table +-- @param t table to copy +-- @return copy of table function modpol.util.copy_table(t) local t2 = {} for k,v in pairs(t) do @@ -10,8 +15,10 @@ function modpol.util.copy_table(t) return t2 end ---- @function modpol.copy_table --- Returns the number of elements in a pairs table +--- Returns the number of elements in a pairs table +-- @function modpol.util.num_pairs +-- @param t pairs table +-- @return number of elements in pairs table function modpol.util.num_pairs(t) local i = 0 for k,v in pairs(t) do diff --git a/modpol_minetest/modules/priv_to_org.lua b/modpol_minetest/modules/priv_to_org.lua index 086fd0e..a97d0cd 100644 --- a/modpol_minetest/modules/priv_to_org.lua +++ b/modpol_minetest/modules/priv_to_org.lua @@ -1,6 +1,6 @@ --- Set privilege to org members --- @module priv_to_org -- Allows initiator to grant a priv they have to all members of an org +-- @module priv_to_org local priv_to_org = { name = "Set privilege to org members", @@ -14,9 +14,9 @@ priv_to_org.data = { priv_to_org.config = { } ---- (Required): initiate function --- @param result (optional) Callback if this module is embedded in other modules --- @function initiate +--- Initiate function +-- @function priv_to_org:initiate +-- @param result function priv_to_org:initiate(result) local player_privs = minetest.get_player_privs(self.initiator) -- construct table for display @@ -45,5 +45,4 @@ function priv_to_org:initiate(result) if result then result() end end ---- (Required) Add to module table modpol.modules.priv_to_org = priv_to_org