Added ldoc comments and slug variable for setup
This commit is contained in:
@ -1,29 +1,39 @@
|
||||
--- Template for modules
|
||||
-- function initiate and table setup are required as a base.
|
||||
-- @module Template
|
||||
Template = {}
|
||||
|
||||
|
||||
Module = {}
|
||||
|
||||
Module.setup = {
|
||||
name = "Module Name",
|
||||
--- (Required): setup table containing name and description of the module
|
||||
-- @field name "Module Human-Readable Name"
|
||||
-- @field slug "Template" same as module name
|
||||
-- @field desc "Description of the module"
|
||||
Template.setup = {
|
||||
name = "Module Human-Readable Name",
|
||||
slug = "Template",
|
||||
desc = "Description of the module"
|
||||
}
|
||||
|
||||
-- defines the input parameters to the module initiate function
|
||||
-- when calling a module from within another module
|
||||
-- variables not defined in config will be ignored
|
||||
-- default values set in config can be overridden
|
||||
Module.config = {
|
||||
votes_required = 5
|
||||
voting_type = "majority"
|
||||
--- (Optional): config for module
|
||||
-- Defines the input parameters to the module initiate function.
|
||||
-- When calling a module from within another module,
|
||||
-- variables not defined in config will be ignored.
|
||||
-- Default values set in config can be overridden
|
||||
-- @field field_1 ex: votes_required, default = 5
|
||||
-- @field field_2 ex: voting_type, default = "majority"
|
||||
Template.config = {
|
||||
field_1 = 5
|
||||
field_2 = "majority"
|
||||
}
|
||||
|
||||
-- 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)
|
||||
|
||||
function Module:initiate(config, result)
|
||||
--- (Required): initiate function
|
||||
-- Modules have access to the following instance variables:
|
||||
-- <li><code>self.org</code> (the org the module was called in),</li>
|
||||
-- <li><code>self.initiator</code> (the user that callced the module),</li>
|
||||
-- <li><code>self.id</code> (the process id of the module instance)</li>
|
||||
-- @function initiate
|
||||
function Template:initiate(config, result)
|
||||
-- call interaction functions here!
|
||||
|
||||
-- call result function
|
||||
if result then result() end
|
||||
end
|
||||
end
|
||||
|
Reference in New Issue
Block a user