Template:Area/doc

This subpage provides documentation for Template:Area.

This template uses the following modules:

• Module: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	Field	Description
main_page	str	✗	✗	areas.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	✗	✓	areas.id	Internal game id of the area (don't make this up).
name	str	✗	✓	areas.name	Name of the area as visible in game
act	int	✗	✓	areas.act	Act associated with the area
area_level	int	✗	✓	areas.area_level	level of the area
level_restriction_max	int	✗	✓	areas.level_restriction_max	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]	✗	✓	areas.area_type_tags	comma-separated list of tags associated with an area denoting the type of the area.
tags	list[str]	✗	✓	areas.tags	comma-separated list of tags associated with an area
loading_screen	str	✗	✓	areas.loading_screen	Name of the loading screen file; file path will be automatically generated from this.
connection_ids	list[str]	✗	✓	areas.connection_ids	comma-separated list of area ids this area is connected to
parent_area_id	str	✗	✓	areas.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]	✗	✓	areas.modifier_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]	✗	✓	areas.monster_ids	comma-separated list of monsters metadata ids
boss_monster_ids	list[str]	✗	✓	areas.boss_monster_ids	comma-separated list of boss monsters metadata ids
entry_text	str	✗	✓	areas.entry_text	Message that is shown when the area is entered
entry_npc	str	✗	✓	areas.entry_npc	NPC who sends the message shown upon entering the area
vaal_area_ids	list[str]	✗	✓	areas.vaal_area_ids	comma-separated list of vaal area ids
vaal_area_spawn_chance	int	✗	✓	areas.vaal_area_spawn_chance	Percent chance for an vaal side area to appear
strongbox_spawn_chance	int	✗	✓	areas.strongbox_spawn_chance	Percent chance for a strongbox to appear
strongbox_max_count	int	✗	✓	areas.strongbox_max_count	Maximum number of strongboxes that naturally can appear in this area
strongbox_max_count	list[4x int]	✗	✓	areas.strongbox_max_count	comma-separated list of weights denoting which rarity a strongbox may be spawned in List is normal, magic, rare, unique in that order
is_map_area	bool	✗	✓	areas.is_map_area	Whether the area is a map area
is_unique_map_area	bool	✗	✓	areas.is_unique_map_area	Whether the area is a unique map area
is_town_area	bool	✗	✓	areas.is_town_area	Whether the area is a town
is_hideout_area	bool	✗	✓	areas.is_hideout_area	Whether the area is a hideout
is_vaal_area	bool	✗	✓	areas.is_vaal_area	Whether the area is a vaal side area
is_master_daily_area	bool	✗	✓	areas.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	✗	✓	areas.is_labyrinth_area	Whether the area is a labyrinth area
is_labyrinth_airlock_area	bool	✗	✓	areas.is_labyrinth_airlock_area	Whether the area is a labyrinth airlock area
is_labyrinth_boss_area	bool	✗	✓	areas.is_labyrinth_boss_area	Whether the area is a labyrinth boss area
has_waypoint	bool	✗	✓	areas.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                =
}}