Difference between revisions of "MQ2Main" - MMOBugs Wiki

 
(Created templatized article from info on MQ2 wiki & MQ2 documentation)
 
Line 1: Line 1:
[[Category: Incomplete Plugin Pages]]
+
{{plugin}}
 +
{{Pluginbox
 +
| name = MQ2Main
 +
| author= [http://www.macroquest2.com MQ2 Devs]
 +
| source = Yes
 +
| usesini = Yes
 +
}}
 +
 
 +
==Description==
 +
<font class="highlight">MQ2Main</font> is the core of Macroquest, and provides all the standard base functionality. Detailed expalanations of all features are beyond the scope of this wiki article, which is only intended to provide a brief overview.
 +
 
 +
==Commands==
 +
 
 +
For a complete list, and explanations of these commands please see the [http://www.macroquest2.com/wiki/index.php/Main_Page Macroquest2 Wiki] and the [http://www.macroquest2.com/includes/wassup/manual.php Macroquest2 Manual]
 +
 
 +
* <span class="highlight2">/aa</span> - Used to retrieve information on AA Abilities, or to activate an AA ability.
 +
* <span class="highlight2">/alert</span> - Used to manipulate alert lists which 'watch' for spawns.
 +
* <span class="highlight2">/alias</span> - Useful for creating shorter versions of a command.
 +
* <span class="highlight2">/altkey</span> - Execute a command while telling the window manager that the alt key is pressed.
 +
* <span class="highlight2">/banklist</span> - Displays an inventory of the currently logged in character.
 +
* <span class="highlight2">/beep</span> - Performs a system beep.
 +
* <span class="highlight2">/bind</span> - Binds commands to a key or key combo.
 +
* <span class="highlight2">/call</span> - Calls a subroutine.
 +
* <span class="highlight2">/caption</span> - Command that sets the custom captions in-game.
 +
* <span class="highlight2">/captioncolor</span> - Allows custom spawn caption coloring
 +
* <span class="highlight2">/charinfo</span> - Returns Your current bind zone and location.
 +
* <span class="highlight2">/cleanup</span> - Closes all open windows and then opens inventory window.
 +
* <span class="highlight2">/clearerrors</span> - Clears each of the "last errors" in the macroquest type.
 +
* <span class="highlight2">/click</span> - Clicks the left/right mouse button at coordinates or a defined location.
 +
* <span class="highlight2">/combine</span> - Activates the Combine button combine of pack.
 +
* <span class="highlight2">/ctrlkey</span> - Execute a command while telling the window manager that the ctrl key is pressed.
 +
* <span class="highlight2">/declare</span> - Creates a variable.
 +
* <span class="highlight2">/delay</span> - Fully pauses macro for a set amount of time.
 +
* <span class="highlight2">/deletevar</span> - Deletes an existing variable.
 +
* <span class="highlight2">/doability</span> - Activates a combat ability if it is ready to be used.
 +
* <span class="highlight2">/doevents</span> - Runs any events that have queued up or flushes queued events.
 +
* <span class="highlight2">/doors</span> - Lists all doors in the zone.
 +
* <span class="highlight2">/doortarget</span> - "Targets" a door for use with /face door.
 +
* <span class="highlight2">/drop</span> - Drops the item currently on the cursor.
 +
* <span class="highlight2">/dumpbinds</span> - Dumps all current binds to Configs\ name.cfg which can be used to load later.
 +
* <span class="highlight2">/echo</span> - Echo's the specified text and or variable values to the EQ client.
 +
* <span class="highlight2">/endmacro</span> - Stops the macro.
 +
* <span class="highlight2">/face</span> - Turns your character to face your target.
 +
* <span class="highlight2">/for</span> - Standard programming command for creating for next statements.
 +
* <span class="highlight2">/goto</span> - Moves macro execution to a label.
 +
* <span class="highlight2">/identify</span> - Cross between the Identify spell and right-clicking an item for info.
 +
* <span class="highlight2">/if</span> - Runs command(s) if formula evaluates to something other than 0.
 +
* <span class="highlight2">/ini</span> - Writes data to the specified ini file.
 +
* <span class="highlight2">/itemnotify</span> - Similar to the /click function, but does not involve the use of the mouse.
 +
* <span class="highlight2">/items</span> - Lists all ground spawns in the zone if "filter" is not used.
 +
* <span class="highlight2">/itemtarget</span> - "Targets" a ground spawn or environmental container.
 +
* <span class="highlight2">/keepkeys</span> - Keeps keys that were pressed with /keypress in their current state when a macro ends.
 +
* <span class="highlight2">/keypress</span> - Sends a bound keypress (eg "Jump" or "Forward") without using the keyboard.
 +
* <span class="highlight2">/listmacros</span> - Lists macro files that are in the 'macros' directory .
 +
* <span class="highlight2">/loadcfg</span> - Loads a cfg file.
 +
* <span class="highlight2">/loadspells</span> - Will load one of your memorized sets of spells.
 +
* <span class="highlight2">/location</span> - Returns your x,y location and the cardinal direction you are facing.
 +
* <span class="highlight2">/loginname</span> - Displays the login name of the account you are currently logged into.
 +
* <span class="highlight2">/look</span> - Changes the angle you are looking.
 +
* <span class="highlight2">/macro</span> - Starts running a macro.
 +
* <span class="highlight2">/memspell</span> - Attempts to memorize a spell.
 +
* <span class="highlight2">/mqlog</span> - Logs text to 'logs'directory or clears the log file. The log file will be saved in the logs folder.
 +
* <span class="highlight2">/mqpause</span> - Pauses/resumes a macro to aid in debugging or chatting.
 +
* <span class="highlight2">/multiline</span> - Executes a series of commands all typed on one line.
 +
* <span class="highlight2">/nomodkey</span> - Releases all ctrl/alt/shift keys for the duration of the execution of command.
 +
* <span class="highlight2">/noparse</span> - Prevents any MQ2Data from being parsed when used in a command.
 +
* <span class="highlight2">/notify</span> - Used to interact with UI windows directly instead of using the mouse.
 +
* <span class="highlight2">/plugin</span> - Lists, loads, and unloads plugins.
 +
* <span class="highlight2">/popup</span> - Displays text in the center of your screen.
 +
* <span class="highlight2">/ranged</span> - Performs a ranged attack.
 +
* <span class="highlight2">/return</span> - Returns to the line immediately following the subroutine call.
 +
* <span class="highlight2">/sellitem</span> - Sells the selected item.
 +
* <span class="highlight2">/setautorun</span> - Forces character into autorun at login.
 +
* <span class="highlight2">/seterror</span> - Sets macroquest.Error to errormsg.
 +
* <span class="highlight2">/shiftkey</span> - Execute a command while telling the window manager that the shift key is pressed.
 +
* <span class="highlight2">/skills</span> - Lists your skills, or your skill level.
 +
* <span class="highlight2">/spew</span> - Enables or disables the output of Debug Spew to a file.
 +
* <span class="highlight2">/squelch</span> - Executes a command and prevents any output from the command.
 +
* <span class="highlight2">/substitute</span> - Allows you to create custom midline substitutions that will work.
 +
* <span class="highlight2">/target</span> - Targets a mob, object, corpse etc.
 +
* <span class="highlight2">/timed</span> - Executes a command after a specified duration (in deciseconds like pause).
 +
* <span class="highlight2">/unload</span> - Unloads MacroQuest.
 +
* <span class="highlight2">/updateitems</span> - Dumps a list ID's and names of all inventory and bank items to ItemDB.txt.
 +
* <span class="highlight2">/varcalc</span> - Perform a calcuation with a variable.
 +
* <span class="highlight2">/vardata</span> - Sets a variable directly to the end result of a MQ2Data string.
 +
* <span class="highlight2">/varset</span> - Set the value of a variable.
 +
* <span class="highlight2">/where</span> - Lists where the closest spawn or pc is.
 +
* <span class="highlight2">/who</span> - Extended version of ingame command.
 +
* <span class="highlight2">/whofilter</span> - Toggles the display of certain filters when using /who.
 +
* <span class="highlight2">/whotarget</span> - MacroQuest enhances this command by allowing you to use it on any target.
 +
* <span class="highlight2">/windows</span> - List all available UI windows.
 +
* <span class="highlight2">/windowstate</span> - Used to open or close UI windows.
 +
 
 +
==Macro Data==
 +
 
 +
All built in TLO's are contained in MQ2Main.
 +
For explanations of these TLO's please see the [http://www.macroquest2.com/wiki/index.php/Top-Level_Objects TLO page] at the [http://www.macroquest2.com/wiki/index.php/Main_Page Macroquest2 Wiki].
 +
 
 +
*<span class="highlight2"> AltAbility</span>
 +
*<span class="highlight2"> Bool</span>
 +
*<span class="highlight2"> Corpse</span>
 +
*<span class="highlight2"> Cursor</span>
 +
*<span class="highlight2"> Defined</span>
 +
*<span class="highlight2"> DisplayItem</span>
 +
*<span class="highlight2"> DoorTarget</span>
 +
*<span class="highlight2"> DynamicZone</span>
 +
*<span class="highlight2"> FindItem</span>
 +
*<span class="highlight2"> FindItemBank</span>
 +
*<span class="highlight2"> FindItemBankCount</span>
 +
*<span class="highlight2"> FindItemCount</span>
 +
*<span class="highlight2"> Float</span>
 +
*<span class="highlight2"> Friends</span>
 +
*<span class="highlight2"> GameTime</span>
 +
*<span class="highlight2"> Ground</span>
 +
*<span class="highlight2"> Group</span>
 +
*<span class="highlight2"> Heading</span>
 +
*<span class="highlight2"> If</span>
 +
*<span class="highlight2"> Ini</span>
 +
*<span class="highlight2"> Int</span>
 +
*<span class="highlight2"> InvSlot</span>
 +
*<span class="highlight2"> ItemTarget</span>
 +
*<span class="highlight2"> LastSpawn</span>
 +
*<span class="highlight2"> LineOfSight</span>
 +
*<span class="highlight2"> Macro</span>
 +
*<span class="highlight2"> MacroQuest</span>
 +
*<span class="highlight2"> Math</span>
 +
*<span class="highlight2"> Me</span>
 +
*<span class="highlight2"> Merchant</span>
 +
*<span class="highlight2"> NearestSpawn</span>
 +
*<span class="highlight2"> Plugin</span>
 +
*<span class="highlight2"> Raid</span>
 +
*<span class="highlight2"> Select</span>
 +
*<span class="highlight2"> SelectedItem</span>
 +
*<span class="highlight2"> Skill</span>
 +
*<span class="highlight2"> Spawn</span>
 +
*<span class="highlight2"> SpawnCount</span>
 +
*<span class="highlight2"> Spell</span>
 +
*<span class="highlight2"> Switch</span>
 +
*<span class="highlight2"> Target</span>
 +
*<span class="highlight2"> Time</span>
 +
*<span class="highlight2"> Type</span>
 +
*<span class="highlight2"> Window</span>
 +
*<span class="highlight2"> Zone</span>
 +
 
 +
==Availability==
 +
 
 +
This plugin is part of the core MQ2 source. It is included with the MMOBugs Compile, and source is freely available.

Latest revision as of 23:42, 27 September 2009

Plugin Info
Name MQ2Main
Author MQ2 Devs
Source Available Yes
Uses INI File Yes


Description

MQ2Main is the core of Macroquest, and provides all the standard base functionality. Detailed expalanations of all features are beyond the scope of this wiki article, which is only intended to provide a brief overview.

Commands

For a complete list, and explanations of these commands please see the Macroquest2 Wiki and the Macroquest2 Manual

  • /aa - Used to retrieve information on AA Abilities, or to activate an AA ability.
  • /alert - Used to manipulate alert lists which 'watch' for spawns.
  • /alias - Useful for creating shorter versions of a command.
  • /altkey - Execute a command while telling the window manager that the alt key is pressed.
  • /banklist - Displays an inventory of the currently logged in character.
  • /beep - Performs a system beep.
  • /bind - Binds commands to a key or key combo.
  • /call - Calls a subroutine.
  • /caption - Command that sets the custom captions in-game.
  • /captioncolor - Allows custom spawn caption coloring
  • /charinfo - Returns Your current bind zone and location.
  • /cleanup - Closes all open windows and then opens inventory window.
  • /clearerrors - Clears each of the "last errors" in the macroquest type.
  • /click - Clicks the left/right mouse button at coordinates or a defined location.
  • /combine - Activates the Combine button combine of pack.
  • /ctrlkey - Execute a command while telling the window manager that the ctrl key is pressed.
  • /declare - Creates a variable.
  • /delay - Fully pauses macro for a set amount of time.
  • /deletevar - Deletes an existing variable.
  • /doability - Activates a combat ability if it is ready to be used.
  • /doevents - Runs any events that have queued up or flushes queued events.
  • /doors - Lists all doors in the zone.
  • /doortarget - "Targets" a door for use with /face door.
  • /drop - Drops the item currently on the cursor.
  • /dumpbinds - Dumps all current binds to Configs\ name.cfg which can be used to load later.
  • /echo - Echo's the specified text and or variable values to the EQ client.
  • /endmacro - Stops the macro.
  • /face - Turns your character to face your target.
  • /for - Standard programming command for creating for next statements.
  • /goto - Moves macro execution to a label.
  • /identify - Cross between the Identify spell and right-clicking an item for info.
  • /if - Runs command(s) if formula evaluates to something other than 0.
  • /ini - Writes data to the specified ini file.
  • /itemnotify - Similar to the /click function, but does not involve the use of the mouse.
  • /items - Lists all ground spawns in the zone if "filter" is not used.
  • /itemtarget - "Targets" a ground spawn or environmental container.
  • /keepkeys - Keeps keys that were pressed with /keypress in their current state when a macro ends.
  • /keypress - Sends a bound keypress (eg "Jump" or "Forward") without using the keyboard.
  • /listmacros - Lists macro files that are in the 'macros' directory .
  • /loadcfg - Loads a cfg file.
  • /loadspells - Will load one of your memorized sets of spells.
  • /location - Returns your x,y location and the cardinal direction you are facing.
  • /loginname - Displays the login name of the account you are currently logged into.
  • /look - Changes the angle you are looking.
  • /macro - Starts running a macro.
  • /memspell - Attempts to memorize a spell.
  • /mqlog - Logs text to 'logs'directory or clears the log file. The log file will be saved in the logs folder.
  • /mqpause - Pauses/resumes a macro to aid in debugging or chatting.
  • /multiline - Executes a series of commands all typed on one line.
  • /nomodkey - Releases all ctrl/alt/shift keys for the duration of the execution of command.
  • /noparse - Prevents any MQ2Data from being parsed when used in a command.
  • /notify - Used to interact with UI windows directly instead of using the mouse.
  • /plugin - Lists, loads, and unloads plugins.
  • /popup - Displays text in the center of your screen.
  • /ranged - Performs a ranged attack.
  • /return - Returns to the line immediately following the subroutine call.
  • /sellitem - Sells the selected item.
  • /setautorun - Forces character into autorun at login.
  • /seterror - Sets macroquest.Error to errormsg.
  • /shiftkey - Execute a command while telling the window manager that the shift key is pressed.
  • /skills - Lists your skills, or your skill level.
  • /spew - Enables or disables the output of Debug Spew to a file.
  • /squelch - Executes a command and prevents any output from the command.
  • /substitute - Allows you to create custom midline substitutions that will work.
  • /target - Targets a mob, object, corpse etc.
  • /timed - Executes a command after a specified duration (in deciseconds like pause).
  • /unload - Unloads MacroQuest.
  • /updateitems - Dumps a list ID's and names of all inventory and bank items to ItemDB.txt.
  • /varcalc - Perform a calcuation with a variable.
  • /vardata - Sets a variable directly to the end result of a MQ2Data string.
  • /varset - Set the value of a variable.
  • /where - Lists where the closest spawn or pc is.
  • /who - Extended version of ingame command.
  • /whofilter - Toggles the display of certain filters when using /who.
  • /whotarget - MacroQuest enhances this command by allowing you to use it on any target.
  • /windows - List all available UI windows.
  • /windowstate - Used to open or close UI windows.

Macro Data

All built in TLO's are contained in MQ2Main. For explanations of these TLO's please see the TLO page at the Macroquest2 Wiki.

  • AltAbility
  • Bool
  • Corpse
  • Cursor
  • Defined
  • DisplayItem
  • DoorTarget
  • DynamicZone
  • FindItem
  • FindItemBank
  • FindItemBankCount
  • FindItemCount
  • Float
  • Friends
  • GameTime
  • Ground
  • Group
  • Heading
  • If
  • Ini
  • Int
  • InvSlot
  • ItemTarget
  • LastSpawn
  • LineOfSight
  • Macro
  • MacroQuest
  • Math
  • Me
  • Merchant
  • NearestSpawn
  • Plugin
  • Raid
  • Select
  • SelectedItem
  • Skill
  • Spawn
  • SpawnCount
  • Spell
  • Switch
  • Target
  • Time
  • Type
  • Window
  • Zone

Availability

This plugin is part of the core MQ2 source. It is included with the MMOBugs Compile, and source is freely available.