Category:Data Types

From the wonderful RedGuides Wiki

Data Types are the members (or properties) of Top-Level Objects or other data types. See this beginner's guide on TLOs and DataVars for more information.

[ Toggle DataType list ]

Data Type Description
achievement Provides the details about a single achievement and allows access to an achievement's objective. There's a more detailed manual of this datatype with examples at docs.macroquest.org.
achievementcat Provides access to achievement categories. Achievements are organized hierarchically in the achievements window by categories. While not required to access achievements, categories may be useful for enumerating lists of achievements.
achievementmgr Provides access achievements, achievement categories, and other information surrounding the achievement system
achievementobj Represents a single objective of an achievement
action An "action" is a type method that conducts a character or UI action with Command:/invoke. See examples, and toggle the list below to see all available actions. In the official documentation, "actions" are referred to as "Methods".
advloot Information about the loot window
advlootitem Information about items in the loot window
AdvPath Displays that status of various settings in MQ2AdvPath
alert Information on alerts
alertlist Extensive information about a specific alert
altability Contains all the data related to alternate abilities
argb Contains data related to window colors
array Data related to arrays. Note: Array indexing starts at 1
augtype Returns information about the specific augment
auratype Data related to auras
AutoLogin Holds the Profile type, as well as information on the current login
AutoLoot Contains members that return the current status of the autoloot plugin, as well as inventory information.
bandolier Contains information about EverQuest's bandolier feature
bandolieritem Contains information about items within a specific bandolier profile
bazaar Returns information on the search result
bazaaritem Returns information on the index specified by Item or SortedItem from DataType:bazaar.
body Contains data about spawn body types
bool Unlike bool in most programming and scripting languages, bool in MacroQuest is unique: Any non-zero value evaluates to true. However, 0 still equals false, and 1 still equals true.
Boxr Provides details about the automation that MQ2Boxr considers to currently be in control
buff This is the type for any buffs currently affecting you, both long duration and short duration (bard) buffs. Inherits DataType:spell
byte Represents an 8 bit integer, with values ranging from 0 to 255.
cachedbuff Allows checking if cached buffs on others have expired without targeting. Inherits members from DataType:spell NOTE: Buff caching is now default in MacroQuest. You're advised to use DataType:buff for nearly all cases. See this note on the official docs.
Cast Returns information about plugin status, currently spell being cast, spell readiness and more.
character Returns information on character. Inherits DataType:spawn
charselectlist Data related to the character select list
chatwnd Holds a single member that returns the title of the MQ2ChatWnd window
circle Members of this datatype relate to the '/circle' command and can be accessed via the ${Circle} TLO
class Data about a class. Returns long name by default.
corpse Data related to a specified corpse. Inherits DataType:spawn
currentzone Contains data about the current zone. Inherits zone.
CWTN Contains status and setting information for CWTN plugins
DanNet Holds members that return information on peers as well as settings
DanObservation Holds information on when a query was last received
Debuff Reports harmful effects, number of curse/disease/poison counters and various other detriments.
Deity Contains data related to deity members. Yes, it's Capitalized.
DisplayItem Holds members that can control and return status on item display windows. Inherits DataType:item
double A 64-bit floating data type
DPSAdv Returns information about status, time, your DPS and your pet's DPS.
dynamiczone Data for the current dynamic zone instance
dzmember This DataType contains information on the members of the current dynamic zone instance
dztimer Provides information about a dynamic zone lockout timer
EQBC Members of this datatype relate to MQ2EQBC settings and generic information and can be accessed via the ${EQBC} TLO.
everquest Data types related to the current EverQuest session. Can also be accessed via the TLO:MacroQuest
Evolving A DataType that deals with evolving items. Yes, it's capitalized.
Farm Returns information about intended target and version
fellowship Contains all the data about your fellowship
fellowshipmember Contains all the data related to fellowship members
float Contains all information related to floating point numbers
  • A floating-point number is one which has a decimal component (e.g. 3.14)
  • Members of this DataType generally manipulate the number's precision (i.e. how many decimal places)
  • They all round correctly with the exception of int
