Template:Area/doc: Difference between revisions
>Illviljan mNo edit summary |
>Illviljan mNo edit summary |
||
Line 249: | Line 249: | ||
| Whether the area has a waypoint | | Whether the area has a waypoint | ||
|} | |} | ||
==Finding the area id== | |||
<section begin=area_id/>Browse to it using [[Special:CargoTables]] or use a query similar to this: | |||
<pre> | |||
{{#cargo_query: | |||
tables = areas | |||
|fields = areas._pageName, areas.id, areas.name, areas.main_page | |||
|where = id LIKE "%" | |||
|limit=5000 | |||
}} | |||
</pre><section end=area_id /> | |||
==Legacy area call== | ==Legacy area call== | ||
===Parameters=== | ===Parameters=== | ||
All parameters except for '''name''' are optional. They can be excluded or left blank. | All parameters except for '''name''' are optional. They can be excluded or left blank. |
Revision as of 10:56, 17 March 2018
This subpage provides documentation for Template:Area.
The area template is used to show a area info card. It currently calls Module:Area from within the Area namespace, but provides legacy support for old templates when called from the main name space.
Module area call
Parameters
Parameter | Value | Required | PyPoE Export |
Property | Description |
---|---|---|---|---|---|
main_page | str | ✗
|
✗
|
Has main page | A valid wiki page that serves as the base page for this area entry (i.e. holds version history, descriptions, etc.) |
id | str | ✗
|
✓
|
Is area id | Internal game id of the area (don't make this up). |
name | str | ✗
|
✓
|
Has name | Name of the area as visible in game |
act | int | ✗
|
✓
|
Has act | Act associated with the area |
area_level | int | ✗
|
✓
|
Has area level | level of the area |
level_restriction_max | int | ✗
|
✓
|
Has area level | Maximum player level allowed to enter. Defaults to 100.
This is used in pvp arenas for example to restrict higher level players from entering low level pvp arenas. |
area_type_tags | list[str] | ✗
|
✓
|
Has area type tags | comma-separated list of tags associated with an area denoting the type of the area. |
tags | list[str] | ✗
|
✓
|
Has tags | comma-separated list of tags associated with an area |
loading_screen | str | ✗
|
✓
|
Has loading screen image | Name of the loading screen file; file path will be automatically generated from this. |
connection_ids | list[str] | ✗
|
✓
|
Has area connection ids | comma-separated list of area ids this area is connected to |
parent_area_id | str | ✗
|
✓
|
Has parent area id | Parent area of this area (i.e. the area the player character would respawn in if he dies)) |
modifier_ids | list[str] | ✗
|
✓
|
Has mod ids | comma-separated list of implicit modifiers associated with this area.
Please note only implicit modifiers are counted, do modifiers from maps for example would not be included. |
monster_ids | list[str] | ✗
|
✓
|
Has monster ids | comma-separated list of monsters metadata ids |
boss_monster_ids | list[str] | ✗
|
✓
|
Has boss monster ids | comma-separated list of boss monsters metadata ids |
entry_text | str | ✗
|
✓
|
Has entry text message | Message that is shown when the area is entered |
entry_npc | str | ✗
|
✓
|
Has entry text message | NPC who sends the message shown upon entering the area |
entry_text | str | ✗
|
✓
|
Has entry text message | Message that is shown when the area is entered |
vaal_area_ids | list[str] | ✗
|
✓
|
Has vaal area ids | comma-separated list of vaal area ids |
vaal_area_spawn_chance | int | ✗
|
✓
|
Has vaal area spawn chance | Percent chance for an vaal side area to appear |
strongbox_spawn_chance | int | ✗
|
✓
|
Has strongbox spawn chance | Percent chance for a strongbox to appear |
strongbox_max_count | int | ✗
|
✓
|
Has maximum number of strongboxes | Maximum number of strongboxes that naturally can appear in this area |
strongbox_max_count | list[4x int] | ✗
|
✓
|
Has normal rarity strongbox weight
Has magic rarity strongbox weight |
comma-separated list of weights denoting which rarity a strongbox may be spawned in
List is |
is_map_area | bool | ✗
|
✓
|
Is map area | Whether the area is a map area |
is_unique_map_area | bool | ✗
|
✓
|
Is unique map area | Whether the area is a unique map area |
is_town_area | bool | ✗
|
✓
|
Is town area | Whether the area is a town |
is_hideout_area | bool | ✗
|
✓
|
Is hideout area | Whether the area is a hideout |
is_vaal_area | bool | ✗
|
✓
|
Is vaal area | Whether the area is a vaal side area |
is_master_daily_area | bool | ✗
|
✓
|
Is master daily area | Whether the area is a master daily area. Please note this only applies to the area the master spawns in after he creates a portal, not the quest area created (i.e. doesn't apply to vagan area, tora sink hole, haku cave, etc.) |
is_labyrinth_area | bool | ✗
|
✓
|
Is labyrinth area | Whether the area is a labyrinth area |
is_labyrinth_airlock_area | bool | ✗
|
✓
|
Is labyrinth airlock area | Whether the area is a labyrinth airlock area |
is_labyrinth_boss_area | bool | ✗
|
✓
|
Is labyrinth boss area | Whether the area is a labyrinth boss area |
has_waypoint | bool | ✗
|
✓
|
Has waypoint | Whether the area has a waypoint |
Finding the area id
Browse to it using Special:CargoTables or use a query similar to this:
{{#cargo_query: tables = areas |fields = areas._pageName, areas.id, areas.name, areas.main_page |where = id LIKE "%" |limit=5000 }}
Legacy area call
Parameters
All parameters except for name are optional. They can be excluded or left blank.
Parameter | Description |
---|---|
name | Name of the area |
pagename | Name of the area's wiki page, if different than name |
type | Type of the area – Possible values are: Act , Corrupted , Hideout , Map , Mission , Descent , Descent: Champions , and Removed .
|
act | Act the area belongs to, if type is set to Act
|
icon | Area icon – Predefined icons for values: Normal , Waypoint , and Town .
|
difficulty | The difficulty of the area, if type is set to Descent or Descent: Champions . Possible values are Normal , Cruel , and Merciless .
|
mlvl1 | Monster level for the area; for Normal difficulty if type is set to Act
|
mlvl2 | Monster level for Cruel difficulty if type is set to Act
|
mlvl3 | Monster level for Merciless difficulty if type is set to Act
|
image | Area screenshot – Defaults to name zone screenshot.jpg
|
flavourtext | Flavour text for the area |
tileset | Tileset for the area |
Code templates
Copy and paste a code template to get started.
Act area
{{area | name = | type = Act | act = | icon = normal | mlvl1 = | mlvl2 = | mlvl3 = | flavourtext = | tileset = }}
Other areas
{{area | name = | type = | difficulty = | mlvl1 = | tileset = }}