Template:FFXIMap Markers: Difference between revisions
From HorizonXI Wiki
Starfox9507 (talk | contribs) No edit summary |
Starfox9507 (talk | contribs) No edit summary |
||
| Line 1: | Line 1: | ||
<noinclude>{{#cargo_declare:_table= | |||
<noinclude>{{#cargo_declare:_table=ffximapmarkers | |||
|mapid=Integer | |mapid=Integer | ||
|mapx=Float | |mapx=Float | ||
| Line 6: | Line 7: | ||
|image=File | |image=File | ||
|displayposition=String | |displayposition=String | ||
}}<!-- | }}<!-- ==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. | ||
<pre> | |||
{{FFXIMap Markers | |||
|mapid= | |||
|mapx= | |||
|mapy= | |||
|entitytype= | |||
|image= | |||
|displayposition= | |||
}} | |||
</pre> | |||
{| class="wikitable" | |||
|+ | |||
!parameter | |||
!default | |||
!type | |||
!description | |||
|- | |||
|'''mapid''' ''[required]'' | |||
|''none'' | |||
|''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''' ''[required]'' | |||
|''none'' | |||
|''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''' ''[required]'' | |||
|''none'' | |||
|''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''' ''[required]'' | |||
|''none'' | |||
|''number'' | |||
|There are "types" of markers (ie: NPC, Seasonal NPC, ???, Standard Merchant, 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''' ''[optional]'' | |||
|''none'' | |||
|''text'' | |||
|This is the filename of the image. Do not use wikitext in this field. | |||
|- | |||
|'''displayposition''' ''[optional]'' | |||
|''none'' | |||
|''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. | ||
</noinclude><!-- | <pre> | ||
--><includeonly>{{#cargo_store:_table= | {{FFXIMap Markers | ||
|mapid=141 | |||
|mapx=25.9 | |||
|mapy=157.72 | |||
|entitytype=NPC | |||
|image=Guslam.png | |||
|displayposition=(179,-216.8) | |||
}} | |||
</pre></noinclude><!-- | |||
--><includeonly>{{#cargo_store:_table=ffximapmarkers | |||
|mapid={{{mapid|}}} | |mapid={{{mapid|}}} | ||
|mapx={{{mapx|}}} | |mapx={{{mapx|}}} | ||
| Line 20: | Line 77: | ||
|image={{{image|}}} | |image={{{image|}}} | ||
|displayposition={{{displayposition|}}} | |displayposition={{{displayposition|}}} | ||
}} | }}</includeonly> | ||
Revision as of 05:06, 16 November 2023
This template defines the table "ffximapmarkers". View table.
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 [required] | none | 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 [required] | none | 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 [required] | none | 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 [required] | none | number | There are "types" of markers (ie: NPC, Seasonal NPC, ???, Standard Merchant, 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 [optional] | none | text | This is the filename of the image. Do not use wikitext in this field. |
| displayposition [optional] | none | 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)
}}
