ZMedia

From Wherigo Foundation Wiki
Jump to: navigation, search

ZMedia represents a media file used by the cartridge, usually an image. Note that the Garmin Colorado only supports JPEG formatted files in 24 bits, when compiled with the original Groundspeak compiler.

Possible media types are bmp, jpg, png, gif, wav, mp3, fdl, ogg, swf, snd, txt.


Properties

AltText String Natural language text to be displayed if the media file is not available.
Description String Natural language description of the media.
Id String Unique hex identifier assigned by Builder.
Name String Natural language name of the media.
Resources Table Describes the media file itself; contains three sub-properties: Type, a string describing the type of media (such as "jpg"); Filename, a string specifying the filename the media should reference; and Directives, an array which may contain attributes such as "NoResize".


Constructor

ZMedia Wherigo.ZMedia(ZCartridge cartridge) Returns a new instance of object ZMedia. The only parameter is a instance of ZCartridge.
Zone Wherigo.Zone({parameters}) Parameter is a table with default entries. It is possible to set the following properties: AltText. Additionally all parameters, which are valid for ZObject constructor.