Difference between revisions of "Vogon"

From GiderosMobile
Line 16: Line 16:
 
Feel free to experiment with vogon.wiki.lua and publish revisions of the Vogon API, which should however
 
Feel free to experiment with vogon.wiki.lua and publish revisions of the Vogon API, which should however
 
remain decidedly non-Vogon in brevity. Maybe keep some reference to the files involved/the true purpose of
 
remain decidedly non-Vogon in brevity. Maybe keep some reference to the files involved/the true purpose of
the mission too.
+
the mission too.  
 
</translate><br/>
 
</translate><br/>
 
=== <translate>Examples</translate> ===
 
=== <translate>Examples</translate> ===
Line 36: Line 36:
 
| style="width: 50%; vertical-align:top;"|
 
| style="width: 50%; vertical-align:top;"|
 
=== <translate>Events</translate> ===
 
=== <translate>Events</translate> ===
[[Special:MyLanguage/Vogon.Vogon.IMMINENT_DESTRUCTION|Vogon.Vogon.IMMINENT_DESTRUCTION]]<br/>
+
[[Special:MyLanguage/Vogon.IMMINENT_DESTRUCTION|Vogon.IMMINENT_DESTRUCTION]]<br/>
[[Special:MyLanguage/Vogon.Vogon.POST_DESTRUCTION|Vogon.Vogon.POST_DESTRUCTION]]<br/>
+
[[Special:MyLanguage/Vogon.POST_DESTRUCTION|Vogon.POST_DESTRUCTION]]<br/>
 
=== <translate>Constants</translate> ===
 
=== <translate>Constants</translate> ===
[[Special:MyLanguage/Vogon.Vogon.STATUS_SIGN_POSTED|Vogon.Vogon.STATUS_SIGN_POSTED]]<br/>
+
[[Special:MyLanguage/Vogon.STATUS_SIGN_POSTED|Vogon.STATUS_SIGN_POSTED]]<br/>
[[Special:MyLanguage/Vogon.Vogon.STATUS_DESTRUCTION_APPROVED|Vogon.Vogon.STATUS_DESTRUCTION_APPROVED]]<br/>
+
[[Special:MyLanguage/Vogon.STATUS_DESTRUCTION_APPROVED|Vogon.STATUS_DESTRUCTION_APPROVED]]<br/>
 
|}
 
|}

Revision as of 01:15, 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, which should however remain decidedly non-Vogon in brevity. Maybe keep some reference to the files involved/the true purpose of the mission too.

Examples

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