Template:Location Tooltip: Difference between revisions
From HorizonXI Wiki
(added documentation and an example) |
(added option to add an overlay using the map overlay template, if that level of customization is required) |
||
| Line 161: | Line 161: | ||
close all if pos | close all if pos | ||
-->}}}}}}}}}}}} | -->}}}}}}}}}}}}<!-- | ||
| text = [[{{#if:{{{link|}}}|{{{link}}}|{{#if:{{{map|}}}|{{{area}}}/Maps#{{{map}}}|{{{area}}}/Maps}}}}|{{default|{{{text|}}}|{{default|{{{pos|}}}<!-- | |||
-->{{#if:{{{custom overlay|}}}|{{{custom overlay}}}<!-- | |||
-->{{#if:{{{custom overlay 2|}}}|{{{custom overlay 2}}}<!-- | |||
-->{{#if:{{{custom overlay 3|}}}|{{{custom overlay 3}}}<!-- | |||
-->{{#if:{{{custom overlay 4|}}}|{{{custom overlay 4}}}<!-- | |||
-->{{#if:{{{custom overlay 5|}}}|{{{custom overlay 5}}}<!-- | |||
-->{{#if:{{{custom overlay 6|}}}|{{{custom overlay 6}}}<!-- | |||
close all if custom overlay | |||
-->}}}}}}}}}}}}<!-- | |||
-->| text = [[{{#if:{{{link|}}}|{{{link}}}|{{#if:{{{map|}}}|{{{area}}}/Maps#{{{map}}}|{{{area}}}/Maps}}}}|{{default|{{{text|}}}|{{default|{{{pos|}}}<!-- | |||
-->{{#if:{{{pos 2|}}}|<nowiki> </nowiki>/ {{{pos 2}}}<!-- | -->{{#if:{{{pos 2|}}}|<nowiki> </nowiki>/ {{{pos 2}}}<!-- | ||
-->{{#if:{{{pos 3|}}}|<nowiki> </nowiki>/ {{{pos 3}}}<!-- | -->{{#if:{{{pos 3|}}}|<nowiki> </nowiki>/ {{{pos 3}}}<!-- | ||
| Line 200: | Line 211: | ||
| marker size {2...6} = | | marker size {2...6} = | ||
| marker border radius {2...6} = | | marker border radius {2...6} = | ||
| custom overlay {2...6} = | |||
}} | }} | ||
</pre> | </pre> | ||
| Line 226: | Line 238: | ||
*'''marker size''': The size of the marker. | *'''marker size''': The size of the marker. | ||
*'''marker border radius''': The 'roundness' of the marker. | *'''marker border radius''': The 'roundness' of the marker. | ||
*'''custom overlay''': Allows to define an overlay using <nowiki>{{Map Overlay}}</nowiki>. | |||
**Optional: '''custom overlay 2''', ..., '''custom overlay 6'''. | |||
===Examples=== | ===Examples=== | ||
| Line 419: | Line 433: | ||
| text = Drop "L" | | text = Drop "L" | ||
}} | }} | ||
|- | |||
| | |||
<pre> | |||
{{Location Tooltip | |||
| area = Valkurm Dunes | |||
| custom overlay = {{Map Overlay | |||
| pos = E-8 | |||
| offset x = 2 | |||
| offset y = -10 | |||
| style = background:#5555ff; opacity: 0.4; width: 50px; height:40px; border-radius:40px; | |||
}} | |||
| text = Valkurm Emperor | |||
}} | |||
</pre> | |||
| | |||
{{Location Tooltip | |||
| area = Valkurm Dunes | |||
| custom overlay = {{Map Overlay | |||
| pos = E-8 | |||
| offset x = 0 + 16 | |||
| offset y = 0 + 16 | |||
| style = background:#5555ff; opacity: 0.4; width: 64px; height:32px; | |||
}} | |||
| text = Valkurm Emperor Spawn Area}} | |||
|} | |} | ||
Revision as of 19:23, 27 June 2025
Usage
Note: {2...6} means that additional parameters exist with numbers 2 to 6. E.g. pos {2...6} means that pos, pos 2, pos 3, pos 4, pos 5, pos 6 all can be used
{{Location Tooltip
| area =
| pos {2...6} =
| map =
| id =
| text =
| link =
| tooltip =
| opacity =
| highlight offset {2...6} x =
| highlight offset {2...6} y =
| highlight background {2...6} =
| highlight opacity {2...6} =
| highlight width {2...6} =
| highlight height {2...6} =
| marker pos {2...6} x =
| marker pos {2...6} y =
| marker background {2...6} =
| marker opacity {2...6} =
| marker size {2...6} =
| marker border radius {2...6} =
| custom overlay {2...6} =
}}
Displays a tooltip map of the area.
- area: The map's area. Required.
- pos: The position within the map, such as H-6 or B-5.
- Optional: pos 2, pos 3, pos 4, pos 5, pos 6 with their respective stylings
- map: The specific map to be used, such as "Map 2".
- id: A unique id to give to the tooltip. Use if the same location is repeated on the same page.
- text: The text to display. Defaults to the pos if it is provided or the area and map if the pos is not provided.
- link: Option to change the clickable link of the text.
- tooltip: The tooltip to display. Defaults to the labeled section in of the area maps subpage.
- opacity: The opacity of the tooltip.
- highlight offset x: An offset to correct the x positioning of the highlight box.
- highlight offset y: An offset to correct the y positioning of the highlight box.
- highlight width: Width of the highlight box
- highlight height: Heigh of the highlight box
- highlight background: The background styling of the highlight box.
- highlight opacity : The opacity of the highlight box.
- marker pos x: The x position of the marker within the highlight box.
- Optional: marker pos 2 x, marker pos 3 x, marker pos 4 x, marker pos 5 x, marker pos 6 x with their respective stylings
- marker pos y: The y position of the marker within the highlight box.
- Optional: marker pos 2 y, marker pos 3 y, marker pos 4 y, marker pos 5 y, marker pos 6 y with their respective stylings
- marker background: The background styling of the marker.
- marker opacity: The opacity of the marker.
- marker size: The size of the marker.
- marker border radius: The 'roundness' of the marker.
- custom overlay: Allows to define an overlay using {{Map Overlay}}.
- Optional: custom overlay 2, ..., custom overlay 6.
Examples
| Code | Result |
|---|---|
{{Location Tooltip
| area = Windurst Walls
}}
|
|
{{Location Tooltip
| area = Windurst Waters
| map = South
}}
|
|
{{Location Tooltip
| area = Northern San d'Oria
| pos = L-10
}}
|
|
{{Location Tooltip
| tooltip = [[File:RuAunGardensMain.png]]
| area = Ru'Aun Gardens
| pos = H-10
}}
|
|
{{Location Tooltip
| tooltip = [[File:GarlaigeCitadel2.png]]
| area = Garlaige Citadel
| map = Map 2
| pos = G-6
}}
|
|
{{Location Tooltip
| tooltip = [[File:SouthernSandOria.png]]
| area = Southern San d'Oria
| pos = J-9
| marker pos x = 3
| marker pos y = 7
}}
|
|
{{Location Tooltip
| id = Derfland Regional Merchant
| tooltip = [[File:SouthernSandOria.png]]
| area = Southern San d'Oria
| pos = J-9
| highlight background = transparent
| marker pos x = 3
| marker pos y = 7
}}
|
|
{{Location Tooltip
| text = Valkurm Emperor
| tooltip = [[File:Valkurm Dunes.png]]
| area = Valkurm Dunes
| pos = E-8
| highlight background = transparent
| marker pos x = 2
| marker pos y = -7
| marker size = 35
| marker opacity = 0.4
| marker background = #5555ff
}}
|
|
{{Location Tooltip
| area = Northern San d'Oria
| pos = L-10
| pos 2 = L-11
| pos 3 = M-10
| pos 4 = M-11
}}
|
|
{{Location Tooltip
| area = Pso'Xja
| map = Map 2
| pos = J-7
| highlight background = transparent
| marker pos x = 2
| marker pos y = 16
| marker size = 14
| marker opacity = 0.4
| marker border radius = 0
| text = Drop "L"
}}
|
|
{{Location Tooltip
| area = Valkurm Dunes
| custom overlay = {{Map Overlay
| pos = E-8
| offset x = 2
| offset y = -10
| style = background:#5555ff; opacity: 0.4; width: 50px; height:40px; border-radius:40px;
}}
| text = Valkurm Emperor
}}
|
