Difference between revisions of "Vogon"

From GiderosMobile
Line 7: Line 7:
 
'''<translate>Inherits from</translate>:''' [[Special:MyLanguage/Cryptography|Cryptography]]<br/>
 
'''<translate>Inherits from</translate>:''' [[Special:MyLanguage/Cryptography|Cryptography]]<br/>
  
<br/>
+
 
 
=== <translate>Description</translate> ===
 
=== <translate>Description</translate> ===
 
<translate>This is just a test of docs gen from the create-wiki-pages.lua script in the plugins folder of the Gideros  
 
<translate>This is just a test of docs gen from the create-wiki-pages.lua script in the plugins folder of the Gideros  

Revision as of 11:10, 15 September 2018


Supported platforms: Platform android.pngPlatform ios.pngPlatform pc.pngPlatform mac.pngPlatform winrt.pngPlatform win32.pngPlatform html5.png

Available since: 2042.11
Inherits from: Cryptography


Description

This is just a test of docs gen from the create-wiki-pages.lua script in the plugins folder of the Gideros repository using the included vogon.wiki.lua file. From a Lua description file, multiple pages are created which can then be relatively easily copied and pasted into new pages. Run create-wiki-pages.lua without arguments for instructions.

Feel free to experiment with vogon.wiki.lua and publish revisions of the Vogon API.

Example

Standard use of a Vogon.

require "Vogon"
local vogon = Vogon.new()
local poetry = vogon:writePoetry(topic)
local number_of_deaths = vogon:recitePoetry()

Methods

Vogon.new Create a new Vogon
Vogon:writePoetry Creates abnormally long poem.
Vogon:recitePoetry Recites the third worst poetry in the known universe.

Events

Vogon.IMMINENT_DESTRUCTION
Vogon.POST_DESTRUCTION

Constants

Vogon.STATUS_SIGN_POSTED
Vogon.STATUS_DESTRUCTION_APPROVED