Template:HadezFamilyData

From BattleMaster Wiki
Revision as of 08:15, 7 February 2021 by Vita` (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
Template-info.svg Template Documentation
This documentation is transcluded from Template:HadezFamilyData/doc.

ExamplesSandbox

Summary

This template displays family details (fame and wealth), updated in real-time, taken from the game.

There are currently three display formats..

  • box - traditional infobox that sits at the right of the page.
  • plain - basic list of the family's details suitable for putting in a box or at the foot of the page.
  • prose - describes the family's details in a sentence; suitable for use as a family page introduction.

Nice features include..

  • Easy to use.
  • All details updated in real-time from game data.
  • Box, Plain and Prose formats.
  • display custom family name prefixes and suffixes (eg. House Smith, Smith Dynasty).

Author: Wraith0x29a

Examples and Usage

See the examples page.

Parameters

  • family_name or family_id - (required) - The first name or the ID of the character.
  • format - (required) - The format to display the output in (current options are 'prose', 'plain' or 'box').
  • family_prefix - (optional) - Word(s) to be added before family name when shown (eg. House Smith). Default is nothing.
  • family_suffix - (optional) - Word(s) to be added after family name when shown (eg. Smith Dynasty). Default is 'Family'.
  • background - (optional) - The HTML color code to use for the box format background.
  • header - (optional) - The HTML color code to use for the box format header background.
  • list - (optional) - The HTML color code to use for the box format list background (left hand column).
  • value - (optional) - The HTML color code to use for the box format values background (right hand column).

If invalid family_name or family_id are entered (user error or family has been removed from game) nothing is shown at all.

To remove the default family_suffix of 'Family' set family_suffix to nothing, eg.
{{ HadezFamilyData | family_name=Smith | family_prefix=House | family_suffix= | format=plain }}

HTML hexadecimal based color codes (eg. #AA0000 for mid red) should include the # prefix.
The default color-scheme of tasteful greys is used if the color parameters are omitted for the box format.

Known Issues

The background parameter does nothing at the moment.

There may be an issue with some HTML colours set by parameters not displaying properly.