Module:Counters/doc

From SWGoH Wiki
Jump to navigationJump to search

This is the documentation page for Module:Counters


DOCUMENTATION

This module has the following functions:

  • images


Modules are called by using
{{#invoke: MODULE_NAME | MODULE_FUNCTION | parameters}}

Images Function

The images function display a row of unit images and is primarily built to be used with Team pages to display the full team and substitutes.

Parameters

This function takes 5 parameters in a specific order and has 5 named parameters. Named parameters can be in any order.

{{#invoke:Counters|images| LEADER_NAME | ALLY_1_NAME | ALLY_2_NAME | ALLY_3_NAME | ALLY_4_NAME |subs= |locks= |size= |txt= |type= |squadType=}}
  • 1st Parameter = The full in-game name of the Leader of the team, or first unit image to display
  • 2nd Parameter = OPTIONAL: The full in-game name of the ally on the team, or second unit image to display
  • 3rd Parameter = OPTIONAL: The full in-game name of the ally on the team, or third unit image to display
  • 4th Parameter = OPTIONAL: The full in-game name of the ally on the team, or fourth unit image to display
  • 5th Parameter = OPTIONAL: The full in-game name of the ally on the team, or fifth unit image to display
  • subs = OPTIONAL: The full name of each substitute separated by a comma with no spaces.
  • size = This will adjust the size of the image. Options: med, lg
  • locks = OPTIONAL: Adds a lock image on the units and makes them the same size as the leader image. Options: 1-5. Corresponds to image in parameter position.
  • txt = OPTIONAL: This is used to add the units name under the image. Options: y or omit
  • type = OPTIONAL: This is used to adjust the css for the box element and to hide the popup for the images. Specifically added for Team Counter Lists page so it corrects the placement of the team detail popup. Option: for or omit
  • squadType = OPTIONAL: The type of units on the team. Options: Ship, Character. If omitted Character will be chosen by default.


Example

{{#invoke:Counters|images|Mother Talzin|Old Daka|Nightsister Zombie|Nightsister Spirit|Nightsister Acolyte|subs=Asajj Ventress|locks=1,2,3|size=med|txt=|type=|}}
Game-Icon-Lock.png
Unit-Character-Mother Talzin-portrait.png
Mother Talzin
Game-Icon-Lock.png
Unit-Character-Old Daka-portrait.png
Old Daka
Game-Icon-Lock.png
Unit-Character-Nightsister Zombie-portrait.png
Nightsister Zombie
Unit-Character-Nightsister Spirit-portrait.png
Nightsister Spirit
Unit-Character-Nightsister Acolyte-portrait.png
Nightsister Acolyte
Unit-Character-Asajj Ventress-portrait.png
Asajj Ventress