Options

Wiki Pages: Home | Setup | Options | Change

Sections: Guild Info | Appearance | Callbacks | Debugging

Guild Info

region

• This must be set to the battle.net domain.
• China's battle.net does not have a domain, but you can set this value to "cn" and the plugin will use the correct API domain.
• Values include: "us", "eu", "kr", "tw" or "sea"; use "cn" for China.
• Default value is "us".

locale

• This sets the language to use.
• Values include : "en_US", "es_MX", "pt_BR", "en_GB", "es_ES", "fr_FR", "ru_RU", "de_DE", "pt_PT", "it_IT", "ko_KR", "zh_TW" or "zh_CN".
• Default value is "en_US" (English U.S.).

server

• Set the server name to use here.
• Only one server is usable per progression block.
• Include any spaces and apostrophes in the server name and make sure it is within double quotes.
• Default is "Lightning's Blade" to show that double quotes should be surrounding the name with an apostrophe.

guild

• Set your guild's name here.
• Include spaces and apostrophes in the name and make sure it is within double quotes.
• Default is "Our Guild's Name" to show that double quotes should be surrounding the name with an apostrophe.

raiders

• List your raiders here; Yes, you only need to add one.

• Include raiders under 'all' to have them included in all expansions.

• Include raiders under 'mists' or 'cat' to have them counted only for specific expansions.

• So in this example:

  // list raiders here under "all" or the expansion abbreviation
  raiders : {
    'all'   : [ 'raider1', 'raider2' ], // included in all expansions
    'mists' : [ 'raider3', 'raider4' ],
    'cat'   : [ 'raider3alt' ]
  },

  the mists expansion will count raider1, raider2, raider3 and raider4; and the 'cat' expansion will count raider1, raider2 and raider3alt

• Default value is empty curly brackets {}, so nothing will show unless names are added!

Appearance

show

• Set the expansions to show within the progression box.
• Values must be within an array and include "mists" and/or "cat".
• The order of the expansions can be changed. The first expansion listed will be on top.
• Default value is [ 'mists' ].

heroics

• Set this boolean value to true to include heroic progression, or set it to false to not include heroic progression.
• Do not wrap this value in quotes.
• Default value is true.

ratio

• This is a threshold ratio that must be suppassed before a boss will be counted as killed.

• To better explain this, say the plugin has the ratio set to 0.75 and sees this data (x = boss killed):

  raider  Boss1 Boss2 Boss3
  lisa      x     x     x
  fred      x     x     -
  mike      x     x     -
  joe       x     -     -
  
  ratio    4/4   3/4   1/4  (fraction)
            1    0.75  0.25 (decimal)

  • So all raiders have killed boss1 making the kill ratio one (or 100%). This is above the 0.75 (75%) set ratio, so boss1 will show as being killed.
  • Boss2 has 3/4 (0.75 or 75%) of the raiders killing the boss, so because this is equal to the set kill ratio, it will also show the boss as being killed.
  • Boss3 only had 1/4 (0.25 or 25%) of the raiders killing the boss. This is not above the set kill ratio, so this boss will not show as being killed.

• Default value is 0.75.

count

• Set the format of the instance boss kill count using this option.
• This count shows up on the right side of the instance progression bar.
• The value of this option has a string that can include:
  • {n} - the number of kills in that instance.
  • {t} - the total number of bosses in that instance.
  • {p} - the percentage of kills in that instance.
• The default value is "{n}/{t}" which shows the fraction of boss kills in the instance (e.g. 3/4).
• Alternatively you can include the percentage of kills using "{n}/{t} ({p})" (e.g. 3/4 (75%)).

status

• Set the format of the instnace boss kill status using this option.
• This status shows up within the tooltip that pops up when hovering over a progression bar.
• The value of this option has a string that can include:
  • {s} - the none/killed status text - see the text option below.
  • {n} - the number of boss kills averaged from all raiders in that expansion. So this number may be really off if one raider doesn't have any boss kills.
• Default value is "{s}".

useAbbr

• Set this boolean value to true to use the instance name abbreviation.
• I know that in different locales the instance name changes and therefore the abbreviation will change. If this change is needed, I'll include instructions on how to set this up.
• Default value is false.

text

• Set the desired text to show for the boss status, within the tooltip.

• The option is set up as follows:

  // boss status text
  text    : {
    zero    : '',  // boss kill count (if zero) - when using {n} in status
    none    : '',  // boss not killed text
    killed  : 'Killed' // boss killed text
  },

  • zero is the text shown when the {n} status is shown, but the boss count is zero.
  • none is the text shown when the {t} status is shown, but the boss hasn't been killed.
  • killed is the text shown when the boss has been killed.
  • Any of these status text can also include HTML. So if you want an image to show a boss kill, use this instead: killed : '<img src="demo/killed.png">'.
  • Sorry, there isn't any way for a status to show that a boss has been attempted.

• Default values are shown above.

tooltip

• This class name is added to the progress bars and can be used by the tooltip script.
• The tooltip plugin should target the title attribute of the progress bar for information to display.
• Default value is "tooltip".

Callbacks

initialized

• This callback function can be used to perform any necessary operations after the progression box has completed setting up.

• In this example, the callback is setting up the tooltip plugin.

  // ** Callbacks **
  // initialized callback function (progression box has completed it's set up)
  // el = $('#progBox') - element that the plugin is initialized on
  initialized: function(el){
    // initialize tooltip plugin
    mytooltip();
  }

• The el parameter of the function contains the element that the plugin was initialized on.

• The default value is null.

Debugging

details

• If true, it adds raider boss kills to the bottom of the tooltip (see the screenshots).
• This enables the admin to check if the script is working properly or if a raider needs to be excluded from the list.
• These details will always be present within the tooltip, and only hidden when this option is false.
• The style can be modified using css.
• These details were only meant for debugging, so it's not perfect; e.g. the Bastion of Twilight normal mode details will show 5 bosses, instead of the correct 4.

clickForDetails

• When true clicking on a progress bar will reveal or hide (toggle) the details within the tooltip.
• Set this to false to never enable progress bar clicking.

debug

• More details will be output to the console when the debug option is true.
• For specific details from each raider, click on the progress bar to reveal details; added when the details option is set to true.