Module:Map/doc: Difference between revisions
		
		
		
		
		
		Jump to navigation
		Jump to search
		
				
		
		
	
Content added Content deleted
| No edit summary Tag: Reverted | No edit summary Tag: Manual revert | ||
| Line 3: | Line 3: | ||
| {{APIDoc | {{APIDoc | ||
| |funcName = map | |funcName = map | ||
| |funcDesc = The main entry point for templates and  | |funcDesc = The main entry point for templates and pages. Should only be called via <code>{{#invoke}}</code> outside of a module. | ||
| |arg1 = frame | |arg1 = frame | ||
| |type1 = [https://www.mediawiki.org/wiki/Extension:Scribunto/Lua_reference_manual#frame-object frame object] | |type1 = [https://www.mediawiki.org/wiki/Extension:Scribunto/Lua_reference_manual#frame-object frame object] | ||
Latest revision as of 11:23, 17 October 2024
Module:Map's function map is invoked by Template:Map.
Module:Map requires Module:Paramtest.
Module:Map is required by Module:Clues.
Module:Map is required by Module:Sandbox/User:Als Toy Barn/ShopLocLine.
| map(frame) | |||
| The main entry point for templates and pages. Should only be called via {{#invoke}}outside of a module. | |||
| Argument | Type | Description | Optional | 
| frame | frame object | The frame object automatically passed via {{#invoke}}. | |
| Returns | string | A fully rendered map. | |
| buildMap(args) | |||
| The main entry point for other modules. | |||
| Argument | Type | Description | Optional | 
| args | table | Any map or feature arguments. | |
| Returns | string | A fully rendered map. | |
| getMap(name, mapOpts) | |||
| Pulls a map from SMW. | |||
| Argument | Type | Description | Optional | 
| name | string | The page name to use in the look up. Append the version name the map is defined under (e.g., #Version1or#Version2) if there is one. | |
| mapOpts | table | Map options to control the map behaviour. |  | 
| Returns | string | A fully rendered map. | |
