macroquest¶
Data types related to the current MacroQuest session. These also inherit from the EverQuest Type.
Members¶
bool Anonymize¶
- Anonymize character data
int Build¶
-
The build (client target) for MacroQuest
Value Meaning 1 Live 2 Test 3 Beta 4 Emu
string BuildName¶
-
The build (client target) name for MacroQuest:
- "Live"
- "Test"
- "Beta"
- "Emu"
string BuildDate¶
- Date that MacroQuest was built
string Error¶
- Last normal error message
string InternalName¶
- The internal name from MacroQuest("Next")
string MQ2DataError¶
- Last Macro parsing error message
int Parser¶
- Which parser engine is currently active
string Path[Option]¶
-
Retrieves the path to the specified location. If no path is provided, the root path of MacroQuest (where the MacroQuest.exe lives) is returned.
Important
Be sure to use this member to access these paths, and do not hard code paths. These locations in MacroQuest are configurable and may not be in the default locations!
Option Result root Returns the path to the root directory. config Returns path to the config directory crashdumps Returns the path to where crash dumps are stored logs Returns the path to the logs directory mqini Returns the path to MacroQuest.ini macros Returns the path to the macros directory plugins Returns the path to the plugins directory resources Returns the path to the resources directory If no path is provided, the root path is returned.
string SyntaxError¶
- Last syntax error message
string Version¶
- The full version of MacroQuest
string To String¶
- None
Inherited members from everquest
Inherited from everquest¶
Data types related to the current EverQuest session.
int CharSelectList¶
- Currently returns the zone ID the character is currently in
bool ChatChannel[channelname]¶
- Returns TRUE if channelname is joined
string ChatChannel[#]¶
- Returns the name of chat channel #
int ChatChannels¶
- Returns the number of channels currently joined
string CurrentUI¶
- return a string representing the currently loaded UI skin
bool Foreground¶
- Returns TRUE if EverQuest is in Foreground
string GameState¶
- Shows the current game state. Values: CHARSELECT, INGAME, PRECHARSELECT, UNKNOWN
int64 HWND¶
- Window handle.
bool IsDefaultUILoaded¶
- returns a bool true or false if the "Default" UI skin is the one loaded
string LastCommand¶
- Last command entered
window LastMouseOver¶
- Returns the last window you moused over
string LastTell¶
- Name of last person to send you a tell
bool LayoutCopyInProgress¶
- Returns TRUE if a layoutcopy is in progress and FALSE if not.
bool LClickedObject¶
- Returns TRUE if an object has been left clicked
string LoginName¶
- Your station name
int MaxBGFPS¶
- Maximum background FPS
int MaxFPS¶
- Maximum foreground FPS
int MouseX¶
- Mouse's X location
int MouseY¶
- Mouse's Y location
string Path¶
- Path to the Everquest folder
int PID¶
- Your current (Process ID)
int Ping¶
- Your current ping
int Running¶
- Running time of current MQ2 session, in milliseconds
int ScreenMode¶
- Returns the screenmode as an integer, 2 is Normal and 3 is No Windows
string Server¶
- Full name of your server
int PPriority¶
- Returns the processor priority that Everquest is set to. Values: UNKNOWN, LOW, BELOW NORMAL, NORMAL, ABOVE NORMAL, HIGH, REALTIME
float UiScale¶
- Returns the current UI scale
bool ValidLoc[coorrdinates]¶
- Returns true if the given coordinates are valid.
int ViewportX¶
- EverQuest viewport upper left (X) position
int ViewportXCenter¶
- EverQuest viewport center (X) position
int ViewportXMax¶
- EverQuest viewport lower right (X) position
int ViewportY¶
- EverQuest viewport upper left (Y) position
int ViewportYCenter¶
- EverQuest viewport center (Y) position
int ViewportYMax¶
- EverQuest viewport lower right (Y) position
string WinTitle¶
- Titlebar text of the Everquest window.
Example¶
Get the path to the config directory.
/echo ${MacroQuest.Path[config]}
Discussions that link here
This datatype is added by MacroQuest.
Republished and possibly modified from https://docs.macroquest.org/reference/data-types/datatype-macroquest/