Difference between revisions of "Vogon"

From GiderosMobile
m (Text replacement - "<source" to "<syntaxhighlight")
 
(10 intermediate revisions by one other user not shown)
Line 3: Line 3:
 
<!-- GIDEROSOBJ:Vogon -->
 
<!-- GIDEROSOBJ:Vogon -->
 
'''<translate>Supported platforms</translate>:''' [[File:Platform android.png]][[File:Platform ios.png]][[File:Platform pc.png]][[File:Platform mac.png]][[File:Platform winrt.png]][[File:Platform win32.png]][[File:Platform html5.png]]<br/>
 
'''<translate>Supported platforms</translate>:''' [[File:Platform android.png]][[File:Platform ios.png]][[File:Platform pc.png]][[File:Platform mac.png]][[File:Platform winrt.png]][[File:Platform win32.png]][[File:Platform html5.png]]<br/>
−
<br/>
 
 
'''<translate>Available since</translate>:''' 2042.11<br/>
 
'''<translate>Available since</translate>:''' 2042.11<br/>
 
'''<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>Main Vogon class.
−
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.<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>Example</translate> ===
  
 
'''Standard use of a Vogon.'''<br/>
 
'''Standard use of a Vogon.'''<br/>
−
<source lang="lua">require "Vogon"
+
<syntaxhighlight lang="lua">require "Vogon"
 
local vogon = Vogon.new()
 
local vogon = Vogon.new()
 
local poetry = vogon:writePoetry(topic)
 
local poetry = vogon:writePoetry(topic)
Line 33: Line 24:
 
[[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: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. -->
+
[[Special:MyLanguage/Vogon:recitePoetry|Vogon:recitePoetry]]  ''<translate>Recites the third worst poetry in the known universe.</translate>''<br/><!-- GIDEROSMTD:Vogon:recitePoetry() 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.Vogon.IMMINENT_DESTRUCTION|Vogon.Vogon.IMMINENT_DESTRUCTION]]<br/>
+
[[Special:MyLanguage/Vogon.DESTRUCTION_IMMINENT|Vogon.DESTRUCTION_IMMINENT]]<br/>
−
[[Special:MyLanguage/Vogon.Vogon.POST_DESTRUCTION|Vogon.Vogon.POST_DESTRUCTION]]<br/>
+
[[Special:MyLanguage/Vogon.DESTRUCTION_COMPLETE|Vogon.DESTRUCTION_COMPLETE]]<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/>
 
|}
 
|}

Latest revision as of 14:32, 13 July 2023


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

Main Vogon class.

Example

Standard use of a Vogon.
<syntaxhighlight lang="lua">require "Vogon" local vogon = Vogon.new() local poetry = vogon:writePoetry(topic) local number_of_deaths = vogon:recitePoetry() </source>

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.DESTRUCTION_IMMINENT
Vogon.DESTRUCTION_COMPLETE

Constants

Vogon.STATUS_SIGN_POSTED
Vogon.STATUS_DESTRUCTION_APPROVED

Retrieved from ‘https://wiki.gideros.rocks/index.php?title=Vogon&oldid=22132’