Template:FFXIMap Markers: Difference between revisions

From HorizonXI Wiki
No edit summary
No edit summary
Line 32: Line 32:
}}
}}
</pre>
</pre>
*'''mapid:''' Each zone map has a corresponding id# (see below).
{| class="wikitable"
|+
!parameter
!default
!type
!description
|-
|mapid
|''none - [required]''
|''integer''
|Each zone map has a corresponding id# to help associate markers to map. See table "Map ID Data" at [[Template:FFXIMap]] for details on these values.
|-
|mapx
|''none - [required]''
|''float''
|''[value must be between 0-256]'' The X position on the FFXIMap. Values for this should be decimals (ie: 17.134). Map positioning for all markers used within the FFXIMap extension have a coordinate system that starts at 0,0 for the bottom left and 256,256 for the top right. A marker position must be within those bounds to be visible on the map. In order to get these numbers you must view an FFXIMap with the added parameter 'showdetails=true' and use the mouse to determine the coordinates of a specific location. See [[Template:FFXIMap]] for more details.
|-
|mapy
|''none - [required]''
|''float''
|''[value must be between 0-256]'' The Y position on the FFXIMap. Values for this should be decimals (ie: 17.134). Description is the same as the mapx position above.
|-
|entitytype
|''none - [required]''
|''number''
|There are "types" of markers (ie:NPC, Seasonal NPC, ???, etc.). These types are bundled in layers on the FFXIMap where the user is able to turn on/off a particular layer they want to see. 
|-
|image
|''none - [optional]''
|''text''
|This is the filename of the image. Do not use wikitext in this field.
|-
|displayposition
|''none - [optional]''
|''text''
|This is a simple line of text. This is the in-game x,y coordinates tor this marker. There are many HorizonXI approved addons/plugins that provide this information. Format should include the parenthesis, ie: (x,y)
|}


Map positioning for all markers used within the FFXIMap extension have a coordinate system that starts at 0,0 for the bottom left and 256,256 for the top right. A marker position must be within those bounds to be visible on the map. In order to get these numbers you must view an FFXIMap with the added parameter 'showdetails=true'. See [[Template:FFXIMap]] for more details.
*'''mapx:''' The x position on the map. (number should be between 0 and 256)
*'''mapy:''' The y position on the map. (number should be between 0 and 256) 
*'''entitytype:''' There are "types" of markers (ie:NPC, Seasonal NPC, ???, etc.). These types are bundled in layers on the FFXIMap where the user is able to turn on/off a particular layer they want to see.   
*'''image:''' This is the filename of the image. Do not use wikitext in this field.
*'''displayposition:''' This is a simple line of text. his is the in-game x,y coordinates tor this marker. There are many HorizonXI approved addons/plugins that provide this information. Format should include the parenthesis, ie: (x,y)
===Example Usage===
===Example Usage===
This tag is added to the bottom of a page which you want added as a marker to a map.  
This tag is added to the bottom of a page which you want added as a marker to a map.  

Revision as of 14:38, 7 November 2023

This template defines the table "ffximap_markers". This table has not been created yet.


THIS IS STILL UNDER CONSTRUCTION - DO NOT ATTEMPT USING THIS YET PLEASE

Usage

Add this tag to an entity you wish displayed on the FFXIMap. 

{{FFXIMap Markers
|mapid=
|mapx=
|mapy=
|entitytype=
|image=
|displayposition=
}}
parameter default type description
mapid none - [required] integer Each zone map has a corresponding id# to help associate markers to map. See table "Map ID Data" at Template:FFXIMap for details on these values.
mapx none - [required] float [value must be between 0-256] The X position on the FFXIMap. Values for this should be decimals (ie: 17.134). Map positioning for all markers used within the FFXIMap extension have a coordinate system that starts at 0,0 for the bottom left and 256,256 for the top right. A marker position must be within those bounds to be visible on the map. In order to get these numbers you must view an FFXIMap with the added parameter 'showdetails=true' and use the mouse to determine the coordinates of a specific location. See Template:FFXIMap for more details.
mapy none - [required] float [value must be between 0-256] The Y position on the FFXIMap. Values for this should be decimals (ie: 17.134). Description is the same as the mapx position above.
entitytype none - [required] number There are "types" of markers (ie:NPC, Seasonal NPC, ???, etc.). These types are bundled in layers on the FFXIMap where the user is able to turn on/off a particular layer they want to see.
image none - [optional] text This is the filename of the image. Do not use wikitext in this field.
displayposition none - [optional] text This is a simple line of text. This is the in-game x,y coordinates tor this marker. There are many HorizonXI approved addons/plugins that provide this information. Format should include the parenthesis, ie: (x,y)

Example Usage

This tag is added to the bottom of a page which you want added as a marker to a map. 

{{FFXIMap Markers
|mapid=141
|mapx=25.9
|mapy=157.72
|entitytype=NPC
|image=Guslam.png
|displayposition=(179,-216.8)
}}
Retrieved from "https://horizonffxi.wiki/w/index.php?title=Template:FFXIMap_Markers&oldid=26072"