View source for Template:RoleParser/doc

{{Template
|Name=RoleParser
|Type=Formatting
|Type2=Utility
|Sub=No
|Designer=callforjudgement}}
<includeonly>----</includeonly>

The {{tl|RoleParser}} template is the main entry point for producing formatted [[Role PM]]s from [[MafiaWiki:RoleParser syntax|role strings]].

The first argument is the role string to format. The second argument is a slash-separated list of special rules in use in the setup, e.g. "Nightless", "Compulsive" (nightkills), etc.; this can be empty. (The purpose of this argument is to make necessary modifications to the role PM, e.g. removing the factional kill from the Mafia in a Nightless setup.)

There are also a few optional arguments. An argument with a name like <code>TownWincon</code>, <code>MafiaWincon</code>, etc., will override the [[win condition]] given in the role PM ''if'' the faction in the argument matches the faction of a role. This lets you specify the wincons for the various factions without having to parse the role string to see which faction matches. Finally, the <code>Test</code> argument is optional and rarely used, but will cause this template to dump out some of its internal state, making it possible to test it independently from the sub-templates it calls into.

== Examples ==

{{RoleStringTest|RoleParser|Test=Rp/Stage1}}

== Test of this template in isolation ==

This test shows the arguments passed by {{tl|RoleParser}} to {{tl|Rp/Stage1}}, the template that does most of the actual work.

{{RoleStringTest|RoleParser|Test=ShowArgs}}