Difference between revisions of "Vogon"
From GiderosMobile
| Line 5: | Line 5: | ||
<br/> | <br/> | ||
'''<translate>Available since</translate>:''' 2042.11<br/> | '''<translate>Available since</translate>:''' 2042.11<br/> | ||
| − | '''<translate>Inherits from</translate>:''' [[Special:MyLanguage/ | + | '''<translate>Inherits from</translate>:''' [[Special:MyLanguage/Cryptography|Cryptography]]<br/> |
<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 | ||
| − | repository. From a Lua description file, multiple pages are created which can then be relatively easily | + | repository using the included vogon.wiki.lua file. From a Lua description file, multiple pages are created |
| − | copied and pasted into new pages. Run | + | which can then be relatively easily copied and pasted into new pages. Run create-wiki-pages.lua without |
| + | arguments for instructions.<br/> | ||
| + | <br/> | ||
| + | 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. | ||
</translate><br/> | </translate><br/> | ||
=== <translate>Examples</translate> === | === <translate>Examples</translate> === | ||
| Line 18: | Line 23: | ||
<source lang="lua">require "Vogon" | <source lang="lua">require "Vogon" | ||
local vogon = Vogon.new() | local vogon = Vogon.new() | ||
| − | vogon:writePoetry() | + | local poetry = vogon:writePoetry(topic) |
| − | vogon: | + | local number_of_deaths = vogon:recitePoetry() |
</source> | </source> | ||
| Line 28: | Line 33: | ||
[[Special:MyLanguage/Vogon.new|Vogon.new]] ''<translate>Create a new Vogon</translate>''<br/><!-- GIDEROSMTD:Vogon.new() Create a new Vogon --> | [[Special:MyLanguage/Vogon.new|Vogon.new]] ''<translate>Create a new Vogon</translate>''<br/><!-- GIDEROSMTD:Vogon.new() Create a new Vogon --> | ||
[[Special:MyLanguage/Vogon:writePoetry|Vogon:writePoetry]] ''<translate>Creates abnormally long poem.</translate>''<br/><!-- GIDEROSMTD:Vogon:writePoetry(topic) Creates abnormally long poem. --> | [[Special:MyLanguage/Vogon:writePoetry|Vogon:writePoetry]] ''<translate>Creates abnormally long poem.</translate>''<br/><!-- GIDEROSMTD:Vogon:writePoetry(topic) Creates abnormally long poem. --> | ||
| − | [[Special:MyLanguage/Vogon: | + | [[Special:MyLanguage/Vogon:recitePoetry|Vogon:recitePoetry]] ''<translate>Recites the third worst poetry in the known universe.</translate>''<br/><!-- GIDEROSMTD:Vogon:recitePoetry(topic) Recites the third worst poetry in the known universe. --> |
| style="width: 50%; vertical-align:top;"| | | style="width: 50%; vertical-align:top;"| | ||
=== <translate>Events</translate> === | === <translate>Events</translate> === | ||
| − | [[Special:MyLanguage/Vogon.IMMINENT_DESTRUCTION|Vogon.IMMINENT_DESTRUCTION]]<br/> | + | [[Special:MyLanguage/Vogon.Vogon.IMMINENT_DESTRUCTION|Vogon.Vogon.IMMINENT_DESTRUCTION]]<br/> |
| − | [[Special:MyLanguage/Vogon.POST_DESTRUCTION|Vogon.POST_DESTRUCTION]]<br/> | + | [[Special:MyLanguage/Vogon.Vogon.POST_DESTRUCTION|Vogon.Vogon.POST_DESTRUCTION]]<br/> |
=== <translate>Constants</translate> === | === <translate>Constants</translate> === | ||
| − | [[Special:MyLanguage/Vogon.STATUS_SIGN_POSTED|Vogon.STATUS_SIGN_POSTED]]<br/> | + | [[Special:MyLanguage/Vogon.Vogon.STATUS_SIGN_POSTED|Vogon.Vogon.STATUS_SIGN_POSTED]]<br/> |
| − | [[Special:MyLanguage/Vogon.STATUS_DESTRUCTION_APPROVED|Vogon.STATUS_DESTRUCTION_APPROVED]]<br/> | + | [[Special:MyLanguage/Vogon.Vogon.STATUS_DESTRUCTION_APPROVED|Vogon.Vogon.STATUS_DESTRUCTION_APPROVED]]<br/> |
|} | |} | ||
Revision as of 02:09, 15 September 2018
Supported platforms: 
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()
MethodsVogon.new Create a new Vogon |
EventsVogon.Vogon.IMMINENT_DESTRUCTION ConstantsVogon.Vogon.STATUS_SIGN_POSTED |