framelimiter Holds information about the framelimiter's settings and status
friend Contains data related to your friend list
GMCheck Shows if a GM is in the zone, and how many are in the zone.
Grind These members show if MQ2Grind is active, the instance it's running, and other status information
ground Contains all data related to a ground spawn
GroundSpawns Contains data from MQ2GroundSpawns
group Contains details about your group
groupmember Contains data on a specific group member. Inherits DataType:spawn
heading Data related to a specific spawn heading
iniadv A new method to read values from an ini file. Don't call it advanced, call it "robust".
iniadvfile Returns information on the ini file
iniadvfilesection Returns information on sections within an ini file
iniadvfilesectionkey Access keys in an .ini file, whether a specific one or in general.
int Data related to integers
int64 Int64 represents integers with values that range from negative 9,223,372,036,854,775,808 through positive 9,223,372,036,854,775,807
invslot Data related to an inventory slot.
item Contains data about items
itemfilterdata
itemspell This contains information related to item spells.
keyring Contains information about keyrings
keyringitem Contains information about items within keyrings
linkdb
list A sequence of items in which it is possible to remove items from the ends or from arbitrary positions by index. The 'front' of the list is called the Head and the 'rear' the Tail. Items in the list may be indexed by ordinal position, with zero indicating the first item.
listiterator A listiterator implements a forward iterator over the list type. A forward iterator is an iterator that can only be incremented. Invoking Advance on the iterator will position the iterator on the next element in the list. Elements in a list are identified by position. The positions have ordinals in the range 0 to Count -1. If there is no next element, the iterator will be positioned on the end of the list and IsEnd will be true.
LoginProfile Returns specific AutoLogin profile information
lua Returns information primarily about the Lua plugin itself
luainfo Accessed with the "Script" member from the DataType:lua Returns information primarily about the specified Lua script.
macro The Macro DataType deals with the macro currently running, and nothing else.
macroquest Data types related to the current MacroQuest session. Inherits DataType:everquest
makecamp Members of this datatype relate to the '/makecamp' command and can be accessed via the ${MakeCamp} TLO.
map A map is a collection of keys, each of which is associated with a value. Maps are also called dictionaries or associative arrays. The keys in a map must be unique. The values may be any arbitrary string.
mapiterator A mapiterator implements a forward iterator over the map type. A forward iterator is an iterator that can only be incremented. Invoking Advance on the iterator will position the iterator on the next element with a value lexicographically greater than the current element. If there is no next element, the iterator will be positioned on the end of the map and IsEnd will be true.
math This DataType performs various mathematical calculations. In the following members, n is any formula that consists of valid Operators.
Medley Holds members that return current medley, information about the current queue, and other status about the songs being played
Melee Contains members the report status of plugin variables and current target(s)
menu Returns information about visible menus. Inherits DataType:window when a menu is open.
mercenary This is the type used for mercenaries. If mercenary exists, this type inherits DataType:spawn
merchant This contains information related to the active merchant. Inherits DataType:spawn when merchant active.
moveto Members of this datatype relate to the '/moveto' command and can be accessed via the ${MoveTo} TLO.
MoveUtils Members of this datatype relate to plugin settings and generic information and can be accessed via the ${MoveUtils} TLO.
MyButtons Returns information about the name and command assigned to buttons
Navigation Contains information about current mesh, path, velocity, and settings.
NetBots Data Types for MQ2NetBots, the bread and butter of this plugin. Returns information from character name to hit points to levitation status. Most types will require that you use a character name on the index of the TLO. e.g. ${NetBots[Name].AFK}
pet Returns information on Pets. Inherits from DataType:spawn
petbuff holds information about the pet's buffs. Inherits DataType:spell
plugin Data for the specified plugin
pointmerchant Contains information about point merchants, such as LDON merchants. Inherits DataType:spawn when merchant active.
pointmerchantitem Returns information about the specified item from a point merchant
PortalSetter Members show the progress of PortalSetter
Posse Returns status about players within a radius, if they're friends or strangers, and how many of them are around.
queue A queue is a first-in, first-out data structure. Items Pushed are inserted at the rear, or 'tail' of the queue. Items removed, or Popped are taken from the 'front' of the queue.
race Contains information on the specified race
raid Contains data on the current raid.
raidmember Data related to the specified raid member. Inherits DataType:spawn when spawn is in zone.
Range This DataType performs a simple test on n using the following members.
React Note: Members that return condition statements will be parsed automatically. These are most useful to provide shortcuts to complex conditions for macros like KissAssist.
RewardItem Gives information about the specified reward, including number of options, items, and availability.
RewardOption Returns information on reward options
RewardOptionItem Returns name of the indicated option if available; else NULL
Rewards Information on the number of rewards, and their index or name
Rez Returns information on MQ2Rez settings
saywnd Holds a member the returns the title of the say window
set A set is a collection of unordered unique values. In practice, the values in this set are ordered lexicographically. Adding an item that is already in a set does not alter the set.
setiterator A setiterator implements a forward iterator over the set type. A forward iterator is an iterator that can only be incremented. Invoking Advance on the iterator will position the iterator on the next element with a value lexicographically greater than the current element. If there is no next element, the iterator will be positioned on the end of the set and IsEnd will be true.
skill Data related to a particular skill
solventtype handles data for solvents
spawn A type for spawns
SpawnMaster Returns information about spawns
spell Spell information
SQLite Will return the results of your database query, or show the status of a given query.
stack A stack is a last-in, first-out data structure. Items inserted (Pushed) are placed on the 'top' of the queue. Items removed (Popped) are also removed from the 'top'.
stick Members of this datatype relate to the '/stick' command and can be accessed via the ${Stick} TLO.
string A string is an array of characters. In MQ there is no single character datatype, so any variable or expression that contains text is considered a string.
swap Gives the status of what MQ2BardSwap is doing, and setting information
switch Data related to switches (doors, levers, buttons, etc) in the zone
Targ Returns information on the spawns detected in MQ2Targets.
target This is the type for your target, which has access to buff information. Inherits DataType:spawn.
task This is the type for your current task.
taskmember Describes a member in your current task
taskobjectivemember Returns information on task objectives
ticks Contains all the data related to the ticks time object
time Contains data related to time
timer A timer data type is set in tenths of one second and counts down to zero; starting immediately after being set.
timestamp Similar to DataType:ticks except the default return value is in milliseconds.
tradeskilldepot Holds members for the personal tradeskill depot.
Trophy Contains data from MQ2TSTrophy
TTS Holds several members for MQTextToSpeech
twist Returns information about the current twist queue
type Information about data types. The parent type is TLO:Type
Vendor Returns information about the current vendor's items.
window This contains data related to the specified in-game window.
worldlocation Provides access to world locations such as a character's bound location
XAssist Displays information about aggro from xtargets
xptracker Holds several members that display your EXP gain and session time.
xtarget Contains the data related to your extended target list. Inherits DataType:spawn
zone Contains information related to the specified zone

Add a Data Type

This category uses the form Data Type.

Pages in category "Data Types"

The following 149 pages are in this category, out of 149 total.