Difference between revisions of "MQ2Bzsrch" - MMOBugs Wiki

(Added content in template form.)
(Corrected various params, added missing params, updated level, fixed search window clear, corrected help info, changed help command, various spelling/formatting mistakes corrected.)
Line 2: Line 2:
 
{{Pluginbox
 
{{Pluginbox
 
| name = MQ2Bzsrch
 
| name = MQ2Bzsrch
| author=[http://www.macroquest2.com/phpBB2/profile.php?mode=viewprofile&u=730 DKAA] & [http://www.macroquest2.com MQ2 Devs]
+
| author=[[User:htw|htw]] & [http://www.macroquest2.com/phpBB2/profile.php?mode=viewprofile&u=730 DKAA] & [http://www.macroquest2.com MQ2 Devs]
 
| link = [http://www.macroquest2.com/wiki/index.php/MQ2Bzsrch MQ2 Wiki Link]
 
| link = [http://www.macroquest2.com/wiki/index.php/MQ2Bzsrch MQ2 Wiki Link]
 
| commands=/bzsrch
 
| commands=/bzsrch
Line 12: Line 12:
  
 
== Commands ==
 
== Commands ==
 +
<span class="highlight2">/bzhelp</span> Shows help screen in MQ2 window.<br>
 +
<span class="highlight2">/bzreset</span> Clears search results & clears bazaar search window.<br>
 
<span class="highlight2">/bzsrch [params] [name]</span>
 
<span class="highlight2">/bzsrch [params] [name]</span>
 
* <span class="highlight2">[params]</span> can be one of the following:
 
* <span class="highlight2">[params]</span> can be one of the following:
 
** race any, barbarian, dark elf, dwarf, erudite, froglok, gnome, half elf, human, iksar, ogre, troll, vah shir, wood elf
 
** race any, barbarian, dark elf, dwarf, erudite, froglok, gnome, half elf, human, iksar, ogre, troll, vah shir, wood elf
** class any, bard, beastlord, berserkers, cleric, druid, enchanter, magician, monk, necromancer, paladin, ranger, rogue, shadow knight, shaman, warrior, wizard
+
** class any, bard, beastlord, berserker, cleric, druid, enchanter, magician, monk, necromancer, paladin, ranger, rogue, shadow knight, shaman, warrior, wizard
** stat any, armor class, agility, charisma, dexterity, intelligence, stamina, strength, wisdom, vs cold, vs disease, vs fire, vs magic, vs poison, hit points, mana
+
** stat any, armor class, agility, charisma, dexterity, intelligence, stamina, strength, wisdom, vs cold, vs disease, vs fire, vs magic, vs poison, hit points, mana, endurance, attack, hp regen, mana regen, haste, damage shield, damage shield mitigation, heal amount, spell damage, clairvoyance, heroic agility, heroic charisma, heroic dexterity, heroic intelligence, heroic stamina, heroic strength, heroic wisdom
** slot  any, ammo, arms, back, charm, chest, ear, face, feet, fingers, hands, head legs, neck primary, range, secondary, shoulders, waist, wrist
+
** slot  any, ammo, arms, back, charm, chest, ear, face, feet, fingers, hands, head, legs, neck, primary, range, secondary, shoulders, waist, wrist, power source
** type  any, 1h slashing, 1h blunt, 2h blunt 2h slashing, 2h piercing, alcohol, all effects, armor, arrow, bandages, book, bow, brass instruments, combinable, drink, flowing thought, focus effect, food, haste, jewelry, key, light, martial, misc, note, percussion instrument, piercing, potion, scroll, shield, stringed instrument, throwing, wind instrument
+
** type  1h slashing, 1h blunt, 2h blunt, 2h slashing, 2h piercing, alcohol, alternate ability, all effects, armor, arrow, augmentation, bandage, book, bow, brass instruments, combinable, drink, focus effect, food, jewelry, key, light, martial, misc, note, percussion instruments, piercing, potion, scroll, shield, stringed instruments, throwing, wind instruments
 
** price <low> <high>
 
** price <low> <high>
 
* <span class="highlight2">[name]</span> is the name or partial name of the item you wish to search for
 
* <span class="highlight2">[name]</span> is the name or partial name of the item you wish to search for
Line 26: Line 28:
 
This plugin adds a new TLO which is used for the search results.
 
This plugin adds a new TLO which is used for the search results.
  
<span class="highlight2">${Bazaar}</span> : <span class="highlight">bool</span> - Returns true if there are search results
+
<span class="highlight2">${Bazaar}</span> : <span class="highlight">bool</span> - Returns true when search is complete
  
 
=== Data types ===
 
=== Data types ===
  
*<span class="highlight2">${Bazaar.Done}</span> : <span class="highlight">bool</span> - Returns true if there are search results
+
*<span class="highlight2">${Bazaar.Done}</span> : <span class="highlight">bool</span> - Returns true when search is complete
 
*<span class="highlight2">${Bazaar.Count}</span> : <span class="highlight">int</span> - The number of search results
 
*<span class="highlight2">${Bazaar.Count}</span> : <span class="highlight">int</span> - The number of search results
 
*<span class="highlight2">${Bazaar.Item[n]}</span> : <span class="highlight">bazaaritem</span> - Result info by index (1-based)
 
*<span class="highlight2">${Bazaar.Item[n]}</span> : <span class="highlight">bazaaritem</span> - Result info by index (1-based)
Line 56: Line 58:
  
 
==Version History==
 
==Version History==
 +
 +
*<span class="highlight2">1.2</span> <span class="highlight">''htw''</span>
 +
** htw - Corrected various params, added missing params, updated level, fixed search window clear, corrected help info, changed help command.
  
 
*<span class="highlight2">1.1</span> <span class="highlight">''Lax''</span>
 
*<span class="highlight2">1.1</span> <span class="highlight">''Lax''</span>

Revision as of 19:54, 25 October 2009

Plugin Info
Name MQ2Bzsrch
Author htw & DKAA & MQ2 Devs
Link MQ2 Wiki Link
Commands /bzsrch
Source Available Yes (GPL)
Uses INI File No

Description

MQ2Bzsrch allows commandline bazaar searching.

Commands

/bzhelp Shows help screen in MQ2 window.
/bzreset Clears search results & clears bazaar search window.
/bzsrch [params] [name]

  • [params] can be one of the following:
    • race any, barbarian, dark elf, dwarf, erudite, froglok, gnome, half elf, human, iksar, ogre, troll, vah shir, wood elf
    • class any, bard, beastlord, berserker, cleric, druid, enchanter, magician, monk, necromancer, paladin, ranger, rogue, shadow knight, shaman, warrior, wizard
    • stat any, armor class, agility, charisma, dexterity, intelligence, stamina, strength, wisdom, vs cold, vs disease, vs fire, vs magic, vs poison, hit points, mana, endurance, attack, hp regen, mana regen, haste, damage shield, damage shield mitigation, heal amount, spell damage, clairvoyance, heroic agility, heroic charisma, heroic dexterity, heroic intelligence, heroic stamina, heroic strength, heroic wisdom
    • slot any, ammo, arms, back, charm, chest, ear, face, feet, fingers, hands, head, legs, neck, primary, range, secondary, shoulders, waist, wrist, power source
    • type 1h slashing, 1h blunt, 2h blunt, 2h slashing, 2h piercing, alcohol, alternate ability, all effects, armor, arrow, augmentation, bandage, book, bow, brass instruments, combinable, drink, focus effect, food, jewelry, key, light, martial, misc, note, percussion instruments, piercing, potion, scroll, shield, stringed instruments, throwing, wind instruments
    • price <low> <high>
  • [name] is the name or partial name of the item you wish to search for

Macro Data

This plugin adds a new TLO which is used for the search results.

${Bazaar} : bool - Returns true when search is complete

Data types

  • ${Bazaar.Done} : bool - Returns true when search is complete
  • ${Bazaar.Count} : int - The number of search results
  • ${Bazaar.Item[n]} : bazaaritem - Result info by index (1-based)

The bazaaritem DataType has the following members:

  • ${Bazaar.Item[n].Name} : string - Item Name
  • ${Bazaar.Item[n].Trader} : spawn - The trader selling it
  • ${Bazaar.Item[n].Price} : int - The items price
  • ${Bazaar.Item[n].Quantity} : int - The quantity of items that trader has for sale
  • ${Bazaar.Item[n].ItemID} : int - The item's ID number
  • ${Bazaar.Item[n].Value} : int - Value in the "Stat column" (last column of the search window, eg. save vs fire, int, wis, etc). NOT the value of the Item. Returns 0 if nothing is there.

More information can be found at:

Example Usage

  • /bzsrch race any class any stat any slot any type any price 0 9999999 sword
    • Search for any item called "sword" with no other qualifiers
  • /bzsrch race troll class warrior stat strength slot chest type any price 50000 90000 Plate
    • Search for any troll warrior usable +strength chest slot items with "Plate" in the name, and a price of 50-90k plat.

Version History

  • 1.2 htw
    • htw - Corrected various params, added missing params, updated level, fixed search window clear, corrected help info, changed help command.
  • 1.1 Lax
    • Reworked by Lax to work like other MQ2Data plugins.
  • 1.0a CyberCide
    • Updated for MQ2Data by CyberCide
  • 1.0 DKAA @ 2003-2004
    • Original release by DKAA

Availability

This plugin is included with the MMOBugs Compile, and its source is available from the MQ2 website.