imported>Axilmeus at 18:47, 24 July 2012

2012-07-24T18:47:41Z

New page

{{documentation}}

The '''POH room''' template displays a basic [[player-owned house]] room.

===Usage===
<pre>
{{POH room
|room = name of room (see examples below)
|doors = list of cardinal directions (e.g. "nesw")
|color = background color
|text = alternative text for center of room
|habitat = if the room is Menagerie (see examples below)
}}
</pre>

Note that you can use ".POH" css style to change the colour of the text inside the room, provided that you have used the "text" tag in the Template script.

===Examples===
Text in the middle is the value of the doors parameter that was used to generate the room. Letters can be in any order.

{| cellspacing="0" cellpadding="6" border="0"
|-
| {{POH room|doors=x|text=x}}
| {{POH room|doors=s|text=s}}
| {{POH room|doors=nw|text=nw}}
| {{POH room|doors=we|text=we}}
| {{POH room|doors=new|text=new}}
| {{POH room|doors=news|text=news}}
|}

==Creating a floorplan==
Making a floorplan for a house is time well spent. Repeatedly adding and removing rooms can cost a significant amount of money, magnified by the cost of any furniture in the rooms. The [[Template:POH room|POH room]] template helps players in making their floorplan in a few simple steps. A floorplan requires a grid to place rooms onto. A simple way to implement this is by using a wiki table:
<pre>
{| cellspacing="0" cellpadding="0" border="0"
| cell top left
| cell top right
|-
| cell bottom left
| cell bottom right
|}
</pre>

The example above creates an empty table without any spacing between the two rows and the two columns.
Adding more columns involves adding extra lines starting with a "|". Adding a line starting with "|-" creates another row. This mechanism can be used to create a grid that is suitable to hold a floorplan.
For a floorplan, each of the cells typically will hold a room or stays empty. A simple example:
<pre>
{| cellspacing="0" cellpadding="0" border="0"
| {{POH room|room=Garden}}
| {{POH room|room=Kitchen}}
|-
| {{POH room|room=Parlour}}
|
|}
</pre>

The example produces the following table:

{| cellspacing="0" cellpadding="0" border="0"
| {{POH room|room=Garden}}
| {{POH room|room=Kitchen}}
|-
| {{POH room|room=Parlour}}
|
|}

The diagram shows that the rooms do not interconnect nicely. The doors parameter can be used to add or remove doors as needed, by providing the cardinal directions the doors should face. A possible fix to the table is shown in the following wiki table code:
<pre>
{| cellspacing="0" cellpadding="0" border="0"
| {{POH room|room=Garden}}
| {{POH room|room=Kitchen|doors=ws}}
|-
| {{POH room|room=Parlour|doors=nwe}}
|
|}
</pre>

This produces the following result:
{| cellspacing="0" cellpadding="0" border="0"
| {{POH room|room=Garden}}
| {{POH room|room=Kitchen|doors=ws}}
|-
| {{POH room|room=Parlour|doors=nwe}}
|
|}

You can also use the doors parameter to remove certain doors, such as in cases where rooms on the second floor have unused openings that do not appear in-game.

The recommended step-by-step approach is:
# Create table and include the room types at the appropriate grid point. Do '''not''' use a ''doors'' parameter. Use the preview button during editing to see the result.
# The rooms will not interconnect as intended. Add the doors parameter to achieve the appropriate interconnects between rooms. Again use preview to evaluate the results. It may take several tries to get all the connections right.
# Check [[:Category:Player-owned house plans]] for examples of house floorplans on other wiki user pages.

===Known rooms===
A complete list of rooms known by the template, and their default door positions, are:
{|- cellpadding="6"
| {{POH room | room=Garden }}
| {{POH room | room=Parlour }}
| {{POH room | room=Kitchen }}
| {{POH room | room=Dining Room }}
| {{POH room | room=Workshop }}
|-
| {{POH room | room=Bedroom }}
| {{POH room | room=Skill Hall }}
| {{POH room | room=Games Room }}
| {{POH room | room=Combat Room }}
| {{POH room | room=Quest Hall }}
|-
| {{POH room | room=Menagerie }}
| {{POH room | room=Study }}
| {{POH room | room=Costume Room }}
| {{POH room | room=Chapel }}
| {{POH room | room=Portal Chamber }}
|-
| {{POH room | room=Formal Garden }}
| {{POH room | room=Throne Room }}
| {{POH room | room=Oubliette }}
| {{POH room | room=Dungeon }}
| {{POH room | room=Dungeon Corridor }}
|-
| {{POH room | room=Dungeon Junction }}
| {{POH room | room=Dungeon Stairs }}
| {{POH room | room=Dungeon Pit}}
| {{POH room | room=Treasure Room }}
| {{POH room | doors=x | text=Roof}}
|}

There is also a special room called "'''None'''" that will occupy the space of the room but without being shown as a room. This can be useful when laying out floor plans.

{| cellspacing="0" cellpadding="0" border="0"
| {{POH room|room=Garden}}
| {{POH room|room=Kitchen|doors=ws}}
|-
| {{POH room|room=none}}
| {{POH room|room=Parlour|doors=nwe}}
|}

==[[Menagerie]]==

The Menagerie is special in that the habitat changes its appearance, so if you use this template to show a Menagerie the background may be changed. For example, <tt><nowiki>{{POH room|room=Menagerie}}</nowiki></tt> would only show the default Garden:

{{POH room|room=Menagerie}}

However, <tt><nowiki>{{POH room|room=Menagerie|habitat=Polar}}</nowiki></tt> will show as if it were white, like so:

{{POH room|room=Menagerie|habitat=Polar}}

The list of options for a habitat is found here.

{|- cellpadding="6"
| {{POH room|room=Menagerie|text=(None)/Garden}}
| {{POH room|room=Menagerie|habitat=Jungle|text=Jungle}}
| {{POH room|room=Menagerie|habitat=Desert|text=Desert}}
| {{POH room|room=Menagerie|habitat=Volcanic|text=Volcanic}}
| {{POH room|room=Menagerie|habitat=Polar|text=Polar}}
|}


<div style="display: none;">
[[File:House vwall.png]]
[[File:House vdoor.png]]
[[File:House hwall.png]]
[[File:House hdoor.png]]
[[File:House h2wall.png]]
[[File:House h2door.png]]
[[File:House filler.png]]
</div>

==See also==
* [[Construction]]
* [[Player-owned house]]
* [[:Category:Player-owned house plans|Other player-owned house plans]]

<noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>

Template:POH room/doc - Revision history

imported>Axilmeus at 18:47, 24 July 2012