Difference between revisions of "MQ2TributeManager" - MMOBugs Wiki

 
(→‎Description: Formatting)
 
(14 intermediate revisions by 3 users not shown)
Line 1: Line 1:
[[CategoryIncomplete Plugin Pages]]
+
{{plugin}}
 +
{{Pluginbox
 +
| name = MQ2TributeManager
 +
| author = [[User:Alt228|Alt228]]
 +
| link = [http://www.mmobugs.com/forums/everquest-macroquest2-compiles-plugins-and-offsets/4539-plugin-mq2tributemanager.html Forum Link]
 +
| commands=/tribute
 +
| source = Yes
 +
| usesini = Yes
 +
}}
 +
 
 +
 
 +
 
 +
 
 +
==Description==
 +
<font class="highlight">MQ2TributeManager</font> Adds a /tribute command in game with automatic tribute status management capabilities.
 +
 
 +
----
 +
The TLO name is Tribute, here are the members, in case anyone wants to add to hud, macro, etc.:
 +
 
 +
 
 +
* <span class="highlight2">Mode:</span> {string} Returns the current mode as Manual, Auto, OffWhenExpired.
 +
 
 +
* <span class="highlight2">CombatState:</span> {string} Returns the combat state as Combat, Debuffed, Cooldown, Active, Resting
 +
 
 +
* <span class="highlight2">nCombatState:</span> {int} Returns the combat state as 0=Combat, 1=Debuffed, 2=Cooldown, 3=Active, 4=Resting
 +
 
 +
* <span class="highlight2">Initialized:</span> {bool} Returns true/false for initialization status of plugin
 +
 
 +
* <span class="highlight2">UseDet:</span> {bool} Returns true/false for option EnableDetremental
 +
 
 +
* <span class="highlight2">Fudge:</span> {int} Returns value for the 'fudge' factor
 +
 
 +
* <span class="highlight2">CastingID:</span> {int} Returns value for current spell casting ID
 +
 
 +
* <span class="highlight2">ActiveFavorCost:</span> {int} Returns your active favor cost
 +
 
 +
* <span class="highlight2">Active:</span> {bool} Returns true/false for status of your tribute (on/off)
 +
 
 +
* <span class="highlight2">Timer:</span> {ticks} Returns ticks for the tribute timer
 +
 
 +
'''Example: ${Tribute.TributeActive}'''<br>
 +
'''Example: ${Tribute.Timer.Time}'''
 +
 
 +
==Commands==
 +
 
 +
* <span class="highlight2">/tribute on</span> Toggle tribute on.
 +
* <span class="highlight2">/tribute off</span> Toggle tribute off.
 +
* <span class="highlight2">/tribute auto</span> Toggle tribute on or off based on combat state automatically.
 +
* <span class="highlight2">/tribute enabledetrimental</span> Enables turning tribute on when casting a detrimental spell.
 +
* <span class="highlight2">/tribute disabledetrimental</span> Disables turning tribute on when casting a detrimental spell.
 +
* <span class="highlight2">/tribute enabletrophy</span> Enables trophy control.
 +
* <span class="highlight2">/tribute disabletrophy</span> Disables trophy control.
 +
* <span class="highlight2">/tribute forceoff</span> Toggle tribute off immediately ignoring any remaining time left.
 +
* <span class="highlight2">/tribute show</span> Shows the current mode the plugin is running in (i.e. on/off/auto).
 +
* <span class="highlight2">/tribute savesettings</span> Saves current plugin configuration to the .ini.
 +
 
 +
==Configuration==
 +
 
 +
MQ2TributeManager is configured via slash commands. Your saved configuration is stored in the MQ2TributeManager.ini. The plugin stores each toons configuration seperately within the .ini with sections based on server_toonname.
 +
 
 +
Command options can be grouped together, like so:
 +
 
 +
/tribute on auto savesettings | This will turn on tribute, and then set the plugin to manage tribute automatically based on combat state.  So if you are resting and the current favor period has expired the plugin will turn tribute off and then the next time you enter combat it will turn tribute on.
 +
 
 +
===Example Configuration===
 +
MQ2TributeManager.ini
 +
<pre>[bertox_TOON1]
 +
Mode=Auto
 +
UseDetrimentalSpell=0
 +
ControlTrophy=0
 +
[bertox_TOON2]
 +
Mode=Auto
 +
UseDetrimentalSpell=0
 +
ControlTrophy=1</pre>
 +
 
 +
==Availability==
 +
 
 +
This plugin is included with the MMOBugs Compile.

Latest revision as of 19:10, 12 December 2011

Plugin Info
Name MQ2TributeManager
Author Alt228
Link Forum Link
Commands /tribute
Source Available Yes
Uses INI File Yes



Description

MQ2TributeManager Adds a /tribute command in game with automatic tribute status management capabilities.


The TLO name is Tribute, here are the members, in case anyone wants to add to hud, macro, etc.:


  • Mode: {string} Returns the current mode as Manual, Auto, OffWhenExpired.
  • CombatState: {string} Returns the combat state as Combat, Debuffed, Cooldown, Active, Resting
  • nCombatState: {int} Returns the combat state as 0=Combat, 1=Debuffed, 2=Cooldown, 3=Active, 4=Resting
  • Initialized: {bool} Returns true/false for initialization status of plugin
  • UseDet: {bool} Returns true/false for option EnableDetremental
  • Fudge: {int} Returns value for the 'fudge' factor
  • CastingID: {int} Returns value for current spell casting ID
  • ActiveFavorCost: {int} Returns your active favor cost
  • Active: {bool} Returns true/false for status of your tribute (on/off)
  • Timer: {ticks} Returns ticks for the tribute timer

Example: ${Tribute.TributeActive}
Example: ${Tribute.Timer.Time}

Commands

  • /tribute on Toggle tribute on.
  • /tribute off Toggle tribute off.
  • /tribute auto Toggle tribute on or off based on combat state automatically.
  • /tribute enabledetrimental Enables turning tribute on when casting a detrimental spell.
  • /tribute disabledetrimental Disables turning tribute on when casting a detrimental spell.
  • /tribute enabletrophy Enables trophy control.
  • /tribute disabletrophy Disables trophy control.
  • /tribute forceoff Toggle tribute off immediately ignoring any remaining time left.
  • /tribute show Shows the current mode the plugin is running in (i.e. on/off/auto).
  • /tribute savesettings Saves current plugin configuration to the .ini.

Configuration

MQ2TributeManager is configured via slash commands. Your saved configuration is stored in the MQ2TributeManager.ini. The plugin stores each toons configuration seperately within the .ini with sections based on server_toonname.

Command options can be grouped together, like so:

/tribute on auto savesettings | This will turn on tribute, and then set the plugin to manage tribute automatically based on combat state. So if you are resting and the current favor period has expired the plugin will turn tribute off and then the next time you enter combat it will turn tribute on.

Example Configuration

MQ2TributeManager.ini

[bertox_TOON1]
Mode=Auto
UseDetrimentalSpell=0
ControlTrophy=0
[bertox_TOON2]
Mode=Auto
UseDetrimentalSpell=0
ControlTrophy=1

Availability

This plugin is included with the MMOBugs Compile.