Template:Contact Overview/doc: Difference between revisions
Jump to navigation
Jump to search
imported>Blondeshell (historical) mNo edit summary |
mNo edit summary |
||
| (6 intermediate revisions by the same user not shown) | |||
| Line 19: | Line 19: | ||
:* vig: vigilante | :* vig: vigilante | ||
:* r: rogue | :* r: rogue | ||
:* hp ''or'' ph: hero and Praetorian resistance | |||
:* vp ''or'' pv = villain and Praetorian loyalist | |||
; Hood | ; Hood | ||
| Line 39: | Line 41: | ||
; OriginYN | ; OriginYN | ||
: Specifies the type of contact. (The parameter is named as thus for historical reasons.) Legal values: | : Specifies the type of contact. (The parameter is named as thus for historical reasons.) Legal values: | ||
:* broker: Broker | |||
:* b: Broker | |||
:* n: Contact will be categorized as an "Unspecified Origin Contact" | :* n: Contact will be categorized as an "Unspecified Origin Contact" | ||
:* none: Contact will be categorized as an "Unspecified Origin Contact" | :* none: Contact will be categorized as an "Unspecified Origin Contact" | ||
:* origin: Origin-specific, makes use of the '''Origin''' parameter | :* origin: Origin-specific, makes use of the '''Origin''' parameter | ||
:* event: Event | |||
:* e: Event | |||
:* police band: Police Band | :* police band: Police Band | ||
:* policeband: Police Band | :* policeband: Police Band | ||
| Line 56: | Line 62: | ||
:* y: Origin-specific, makes use of the '''Origin''' parameter | :* y: Origin-specific, makes use of the '''Origin''' parameter | ||
: If not supplied, the default is to use "none". | : If not supplied, the default is to use "none". | ||
;Unlock | |||
: Specifies if unlocking this contact is required for their services. Defaults to no. Legal values: | |||
:* yes: requires unlocking | |||
:* y: requires unlocking | |||
:* no: blank | |||
:* n: blank | |||
; Pronoun | ; Pronoun | ||
| Line 111: | Line 124: | ||
|OriginYN= | |OriginYN= | ||
|Origin= | |Origin= | ||
|Unlock= | |||
|Level= | |Level= | ||
|Pronoun= | |Pronoun= | ||
Latest revision as of 12:25, 14 February 2021
Usage
This template is used to generate the Overview text for a contact. Using it will also supply all relevant categories.
Parameters
- aka
- Provides a common alias for the Contact. (For example, Tyrant might use aka=Emperor Marcus Cole.)
- City
- Indicates which "alignment" the contact is for. Legal values:
- h: hero
- v: villain
- hv or vh: hero and villain
- p: Praetorian
- hvp or vhp: hero, villain, and Praetorian
- vig: vigilante
- r: rogue
- hp or ph: hero and Praetorian resistance
- vp or pv = villain and Praetorian loyalist
- Hood
- Specifies which neighborhood the contact is in within their zone. Example: High Park.
- Hood2
- Specifies which neighborhood the contact is in within their second zone. Example: High Park.
- Level
- Specifies the level range of the contact. If this is provided, then Pronoun must also be provided. Example: 5-9.
- Origin
- Specifies the origin of the contact. This is only used when OriginYN is either "y" or "origin". Legal values:
- Magic
- Mutation
- Natural
- Science
- Technology
- OriginYN
- Specifies the type of contact. (The parameter is named as thus for historical reasons.) Legal values:
- broker: Broker
- b: Broker
- n: Contact will be categorized as an "Unspecified Origin Contact"
- none: Contact will be categorized as an "Unspecified Origin Contact"
- origin: Origin-specific, makes use of the Origin parameter
- event: Event
- e: Event
- police band: Police Band
- policeband: Police Band
- pb: Police Band
- r: Respecification
- respec: Respecification
- s: Store
- store: Store
- t: Tailor
- tailor: Tailor
- task force: Task Force
- taskforce: Task Force
- tf: Task Force
- y: Origin-specific, makes use of the Origin parameter
- If not supplied, the default is to use "none".
- Unlock
- Specifies if unlocking this contact is required for their services. Defaults to no. Legal values:
- yes: requires unlocking
- y: requires unlocking
- no: blank
- n: blank
- Pronoun
- Specifies the possessive pronoun to use when referring to the contact. This will usually be "his" or "her". It is only used in conjunction with Level.
- x
- Specifies the x coordinate of the contact within the zone. In order to display, all of x, y, and z must be provided.
- x2
- Specifies the x coordinate of the contact within the second zone. In order to display, all of x, y, and z must be provided.
- y
- Specifies the y coordinate of the contact within the zone. In order to display, all of x, y, and z must be provided.
- y2
- Specifies the y coordinate of the contact within the second zone. In order to display, all of x, y, and z must be provided.
- z
- Specifies the z coordinate of the contact within the zone. In order to display, all of x, y, and z must be provided.
- z2
- Specifies the z coordinate of the contact within the second zone. In order to display, all of x, y, and z must be provided.
- Zone
- Specifies which zone the contact is in. Examples: Kings Row, Mercy Island.
- Zone2
- Specifies the second zone the contact is in. Examples: Kings Row, Mercy Island.
Deprecated Parameters
This template has undergone extensive changes during its lifetime. As such, many pages still use parameters that are no longer in use. This section documents those parameters, just so there's less confusion. These parameters should not be used in the future, as they do not do anything.
- HoodYN
- Deprecated. This used to specify whether or not the neighborhood should be displayed. This is now determined based on the presence of the Hood parameter.
- LevelYN
- Deprecated. This used to specify whether or not level information should be displayed. This is now determined based on the presence of the Level parameter.
- Name
- Deprecated. This used to be used to specify the contact's name. It is now obtained via {{PAGENAME}}.
Template
The following can be copied and pasted into new contact articles to more easily make use of this template.
{{Contact Overview
|aka=
|City=
|Zone=
|x=
|y=
|z=
|Hood=
|OriginYN=
|Origin=
|Unlock=
|Level=
|Pronoun=
}}
See also