Module:Map/doc: Difference between revisions

From RuneRealm Wiki
Jump to navigation Jump to search
(Created page with "{{Documentation}} {{APIDoc |funcName = map |funcDesc = The main entry point for templates and pages. Should only be called via <code>{{#invoke}}</code> outside of a module. |arg1 = frame |type1 = [https://www.mediawiki.org/wiki/Extension:Scribunto/Lua_reference_manual#frame-object frame object] |desc1 = The frame object automatically passed via <code>{{#invoke}}</code>. |returnType = string |returnDesc = A fully rendered map. }} {{APIDoc |funcName = buildMap |funcDesc =...")
 
No edit summary
Tag: Manual revert
 
(One intermediate revision by the same user not shown)
(No difference)

Latest revision as of 11:23, 17 October 2024

This is a documentation subpage for Module:Map.
It contains usage information, categories, and other content that is not part of the original module page.
Module:Map's function map is invoked by Template:Map.
Module:Map requires Module:Paramtest.
Module:Map is required by Module:Clues.
map(frame)
The main entry point for templates and pages. Should only be called via {{#invoke}} outside of a module.
ArgumentTypeDescriptionOptional
frameframe objectThe frame object automatically passed via {{#invoke}}.
ReturnsstringA fully rendered map.
buildMap(args)
The main entry point for other modules.
ArgumentTypeDescriptionOptional
argstableAny map or feature arguments.
ReturnsstringA fully rendered map.
getMap(name, mapOpts)
Pulls a map from SMW.
ArgumentTypeDescriptionOptional
namestringThe page name to use in the look up. Append the version name the map is defined under (e.g., #Version1 or #Version2) if there is one.
mapOptstableMap options to control the map behaviour.
ReturnsstringA fully rendered map.