Difference between revisions of "MQ2CastTimer" - MMOBugs Wiki

(New page: {{Pluginbox |author=s0rcier / A_Enchanter_00 }} {{stub}})
 
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
 +
{{plugin}}
 
{{Pluginbox
 
{{Pluginbox
|author=[[User:s0rcier|s0rcier]] / A_Enchanter_00
+
| name = MQ2CastTimer
 +
| author = [[user:s0rcier|s0rcier]] / A_Enchanter_00
 +
| link = [http://www.mmobugs.com/wiki/index.php/MQ2CastTimer Wiki Link]
 +
| commands=/timer
 +
| source = Yes
 +
| usesini = Yes
 
}}
 
}}
{{stub}}
+
==Description==
 +
<font class="highlight">MQ2CastTimer</font> allows you to check timers on active spells, and adds a Timer Window that can be used to monitor spells you have cast on others.
 +
 
 +
==Commands==
 +
 
 +
* <span class="highlight2">/timer on|off</span> Turns the timer window on/off.
 +
* <span class="highlight2">/timer clear ''[all|target|pc|npc|pet]''</span> Clear spell timers.
 +
* <span class="highlight2">/timer autorecast ''#''</span> Set Number of seconds left on spell before recasting Defaunt is 20.
 +
 
 +
==Example Usage==
 +
To use the Timer Window:
 +
* Copy MQUI_CastTimerWnd.xml to your default EQ/uifiles/default directory.
 +
* Load the plugin.
 +
* Reload your UI.
 +
Now you can turn the timer window on.
 +
 
 +
==Macro Data==
 +
 
 +
* <span class="highlight2">${SpellTimer[SpawnID,Caster,Spell Name]} : int</span>  Returns time (in seconds) left on "Spell Name" by "Caster" on "SpawnID".
 +
** Caster must be one of the following: me (default), other or any.
 +
 
 +
==Timer Window==
 +
The Timer Window shows the following information:
 +
 
 +
<span class="highlight">Time Left</span>
 +
* The amount of time left on the spell, in HH:MM:SS format. Eg. 00:15:32.
 +
<span class="highlight">Tags</span>
 +
 
 +
Some information on the target.
 +
 
 +
** T: This is your current target.
 +
** N: Spell did not take hold on this target.
 +
** I: Target is immune to this spell.
 +
** E: Event (Show that the timer is an Event)
 +
** GA: This target is the Group Assist.
 +
** G1-3: This target is group marked 1-3.
 +
** RA: This target is the Raid Assist.
 +
** R1-3: This target is raid marked 1-3.
 +
<span class="highlight">Spell Name</spam>
 +
* The name of the spell.
 +
<span class="highlight">Spawn Name</span>
 +
* The unique name of the spawn.
 +
 
 +
The buttons/comboboxes at the bottom of the window do the following:
 +
 
 +
<span class="highlight">Button</span>
 +
* Pauses and unpauses the Timer Window.
 +
<span class="highlight">Combobox 1</span>
 +
* Select what you want to do when left-clicking the line in the window:
 +
** Target
 +
** TargetNAB (Target nearest spawn without this spell)
 +
** Recast spell (if memmed)
 +
** Clear (removes timer). You cannot remove an event.
 +
<span class="highlight">Combobox 2</span>
 +
* Select what you want to do when right-clicking the line. Same choices as above.
 +
 
 +
<span class="highlight2">The Timer Settings Tab:</span>
 +
 
 +
<span class="highlight">Target (Current Target)</span>
 +
* Show Target Timers
 +
<span class="highlight">NPC</span>
 +
* Show Npc and Npc Pet Timers
 +
<span class="highlight">PC</span>
 +
* Show Pc Timers
 +
<span class="highlight">PET</span>
 +
* Show Pc Pet Timers
 +
<span class="highlight">Events (All Events)</span>
 +
* Show Events
 +
<span class="highlight">My Spells (Show Your Spells)</span>
 +
* Show My Spells
 +
<span class="highlight">Other's Spells (Show Other Spells)</span>
 +
* Show Other Spells
 +
 
 +
==Configuration==
 +
 
 +
MQ2CastTimer provides configuration
 +
 
 +
===Sample Configuration===
 +
An example INI entry created by the MQ2CastTimer Window is below. This contains the location, size and colors of the window.
 +
<pre>[Settings.ServerName.CharacterName]
 +
ChatTop=58
 +
ChatBottom=233
 +
ChatLeft=58
 +
ChatRight=580
 +
Locked=0
 +
WindowTitle=Timers
 +
Fades=1
 +
Delay=0
 +
Duration=500
 +
Alpha=255
 +
FadeToAlpha=255
 +
BGType=1
 +
BGTint.red=93
 +
BGTint.green=83
 +
BGTint.blue=93
 +
ActorModeLeft=0
 +
ActorModeRight=2
 +
DefaultGem=gem8
 +
ShowTarget=0
 +
ShowNpc=1
 +
ShowPC=0
 +
ShowPet=0
 +
ShowEvent=1
 +
ShowMySpells=1
 +
ShowOtherSpells=0
 +
</pre>
 +
 
 +
==Custom Events==
 +
 
 +
You can add Custom Events to the INI file in the following format:
 +
 
 +
[Name of Event]
 +
duration=<#>
 +
event=<" event text">
 +
spawntype=<1=pc|2=npc>
 +
 
 +
The duration is in seconds. The event is the text that you see on the screen when you want the event to occur. An example is below:
 +
 
 +
[NPC Gating]
 +
duration=5
 +
event="#SpawnName# begins to cast the gate spell."
 +
spawntype=2
 +
[NPC Complete Healing]
 +
duration=10
 +
event="#SpawnName# begins to cast a spell. <Complete Healing>"
 +
spawntype=2
 +
[PC Complete Healing]
 +
duration=10
 +
event="#SpawnName# begins to cast a spell. <Complete Healing>"
 +
spawntype=1
 +
[Redfang Despawn]
 +
duration=240
 +
event="An ear-piercing screech reverberates throughout the surreal cavernous Demi-Plane of Blood, announcing the arrival of Redfang."
 +
 
 +
==Availability==
 +
 
 +
This plugin is included with the MMOBugs Compile.

Latest revision as of 05:23, 23 December 2008

Plugin Info
Name MQ2CastTimer
Author s0rcier / A_Enchanter_00
Link Wiki Link
Commands /timer
Source Available Yes
Uses INI File Yes

Description

MQ2CastTimer allows you to check timers on active spells, and adds a Timer Window that can be used to monitor spells you have cast on others.

Commands

  • /timer on|off Turns the timer window on/off.
  • /timer clear [all|target|pc|npc|pet] Clear spell timers.
  • /timer autorecast # Set Number of seconds left on spell before recasting Defaunt is 20.

Example Usage

To use the Timer Window:

  • Copy MQUI_CastTimerWnd.xml to your default EQ/uifiles/default directory.
  • Load the plugin.
  • Reload your UI.

Now you can turn the timer window on.

Macro Data

  • ${SpellTimer[SpawnID,Caster,Spell Name]} : int Returns time (in seconds) left on "Spell Name" by "Caster" on "SpawnID".
    • Caster must be one of the following: me (default), other or any.

Timer Window

The Timer Window shows the following information:

Time Left

  • The amount of time left on the spell, in HH:MM:SS format. Eg. 00:15:32.

Tags

Some information on the target.

    • T: This is your current target.
    • N: Spell did not take hold on this target.
    • I: Target is immune to this spell.
    • E: Event (Show that the timer is an Event)
    • GA: This target is the Group Assist.
    • G1-3: This target is group marked 1-3.
    • RA: This target is the Raid Assist.
    • R1-3: This target is raid marked 1-3.

Spell Name</spam>

  • The name of the spell.

Spawn Name

  • The unique name of the spawn.

The buttons/comboboxes at the bottom of the window do the following:

Button

  • Pauses and unpauses the Timer Window.

Combobox 1

  • Select what you want to do when left-clicking the line in the window:
    • Target
    • TargetNAB (Target nearest spawn without this spell)
    • Recast spell (if memmed)
    • Clear (removes timer). You cannot remove an event.

Combobox 2

  • Select what you want to do when right-clicking the line. Same choices as above.

The Timer Settings Tab:

Target (Current Target)

  • Show Target Timers

NPC

  • Show Npc and Npc Pet Timers

PC

  • Show Pc Timers

PET

  • Show Pc Pet Timers

Events (All Events)

  • Show Events

My Spells (Show Your Spells)

  • Show My Spells

Other's Spells (Show Other Spells)

  • Show Other Spells

Configuration

MQ2CastTimer provides configuration

Sample Configuration

An example INI entry created by the MQ2CastTimer Window is below. This contains the location, size and colors of the window.

[Settings.ServerName.CharacterName]
ChatTop=58
ChatBottom=233
ChatLeft=58
ChatRight=580
Locked=0
WindowTitle=Timers
Fades=1
Delay=0
Duration=500
Alpha=255
FadeToAlpha=255
BGType=1
BGTint.red=93
BGTint.green=83
BGTint.blue=93
ActorModeLeft=0
ActorModeRight=2
DefaultGem=gem8
ShowTarget=0
ShowNpc=1
ShowPC=0
ShowPet=0
ShowEvent=1
ShowMySpells=1
ShowOtherSpells=0

Custom Events

You can add Custom Events to the INI file in the following format:

[Name of Event]
duration=<#>
event=<" event text">
spawntype=<1=pc|2=npc>

The duration is in seconds. The event is the text that you see on the screen when you want the event to occur. An example is below:

[NPC Gating]
duration=5
event="#SpawnName# begins to cast the gate spell."
spawntype=2
[NPC Complete Healing]
duration=10
event="#SpawnName# begins to cast a spell. <Complete Healing>"
spawntype=2
[PC Complete Healing]
duration=10
event="#SpawnName# begins to cast a spell. <Complete Healing>"
spawntype=1
[Redfang Despawn]
duration=240
event="An ear-piercing screech reverberates throughout the surreal cavernous Demi-Plane of Blood, announcing the arrival of Redfang."

Availability

This plugin is included with the MMOBugs Compile.