Difference between revisions of "MQ2NetBots" - MMOBugs Wiki

Line 1: Line 1:
 
{{plugin}}
 
{{plugin}}
 
{{Pluginbox
 
{{Pluginbox
| name = MQ2Template
+
| name = MQ2NetBots
| author=[[User: s0rcier]]
+
| author = [[User:s0rcier|s0rcier]]
| link = [http://www.mmobugs.com/wiki Wiki Link]
+
| link = [http://www.macroquest2.com/phpBB2/viewtopic.php?t=12186 MQ2 VIP]
| commands=/command
+
| commands=/netbots
 
| source = Yes
 
| source = Yes
 
| usesini = Yes
 
| usesini = Yes
 
}}
 
}}
 +
 
==Description==
 
==Description==
'''MQ2NetBots''' provides linked MQ2EQBC clients a method of sharing status and statistics. It makes that information available via Top-Level Object members for macro writers and HUD designers.
+
<font class="highlight">MQ2NetBots</font> provides linked MQ2EQBC clients a method of sharing status information and statistics. It also adds a new Top-Level Object.
  
 
==Commands==
 
==Commands==
  
 +
* <span class="highlight2">/netbots on/off</span> Toggles NetBots on or off.
 +
* <span class="highlight2">/netbots grab=on/off</span> Toggles receiving status updates from other MQ2NetBot clients connected to EQBCS.
 +
* <span class="highlight2">/netbots send=on/off</span> Toggles MQ2NetBot clients sending of status updates to EQBCS on or off.
 +
 +
==INI Example==
 +
SERVER_CHARACTER.INI
 +
<pre>[MQ2NetBots]
 +
Stat=1
 +
Grab=1
 +
Send=1</pre>
 +
 +
==Macro Data==
 +
 +
This plugin adds a new TLO
 +
 +
* <span class="highlight2">${NetBots}</span> Returns information about your client.
 +
* <span class="highlight2">${NetBots[Name]}</span> Returns information about Name.
 +
 +
Data Types - NetBots
  
* <span class="highlight2">/netbots [ on | off ] </span> NetBots functionality on or off
+
* <span class="highlight2">${NetBots.Client} :String</span> Returns currently broadcasting MQ2NetBot clients connect to EQBCS.
* <span class="highlight2">/netbots [ grab=on|off ] </span> Receive status updates from other MQ2NetBots-enabled clients connected to the same EQBCS server.  
+
* <span class="highlight2">${NetBots.Counts} :Int</span> Returns count of broadcasting MQ2NetBot clients connect to EQBCS.
* <span class="highlight2">/netbots [ send=on|off ]  ''parameter''</span> Broadcast status updates to the EQBCS server.
+
* <span class="highlight2">${NetBots.Enable} : Bool</span> Returns TRUE/FALSE based on plugin status.
 +
* <span class="highlight2">${NetBots.Listen} :Bool</span> Returns TRUE/FALSE based on grab parameter status.
 +
* <span class="highlight2">${NetBots.Output} :Bool</span> Returns TRUE/FALSE based on send parameter status.
  
==Example Usage==
+
Data Types - NetBots Clients
Displays the duration remaining on the buff Samwell has in buff slot 4
 
  
        /echo ${NetBots[Samwell].Duration[4]}
+
* <span class="highlight2">${NetBots[Name].Name} :String</span> Name of Name.
 +
* <span class="highlight2">${NetBots[Name].Zone} :Int</span> Zone ID of Name.
 +
* <span class="highlight2">${NetBots[Name].Instance} :Int</span> Instance ID of Name.
 +
* <span class="highlight2">${NetBots[Name].Class} :Class</span> Class of Name.
 +
* <span class="highlight2">${NetBots[Name].Level} :Int</span> Level of Name.
 +
* <span class="highlight2">${NetBots[Name].PctExp} :Float</span> Percent Experience of Name.
 +
* <span class="highlight2">${NetBots[Name].PctAAExp} :Float</span> Percent AA Experience of Name.
 +
* <span class="highlight2">${NetBots[Name].PctGroupLeaderExp} :Float</span> Percent Group Leader Experience of Name.
 +
* <span class="highlight2">${NetBots[Name].CurrentHPs}</span> Current Hitpoints of Name.
 +
* <span class="highlight2">${NetBots[Name].MaxHPs} :Int</span> Total Hitpoints of Name
 +
* <span class="highlight2">${NetBots[Name].PctHPs} :Int</span> Current Hitpoints percentage of Name.
 +
* <span class="highlight2">${NetBots[Name].CurrentEndurance} :Int</span> Current Endurace of Name.
 +
* <span class="highlight2">${NetBots[Name].MaxEndurance} :Int</span> Total Endurance of Name.
 +
* <span class="highlight2">${NetBots[Name].PctEndurace} :Int</span> Current Endurance percentage of Name.
 +
* <span class="highlight2">${NetBots[Name].CurrentMana} :Int</span> Current Mana of Name.
 +
* <span class="highlight2">${NetBots[Name].MaxMana} :Int</span> Total Mana of Name.
 +
* <span class="highlight2">${NetBots[Name].PctMana} :Int</span> Current Mana percentage of Name.
 +
* <span class="highlight2">${NetBots[Name].PetID} :Int</span> Spawn ID of Name's pet.
 +
* <span class="highlight2">${NetBots[Name].PetHP} :Int</span> Hitpoints of Name's pet.
 +
* <span class="highlight2">${NetBots[Name].TargetID} :Int</span> Spawn ID of Name's target.
 +
* <span class="highlight2">${NetBots[Name].TargetHP} :Int</span> Hitpoints of Name's target.
 +
* <span class="highlight2">${NetBots[Name].Casting} :Spell</span> Spell Name is casting.
 +
* <span class="highlight2">${NetBots[Name].State} :String</span> State of Name (STUN STAND SIT DUCK BIND FEIGN DEAD UNKNOWN).
 +
* <span class="highlight2">${NetBots[Name].Attacking} :Bool</span> Is Name Attacking?
 +
* <span class="highlight2">${NetBots[Name].AFK} :Bool</span> Is Name AFK?
 +
* <span class="highlight2">${NetBots[Name].Binding} :Bool</span> Is Name kneeling?
 +
* <span class="highlight2">${NetBots[Name].Ducking} :Bool</span> Is Name ducking?
 +
* <span class="highlight2">${NetBots[Name].Feigning} :Bool</span> Is Name feigning?
 +
* <span class="highlight2">${NetBots[Name].Grouped} :Bool</span> Is Name in a group?
 +
* <span class="highlight2">${NetBots[Name].Invis} :Bool</span> Is Name invis?
 +
* <span class="highlight2">${NetBots[Name].Levitating} :Bool</span> Is Name levitating?
 +
* <span class="highlight2">${NetBots[Name].LFG} :Bool</span> Is Name LFG?
 +
* <span class="highlight2">${NetBots[Name].Mounted} :Bool</span> Is Name on a mount?
 +
* <span class="highlight2">${NetBots[Name].Moving} :Bool</span> Is Name moving?
 +
* <span class="highlight2">${NetBots[Name].Raid} :Bool</span> Is Name in a raid?
 +
* <span class="highlight2">${NetBots[Name].Sitting} :Bool</span> Is Name sitting?
 +
* <span class="highlight2">${NetBots[Name].Standing} :Bool</span> Is Name standing?
 +
* <span class="highlight2">${NetBots[Name].FreeBuffSlots} :Int</span> Total free buff slots Name has.
 +
* <span class="highlight2">${NetBots[Name].InZone} :Bool</span> Is Name in the same zone as you?
 +
* <span class="highlight2">${NetBots[Name].InGroup} :Bool</span> Is Name in your group?
 +
* <span class="highlight2">${NetBots[Name].Leader} :String</span> Is Name the group leader?
 +
* <span class="highlight2">${NetBots[Name].Updated} :Int</span> Timestamp of last NetBots update from Name.
 +
* <span class="highlight2">${NetBots[Name].Gem} :String</span> All spells Name has memorized.
 +
* <span class="highlight2">${NetBots[Name].Gem[#]}} :Spell</span> Spell Name has memorized in Gem[#].
 +
* <span class="highlight2">${NetBots[Name].Buff} :String</span>  All buffs Name currently has.
 +
* <span class="highlight2">${NetBots[Name].Buff[#]} :Spell</span> Name of the buff Name has in buff slot [#].
 +
* <span class="highlight2">${NetBots[Name].Duration} :String</span> Duration remaining of all buffs Name has.
 +
* <span class="highlight2">${NetBots[Name].Duration[#]} :Int</span> Duration of the buff on Name in slot [#].
 +
* <span class="highlight2">${NetBots[Name].ShortBuff} :String</span> All the short duration buffs Name has.
 +
* <span class="highlight2">${NetBots[Name].ShortBuff[#]} :Spell</span> Name of the shortbuff Name has in slot [#].
 +
* <span class="highlight2">${NetBots[Name].PetBuff} :String</span> Name of all the pet buffs Name's pet has.
 +
* <span class="highlight2">${NetBots[Name].PetBuff[#]} :Spell</span> Name of the pet buff in slot [#] Name's pet has.
 +
* <span class="highlight2">${NetBots[Name].TotalAA} :Int</span> Total AAs Name has.
 +
* <span class="highlight2">${NetBots[Name].UsedAA} :Int</span> Total spend AAs of Name.
 +
* <span class="highlight2">${NetBots[Name].UnusedAA} :Int</span> Total unspent AAs of Name.
 +
* <span class="highlight2">${NetBots[Name].CombatState} :Int</span> Combat State of Name.
  
 
==Availability==
 
==Availability==
  
 
This plugin is included with the MMOBugs Compile.
 
This plugin is included with the MMOBugs Compile.

Revision as of 16:52, 12 July 2010

Plugin Info
Name MQ2NetBots
Author s0rcier
Link MQ2 VIP
Commands /netbots
Source Available Yes
Uses INI File Yes


Description

MQ2NetBots provides linked MQ2EQBC clients a method of sharing status information and statistics. It also adds a new Top-Level Object.

Commands

  • /netbots on/off Toggles NetBots on or off.
  • /netbots grab=on/off Toggles receiving status updates from other MQ2NetBot clients connected to EQBCS.
  • /netbots send=on/off Toggles MQ2NetBot clients sending of status updates to EQBCS on or off.

INI Example

SERVER_CHARACTER.INI

[MQ2NetBots]
Stat=1
Grab=1
Send=1

Macro Data

This plugin adds a new TLO

  • ${NetBots} Returns information about your client.
  • ${NetBots[Name]} Returns information about Name.

Data Types - NetBots

  • ${NetBots.Client} :String Returns currently broadcasting MQ2NetBot clients connect to EQBCS.
  • ${NetBots.Counts} :Int Returns count of broadcasting MQ2NetBot clients connect to EQBCS.
  • ${NetBots.Enable} : Bool Returns TRUE/FALSE based on plugin status.
  • ${NetBots.Listen} :Bool Returns TRUE/FALSE based on grab parameter status.
  • ${NetBots.Output} :Bool Returns TRUE/FALSE based on send parameter status.

Data Types - NetBots Clients

  • ${NetBots[Name].Name} :String Name of Name.
  • ${NetBots[Name].Zone} :Int Zone ID of Name.
  • ${NetBots[Name].Instance} :Int Instance ID of Name.
  • ${NetBots[Name].Class} :Class Class of Name.
  • ${NetBots[Name].Level} :Int Level of Name.
  • ${NetBots[Name].PctExp} :Float Percent Experience of Name.
  • ${NetBots[Name].PctAAExp} :Float Percent AA Experience of Name.
  • ${NetBots[Name].PctGroupLeaderExp} :Float Percent Group Leader Experience of Name.
  • ${NetBots[Name].CurrentHPs} Current Hitpoints of Name.
  • ${NetBots[Name].MaxHPs} :Int Total Hitpoints of Name
  • ${NetBots[Name].PctHPs} :Int Current Hitpoints percentage of Name.
  • ${NetBots[Name].CurrentEndurance} :Int Current Endurace of Name.
  • ${NetBots[Name].MaxEndurance} :Int Total Endurance of Name.
  • ${NetBots[Name].PctEndurace} :Int Current Endurance percentage of Name.
  • ${NetBots[Name].CurrentMana} :Int Current Mana of Name.
  • ${NetBots[Name].MaxMana} :Int Total Mana of Name.
  • ${NetBots[Name].PctMana} :Int Current Mana percentage of Name.
  • ${NetBots[Name].PetID} :Int Spawn ID of Name's pet.
  • ${NetBots[Name].PetHP} :Int Hitpoints of Name's pet.
  • ${NetBots[Name].TargetID} :Int Spawn ID of Name's target.
  • ${NetBots[Name].TargetHP} :Int Hitpoints of Name's target.
  • ${NetBots[Name].Casting} :Spell Spell Name is casting.
  • ${NetBots[Name].State} :String State of Name (STUN STAND SIT DUCK BIND FEIGN DEAD UNKNOWN).
  • ${NetBots[Name].Attacking} :Bool Is Name Attacking?
  • ${NetBots[Name].AFK} :Bool Is Name AFK?
  • ${NetBots[Name].Binding} :Bool Is Name kneeling?
  • ${NetBots[Name].Ducking} :Bool Is Name ducking?
  • ${NetBots[Name].Feigning} :Bool Is Name feigning?
  • ${NetBots[Name].Grouped} :Bool Is Name in a group?
  • ${NetBots[Name].Invis} :Bool Is Name invis?
  • ${NetBots[Name].Levitating} :Bool Is Name levitating?
  • ${NetBots[Name].LFG} :Bool Is Name LFG?
  • ${NetBots[Name].Mounted} :Bool Is Name on a mount?
  • ${NetBots[Name].Moving} :Bool Is Name moving?
  • ${NetBots[Name].Raid} :Bool Is Name in a raid?
  • ${NetBots[Name].Sitting} :Bool Is Name sitting?
  • ${NetBots[Name].Standing} :Bool Is Name standing?
  • ${NetBots[Name].FreeBuffSlots} :Int Total free buff slots Name has.
  • ${NetBots[Name].InZone} :Bool Is Name in the same zone as you?
  • ${NetBots[Name].InGroup} :Bool Is Name in your group?
  • ${NetBots[Name].Leader} :String Is Name the group leader?
  • ${NetBots[Name].Updated} :Int Timestamp of last NetBots update from Name.
  • ${NetBots[Name].Gem} :String All spells Name has memorized.
  • ${NetBots[Name].Gem[#]}} :Spell Spell Name has memorized in Gem[#].
  • ${NetBots[Name].Buff} :String All buffs Name currently has.
  • ${NetBots[Name].Buff[#]} :Spell Name of the buff Name has in buff slot [#].
  • ${NetBots[Name].Duration} :String Duration remaining of all buffs Name has.
  • ${NetBots[Name].Duration[#]} :Int Duration of the buff on Name in slot [#].
  • ${NetBots[Name].ShortBuff} :String All the short duration buffs Name has.
  • ${NetBots[Name].ShortBuff[#]} :Spell Name of the shortbuff Name has in slot [#].
  • ${NetBots[Name].PetBuff} :String Name of all the pet buffs Name's pet has.
  • ${NetBots[Name].PetBuff[#]} :Spell Name of the pet buff in slot [#] Name's pet has.
  • ${NetBots[Name].TotalAA} :Int Total AAs Name has.
  • ${NetBots[Name].UsedAA} :Int Total spend AAs of Name.
  • ${NetBots[Name].UnusedAA} :Int Total unspent AAs of Name.
  • ${NetBots[Name].CombatState} :Int Combat State of Name.

Availability

This plugin is included with the MMOBugs Compile.