MQ2ClickMaint

Plugin Info
Name	MQ2ClickMaint
Author	Thez
Link	Forum Link
Commands	/citem, /doclicks, /cmaint
Source Available	Yes
Uses INI File	Yes

Description

I just want to start this off with a huge "Thank You" to Sadge, Hawthorne, Jobey, and most especially Nightmare327 for helping with the testing of this plugin. Without their help, this would never have gotten done.

MQ2ClickMaint is a plugin intended to replace the casting part of maintaining clickies. By tracking the wear-off messages paired with the item to recast a buff, it stores which of your items need to be recast. To monitor this, the ${CMaint} TLO is a boolean that returns true if you have buffs needing to be done, and false if not. I repeat, this plugin does *NOT* automatically maintain buffs. In my opinion, coding that into a plugin to cover every situation would be impossible. As such, the intent is that you can use a macro and the ${CMaint} TLO to activate the command when you want to, or activate it on your own to take the place of a "myclicks.mac" type macro that just refreshes your buffs.

The plugin uses an INI which stores wear-off messages with the associated items to recast when the messages are found.

Commands

/doclicks

/doclicks -> immediately cast every item waiting to be cast. Will not work if you are invis.

/doclicks rez -> if you have been rezzed and want an instant-clicky to be in your first slot, this is the command for you. Enter it right after you have been rezzed to cast every item but myItem0. Once the RezEffect slot is gone, simply "/doclicks" to cast the remaining buff and have it land in your first slot!

/doclicks all -> Cast all items, regardless of which items need to be done. This is also useful for casting items that have no wear-off message. The most effective use is to put a shrink rod in the INI with no wear-off message, then add it to your personal list twice. This will cause the wand never to cast itself except when you do /doclicks all.

/citem -This command is intended to let you add items to your INI for casting from ingame. It works in this order:

-On entering this command to start adding an item, you will see this text: "Now entering 'add' sequence. The next 10 lines of chat will be saved and echoed back to you as they come."

-Once you have done this, the plugin will echo the next 10 lines of chat that it sees, with numbers in front of them. To pick the one that corresponds with the correct wear-off msg for your item, first place the item you wish to cast for that buff on your cursor, then:

-"/citem #", where # is replaced with the correct number from the list.

-If the correct message is not found (adding an item in PoK might be difficult, for example), then:

-"/citem no", which will start the plugin over on reading the next 10 messages.

/cmaint

/cmaint -> displays this list

/cmaint help ->Displays this list, and explains how to use the commands.

/cmaint list -> Lists all items defined in INI

/cmaint me -> Lists all of the items plugin is tracking for your character.

/cmaint add #|FileItem# -> Add Item<#> from INI to your character's list. Ex: 'add FileItem5' or 'add 5'

/cmaint remove # -> Remove Item<#> from your character's list. Ex: 'remove myItem0'

/cmaint reload -> Reload items in the INI without having to reload the plugin.

Example Usage

sub main
:loop
/if (${CMaint}) /call DoClicks
/delay 1s
/goto :loop
/return

Sub DoClicks
|Put all of the checks Right here to Return without doing the clickies
/if (${Me.Invis}) /return
/if (${Me.Moving}) /return
/if (${Me.FeignDeath}) /return
/if (${Me.Casting}) /return

|OK, all of the criteria passed, lets do the clickies
/doclicks
/return

Macro Data

This plugin adds a new TLO : ${CMaint}. This TLO is a boolean which returns TRUE if you have items waiting to be cast, or false otherwise.

Sample Configuration

MQ2ClickMaint.ini

[INI Info]
TotalItems=22
[FileItem0]
ItemName = Fabled Shrunken Goblin Skull Earring
BuffOffMsg = The rage subsides.
[FileItem1]
ItemName = Fabled Pegasus Feather Cloak
BuffOffMsg = You can no longer levitate.
[FileItem2]
ItemName = Ring of the Beast
BuffOffMsg = Your endurance fades.
[FileItem3]
ItemName = Dark Void Shoulders
BuffOffMsg = Your protection fades.
[FileItem4]
ItemName = Shawl of Eternal Forces
BuffOffMsg = Your thoughts become less methodical.
[FileItem5]
ItemName = Celestial Cloak
BuffOffMsg = The heightened focus ends.
[FileItem6]
ItemName = Prismatic Ring of Resistance
BuffOffMsg = Your ward fades.
[FileItem7]
ItemName = Spiked Bracelet of the Betrayer
BuffOffMsg = Your endurance fades.
[FileItem8]
ItemName = Ornate Mask of Fallen Dreams
BuffOffMsg = The illusionary spikes fade away.
[FileItem9]
ItemName = Ring of Resistance
BuffOffMsg = Your soul energy fades.
[FileItem10]
ItemName = Silver Hoop of Speed
BuffOffMsg = Your primal guard fades.
[FileItem11]
ItemName = Serrated Dart of Energy
BuffOffMsg = The savage spirits depart.
[FileItem12]
ItemName = Earring of Pain Deliverance
BuffOffMsg =
[FileItem13]
ItemName = Skull of Vishimtar
BuffOffMsg =
[FileItem14]
ItemName = Jaundiced Bone Breastplate
BuffOffMsg =
[FileItem15]
ItemName = Crimson Ring of Judgment
BuffOffMsg =
[FileItem16]
ItemName = Crystallized Serpent Eye
BuffOffMsg = The brambles fall away.
[FileItem17]
ItemName = Silver Skin Gauntlets
BuffOffMsg = The silvery hue fades.
[FileItem18]
ItemName = Fractured Werewolf Jawbone
BuffOffMsg = The red runes drift away.
[FileItem19]
ItemName = Wand of Imperceptibility
BuffOffMsg = 
[FileItem20]
ItemName = Chaos-Imbued Leather Leggings
BuffOffMsg = The heightened focus ends.

[sn_ch1]
NumItems=5
myItem0=FileItem0
myItem1=FileItem1
myItem2=FileItem2
myItem3=FileItem3
myItem4=FileItem4
[sn_ch2]
NumItems=4
myItem0=FileItem5
myItem1=FileItem6
myItem2=FileItem7
myItem3=FileItem8
[sn_ch3]
NumItems=5
myItem0=FileItem6
myItem1=FileItem8
myItem2=FileItem9
myItem3=FileItem10
myItem4=FileItem11
[server_character]
NumItems=3
myItem0=FileItem2
myItem1=FileItem0
myItem2=FileItem6
[server_character]
myItem0=FileItem0
NumItems=3
myItem1=FileItem19
myItem2=FileItem20
myItem3=FileItem20
myItem4=FileItem7
[server_char]
NumItems=3
myItem0=FileItem0
myItem1=FileItem3
myItem2=FileItem20

Availability

This plugin is included with the MMOBugs Compile.