MQ2MoveUtils

MQ2MoveUtils
This plugin performs basic monotonous movement tasks.

View details

Authors	eqmule, Knightly, outlander, SwiftyMUSE, tonio, Lax
Software type	Plugin
Config file	MQ2MoveUtils.ini
Maintained	Yes and supported
Acknowledgements	MQ2Twister by CyberTech
Links	🏠Resource (review) 🤝Support •🛠️Repository

MQ2MoveUtils was created in early 2004 by tonio, giving players a significant improvement over EverQuest's built-in /follow command, as well as a handy way for bards to run "circle" macros.

Today, the main features of MQ2MoveUtils are as follows:

• Stick: This is the main use for this plugin and allows you to "stick" a certain distance from your target. It can be set to always stick behind the target, or always in front if you're tanking.
• MoveTo: Move to a certain point or target. This has some built-in logic that will allow it to move around obstacles.
• MakeCamp: You can set a spot as a "camp", so that you can return to it if you get too far away, or after combat, etc.
• Circle: Run in a circle.

 

Commands

Syntax	Description
/calcangle	Displays lots of basic numerical information related to moving such as Dist values, angular distance, 3D distance, melee range, stick range, speed multipliers. This command is useful to help determine what to set plugin options such as arc values or AllowMove, backup dist, etc.
/circle [option]... | toggle <setting> | set <setting> {on|off}	Autofaces character to run in a circle with a given radius
/makecamp [option]... | toggle <setting> | set <setting> {on|off}	The makecamp command will create a camp spot for you to return to after combat, or to establish boundries for your character to prevent them from moving beyond a certain radius. Using makecamp with no parameters will set up a camp at your current location, using default values.
/moveto [option]... | toggle <setting> | set <setting> {on|off}	The moveto command will move you from your current location to a specific location or target. You can combine any number of these parameters together inline to enable multiple options for the moveto.
/rootme [off]	Roots the player in place, unable to move. this is not any form of actual debuff, just a plugin implementation of locking a character in place. Supplying the optional off parameter disables the root. Other commands will not function when rootme is active.
/stick [option]... | toggle <setting> | set <setting> {on|off}	/follow-like command, works for any pc|npc. Default distance is melee range. /stick with no parameters will stick you to your current target, using max melee range.

Settings

These setting parameters can be used from any of the four main plugin commands ('/stick', '/moveto', '/circle', and '/makecamp'). For example purposes the most popular '/stick' command will be used.

The following can be used with toggle or set parameter on | off:

• /stick toggle parameter
• /stick set parameter on | off

Parameter can be one of the following:

Parameter	Description
mpause | mousepause	Pause current command if [ keyboard | mouse ] movement. Resumes after a random amount of delay set with pausemindelay and pausemaxdelay below. Note: You may not have a pause and corresponding break on at the same time (e.g. no mpause and breakonkb at the same time). You may have opposing options different though (e.g. mousepause on and breakonkb on).
breakonkb | breakonmouse	Break current command if [ keyboard | mouse ] movement. Note: You may not have a pause and corresponding break on at the same time (e.g. no mpause and breakonkb at the same time). You may have opposing options different though (e.g. mousepause on and breakonkb on).
autosave	Automatically save settings to INI file when a toggle or set command is issued.
savebychar	Save [server.Yourcharacter] section of INI file for individual character settings.
feign	Enable Feign Death support, which waits for you to stand up manually before moving.
lockpause	Plugin will never automatically resume from pause until user issues an unpause.
autopause	Pause movement if casting spells (non-bard), stunned, rooted, sitting, FD, or self targeted (non-hold).
autopauseoutput	If enabled, will display ChatWnd output when autopause is halting movement. Note: This bypasses totalsilence and must be configured individually.
stucklogic	If enabled, stucklogic automatically attempts to get unstuck if running into walls and large objects.
trytojump	If enabled, stucklogic also tries to jump to help get unstuck.
turnhalf	If enabled, stucklogic will reset heading and turn the other direction if it has rotated halfway without success.
verbosity	ChatWnd output for basic command information messages.
fullverbosity	ChatWnd output for more detailed information messages and output for more actions.
totalsilence	Silences most ChatWnd output except for critical information or user-requested messages.
totalverbosity	Enable display of every ChatWnd message in the plugin.
hidehelp	If enabled, the help output will not be displayed upon command failure (e.g. invalid parameters).
window	If enabled, MoveUtils will output any messages to a user-placed custom UI window dedicated to the plugin.
wineq	By default, MoveUtils uses actual keypresses to control movement (regardless of heading settings). WinEQ2 has a bug where background sessions can have their alt keys and certain mouse buttons held down, causing movement to run in weird directions. For Lavishsoft users who have not switched over to Innerspace, enabling wineq setting will use old-style emulated movement via ExecuteCmd().
breakontarget	Break from stick if target changes (default behavior is switch over to sticking to new target).
breakonsummon	Halts current command and disables ability to use any commands if summoned beyond summondist. Note: Once this fires, you must use the imsafe parameter to unlock the plugin.
breakongm	Halts current command and disables ability to use any commands if visible GM enters the zone. Note: Once this fires, you must use the imsafe parameter to unlock the plugin.
breakonwarp	Breaks from stick if target warps out of breakdist range (user set, see below). Note: This does not limit your initial stick range. You may /stick from across the zone. This only triggers if the target increases distance from you and is beyond breakdist.
pauseonwarp	Pauses stick if target warps out of breakdist range until they are back in range (user set, see below). Note: This does not limit your initial stick range. You may /stick from across the zone. This only triggers if the target increases distance from you and is beyond breakdist.
breakongate	Breaks from stick if "target Gates" message occurs. Note: if using stick id or stick hold, it will break based on the held target name.
breakonaggro	Breaks from moveto command if you are aggro to an NPC. Note: This checks the player window for the crossed swords indicator.
alwaysdrunk	Use drunken by default when circling.
alwaysbackwards	Run backwards by default when circling.
alwaysccw	Circle in a counter-clockwise direction by default.
nohottfront	Allow for stick front to spin to front of the mob without Health of Target's Target Leader AA. Note: By default stick front will not stay stuck to the front unless you are on the HoTT window. If you toggle this setting it will ignore that requirement, causing you to spin in circles if you lose aggro. It is recommended that you use DelayStrafe.
returnnoaggro	Makecamp will auto-return to camp only if not aggro (checks crossed swords indicator).
returnnotlooting	Makecamp will not auto-return to camp if character has an open loot corpse window.
returnhavetarget	Makecamp will auto-return to camp even if you have a target. Note: By default, makecamp does not auto-return if you have any target.
realtimeplayer	Makecamp player will get realtime updates on player location, allowing for dynamic returns to players. By default, makecamp player will return to a players last location when return begins and not get a new update until the return is complete. The default behavior is a sort of ghetto MQ2AdvPath whereas enabling realtimeplayer will work more like an autofollow.
leash	If enabled, leash prevents moving beyond leashlength (user set value).
usewalk	If enabled, plugin will switch to walking when closing in on moveto destination or camp return.
strafewalk	If enabled, plugin will switch to walking when within strafe range for all stick commands.
randomize	If enabled, stick behind and !front will use random arc values to position.
delaystrafe	If enabled, strafe-based movement (stick front, !front, behind, pin) will use a delay before moving. Note: This helps prevent endless circling when aggro is gained, or spinning when mobs quick-turn to cast spells. Circling is one of the biggest signs that a player is using MoveUtils so it is recommended you ALWAYS leave this enabled.
autoUW	If enabled, stick and moveto will use the uw parameter whenever underwater (look up and down at target).
usefleeing	If enabled, stick front will not attempt to position in the front of a target that is fleeing.
usescatter	If enabled, camp returns will use scattered return locations instead of default behavior. Note: Default behavior attempts to get back within camp radius. See scatter numerical settings for more information.

The following option is unique:

Setting	Description
/stick set heading true | loose | fast	Changes plugin heading adjustments to use the specified type: true: actual keypressing (does not work with wineq=on). loose: simulated incremental turning. fast: instantly set heading.

The following 'set' commands require a numeric value, and can be used from any of the four main plugin commands. (stick used for example purposes only):

Setting	Valid Input	Description
/stick set pulsecheck #	1 or higher	Number of pulses used to calculate average movement distance in stucklogic.
/stick set pulseunstuck #	1 or higher	Number of pulses successfully moved forward before considered unstuck.
/stick set diststuck #.##	0.01 or higher	Minimum distance needed to move or else considered stuck (compares against pulse average).
/stick set campmindelay #	125 or higher	Minimum delay before auto-returning to camp (in ms).
/stick set campmaxdelay #	125 more than campmindelay	Maximum delay before auto-returning to camp (in ms).
/stick set pausemindelay #	125 or higher	Minimum delay before resuming from mpause/mousepause (in ms).
/stick set pausemaxdelay #	125 more than pausemindelay	Maximum delay before resuming from mpause/mousepause (in ms).
/stick set strafemindelay #	125 or higher	Minimum delay before stick will strafe to move when delaystrafe is enabled (in ms). Note: higher values are better. default of 1500 (1.5s) is recommended.
/stick set strafemaxdelay #	125 higher than strafemindelay	Maximum delay before stick will strafe to move when delaystrafe is enabled (in ms). Note: higher values are better. default of 3000 (3s) is recommended.
/stick set ydist #.##	1.0 or higher	Acceptable distance to have "arrived" for precisey moveto.
/stick set xdist #.##	1.0 or higher	Acceptable distance to have "arrived" for precisex moveto.
/stick set snapdist #.##	1.0 or higher	Default distance to run past target before turning to snaproll.
/stick set summondist #.##	2.0 or higher	Distance character must be summoned in a single pulse for BreakOnSummon to fire.
/stick set turnrate #.#	1.0 to 100.0	Rate at which loose heading turns.
/stick set !frontarc #.#	1.1 to 260.0	Angular distance arc for stick !front.
/stick set behindarc #.#	1.1 to 260.0	Angular distance arc for stick behind.
/stick set breakdist #.##	1.0 or higher	Distance to check for breakonwarp.
/stick set campradius #.##	5.0 or higher	Default camp radius and radius for active camp.
/stick set circleradius #.##	5.0 or higher	Default circle radius.
/stick set leashlength #.#	greater or equal to camp radius	Default leash length and length for active leash.
/stick set bearing #.#	any	Bearing (direction from center) used for scatter camp.
/stick set scatsize #.##	1.0 or higher	Radius size for scattering.
/stick set scatdist #.##	1.0 or higher	Distance from center of camp to scatter at.
/stick set allowmove #.##	10.1 or higher	Loose or True heading allow forward movement when reach this angular distance. This is "anti-orbit" code to stop circling near close-range destinations.
/stick set font #	1 to 10	Custom user window font size.
/stick set verbflags #	see verbosity section near bottom of this wiki entry	Current plugin verbosity flags.

The following settings are command-specific (use the command in the example only):

Setting	Valid Input	Description
/stick set backupdist #.##	1.0 or higher	Range that stick will walk backwards instead of turning to face target, if useback enabled.
/moveto set backupdist #.##	1.0 or higher	Range that moveto will walk backwards instead of turning to face destination, if useback enabled.
/moveto set dist #.##	1.0 or higher	Acceptable distance to have "arrived" for standard moveto and camp returns.
/stick [toggle | set] alwaysUW [on | off]		If enabled, stick will always adjust looking angle as if uw parameter was typed inline. Note: this is not the same as autoUW, which only enables uw when actually underwater.
/moveto [toggle | set] alwaysUW [on | off]		If enabled, moveto will always adjust looking angle as if uw parameter was typed inline. Note: this is not the same as autoUW, which only enables uw when actually underwater.
/stick [toggle | set] breakonhit [on | off]		Breaks from stick command if you are attacked by an NPC. Note: This parses chat for hits and misses. If you use the number only hitsmode then it will only parse for misses as parsing every line for only numbers is too much overhead. Consider switching to Normal or Abbreviated hitsmode.
/moveto [toggle | set] breakonhit [on | off]		Breaks from moveto command if you are attacked by an NPC. Note: This parses chat for hits and misses. If you use the number only hitsmode then it will only parse for misses as parsing every line for only numbers is too high overhead. Consider switching to Normal or Abbreviated hitsmode.
/stick [toggle | set] useback [on | off]		If enabled, stick will walk backwards to position itself when close to a target instead of turning to face it. Note: This requires loose or truehead style heading adjustments, and does not work with fast heading.
/moveto [toggle | set] useback [on | off]		If enabled, moveto will walk backwards to position itself when close to a destination instead of turning to face it. Note: This requires loose or truehead style heading adjustments, and does not work with fast heading. This includes automatic and user-forced camp returns.
/stick [toggle | set] loose | truehead [on | off]		Change the heading type for currently active stick to this type of heading. If WinEQ is enabled, truehead will fail to switch. Once current command ends, heading type will return to previous.
/moveto [toggle | set] loose | truehead [on | off]		Change the heading type for currently active moveto to this type of heading. If WinEQ is enabled, truehead will fail to switch. Once current command ends, heading type will return to previous.
/circle [toggle | set] loose | truehead [on | off]		Change the heading type for currently active circle to this type of heading. If WinEQ is enabled, truehead will fail to switch. Once current command ends, heading type will return to previous.

Configuration

MQ2MoveUtils.ini Defaults

MQ2MoveUtils saves a configuration file to your root MQ2 folder: MQ2MoveUtils.ini

Default MQ2MoveUtils.ini File

[Defaults]
AllowMove=32.0
AutoPause=on
AutoPauseMsg=on
AutoSave=on
AutoUW=off
BreakKeyboard=on
BreakMouse=off
BreakOnGM=on
BreakOnSummon=off
DistSummon=8.00
FeignSupport=off
Heading=true
HideHelp=off
KeyboardPause=off
MousePause=off
LockPause=off
PauseMinDelay=500
PauseMaxDelay=5000
SaveByChar=on
TurnRate=14.00
UseWindow=off
Verbosity=on
FullVerbosity=on
TotalSilence=off
VerbosityFlags=33554431
WinEQ=off

[Stick]
AlwaysUW=off
AwareNotAggro=off
ArcBehind=45.0
ArcNotFront=135.0
BreakOnGate=on
BreakOnHit=off
BreakOnTarget=off
BreakOnWarp=on
PauseOnWarp=off
DelayStrafe=on
DistBackup=10.0
DistBreak=250.0
DistMod=0.0
DistMod%=1.0
DistSnaproll=10.0
RandomArc=off
StrafeMinDelay=1500
StrafeMaxDelay=3000
UseBackward=on
UseFleeing=on
UseWalk=off   

[MakeCamp]
CampRadius=40.00
MinDelay=500
MaxDelay=1500
RealtimePlayer=off
ReturnHaveTarget=off
ReturnNoAggro=off
ReturnNotLooting=off
UseLeash=off
LeashLength=50.00
UseScatter=off
Bearing=0.00
ScatDist=10.00
ScatSize=10.00

[MoveTo]
AlwaysUW=off
ArrivalDist=10.0
ArrivalDistX=10.0
ArrivalDistY=10.0
BreakOnAggro=off
BreakOnHit=off
DistBackup=30.0
MoveToMod=0.0
UseBackward=off
UseWalk=on

[Circle]
Backward=off
CCW=off
Drunken=off
RadiusSize=30.0

[StuckLogic]
StuckLogic=on
DistStuck=0.10
PulseCheck=6
PulseUnstuck=10
TryToJump=off
TurnHalf=on

[Window]
ChatTop=10
ChatBottom=210
ChatLeft=10
ChatRight=410
Fades=0
Alpha=255
FadeToAlpha=255
Duration=500
Locked=0
Delay=2000
BGType=1
BGTint.red=255
BGTint.green=255
BGTint.blue=255
FontSize=2
WindowTitle=MoveUtils

[yourserver.yourcharacter]
DisregardMe=false
AllowMove=32.0
ArcBehind=45.0
ArcNotFront=135.0
AutoSave=on
AutoUW=off
DistBreak=250.0
BreakOnGate=on
BreakOnWarp=on
PauseOnWarp=off
LockPause=off
DistSnaproll=10.0
FeignSupport=off
Heading=true
LeashLength=50.00
UseLeash=off
UseWindow=off
Verbosity=on
FullVerbosity=on
VerbosityFlags=33554431
CampRadius=40.00
RealtimePlayer=off
UseScatter=off
Bearing=0.00
ScatDist=10.00
ScatSize=10.00

INI Options

Information on what the actual values can be and represent.

Plugin Settings

This section is for default plugin settings.

Setting	Value	What it does
AllowMove	10.0+	Anti-orbit setting for true/loose heading representing angular distance before moving forward.
AutoPause	on off	Pauses command if casting spells, stunned, rooted, sitting, or self targeted.
AutoPauseMsg	on off	Displays output when AutoPause halts movement.
AutoSave	on off	Automatically save ini file when using 'toggle' or 'set'.
AutoUW	on off	Automatically use 'uw' heading adjustments when character is under water.
BreakKeyboard	on off	Break command from keyboard press.
BreakMouse	on off	Break command from mouselook usage.
BreakonGM	on off	Break current command and prevent command usage if GM enters zone.
BreakonSummon	on off	Halt command and ability to use commands if summoned beyond certain distance.
DistSummon	2.0+	Distance moved in a single pulse to trigger breakonsummon (if on).
FeignSupport	on off	FD support waits for you to stand up manually before moving, if feigned.
Heading	true loose fast	Type of heading adjustments plugin will use (fast=instant, loose=gradual emulated shift, true=real kb presses).
HideHelp	on off	Never automatically display help output unless requested.
KeyboardPause	on off	Pause command for a delay if keyboard press.
LockPause	on off	Plugin will not automatically unpause under any circumstance unless user unpauses.
MousePause	on off	Pause command for a delay if mouselook used.
PauseMinDelay	125+ (in ms)	Minimum delay before resuming from mpause/mousepause.
PauseMaxDelay	125 above min (in ms)	Maximum delay before resuming from mpause/mousepause.
SaveByChar	on off	Save [server.Charname] section of ini file for individual character settings.
TurnRate	10.0 to 100.0	Rate at which loose heading emulates turns.
UseWindow	on off	Uses a custom user-placed window for all moveutils output if enabled.
Verbosity	on off	ChatWnd output for basic command info.
FullVerbosity	on off	ChatWnd output for enhanced plugin info.
TotalSilence	on off	Overrides verb/fullverb, silence ChatWnd output except for critical or user-requested messages.
VerbosityFlags		See verbosity section of this wiki.
WinEQ	on off	When enabled, moveutils uses feigned movement simulation due to the bug of WinEQ2 holding down alt keys and mouse buttons in background sessions.

NOTE: If WinEQ is enabled, true heading is NOT possible!

Stick Settings

This section is for settings related to /stick.

Setting	Value	What it does
AlwaysUW	on off	If enabled, stick will always use the 'uw' parameter as if it were typed inline.
ArcBehind	5.1 to 259.9	User can configure angular distance arc that "stick behind" uses.
ArcNotFront	5.1 to 259.9	User can configure angular distance arc that "stick !front" uses.
AwareNotAggro	on off	Detect aggro loss if using stick front.
BreakonGate	on off	Break from stick if "target Gates." message occurs.
BreakonHit	on off	When enabled, stick will halt if user is being attacked.
BreakonWarp	on off	Break from stick if target warps beyond certain distance.
PauseonWarp	on off	Pause stick unless target gets back in range if warps beyond certain distance (break or pause, can't have both).
DelayStrafe	on off	Delay strafing movement when position adjustment required (good for stopping endless circling if aggro is gained).
DistBackup	1.0+	If you are within this distance when stick turned on, stick will walk backwards rather than spin in a circle to move to target.
DistBreak	1.0+	Distance mob moved in a single pulse to trigger breakonwarp (if on).
DistMod	0.0+	Adjust default/supplied stick distance by this amount.
DistMod%	0.0+ (represents a percentage)	Adjust default/supplied stick distance by this percent.
DistSnaproll	1.0+	Distance behind target snaproll will move before stopping and turning to face target.
RandomArc	on off	Randomize min/max arc for any strafe-based stick (so you do not always stick to the exact same spot of a mob).
StrafeMinDelay	125+ (in ms)	Minimum delay before attempting to strafe, if delaystrafe enabled.
StrafeMaxDelay	125 above min (in ms)	Maximum delay before attempting to strafe, if delaystrafe enabled.
UseBackward	on off	When enabled, stick will walk backward rather than turn to face if within DistBackup of target.
UseFleeing	on off	When enabled, "stick front" will not attempt to position in front of the mob when target begins to flee.
UseWalk	on off	When enabled, stick uses walking when close to the target for precise movements and preventing overshooting.

MakeCamp Settings

This section is for settings related to /makecamp.

Setting	Value	What it does
Bearing	#	Bearing of scatter.
CampRadius	5.0+	Default camp radius size.
LeashLength=	#.# >= camp radius	Length of leash.
MaxDelay	125 above min (in ms)	Maximum delay before auto-returning to camp.
MinDelay	125+ (in ms)	Minimum delay before auto-returning to camp.
RealtimePlayer	on off	When enabled, "makecamp player" gets realtime location updates of player and adjusts returning on the fly.
ReturnHaveTarget	on off	If on, Auto-Return to camp even if you have a target (default behavior is return only if no target).
ReturnNoAggro	on off	Auto-Return to camp only if not aggro.
ReturnNotLooting	on off	Do not Auto-Return to camp if looting a corpse.
ScatDist	1.0+	Distance from camp center to perform scatter.
ScatSize	1.0+	Radius size of scatter area.
UseLeash	on off	Do not allow character to move beyond LeashLength.
UseScatter	on off	Use specific scatter values instead of random return location.

MoveTo Settings

This section is for settings related to /moveto.

Setting	Value	What it does
AlwaysUW	on off	If enabled moveto will always use the 'uw' parameter as if it were typed inline.
ArrivalDist	1.0+	Distance considered acceptable to have arrived at destination.
ArrivalDistX	1.0+	Distance considered acceptable to have arrived at destination when using precisex.
ArrivalDistY	1.0+	Distance considered acceptable to have arrived at destination when using precisey.
BreakonAggro	on off	When enabled, moveto will halt if aggro is gained (crossed swords in player window).
BreakonHit	on off	When enabled, moveto will halt if user is being attacked.
DistBackup	1.0+	Moveto will walk backwards to location if within this distance rather than spin to face destination first.
MoveToMod	0.0+	Modifier applied to moveto arrivaldist.
UseBackward	on off	When enabled, moveto will use backward movement if within DistBackup (applies to makecamp returns).
UseWalk	on off	Turn on walk when close to moveto location and camp return spot for precise movement.

Circle Settings

This section is for settings related to /circle.

Setting	Value	What it does
Backward	on off	Always run backwards instead of forwards when circling.
CCW	on off	Always run in a counterclockwise (ccw) circle instead of default clockwise.
Drunken	on off	Always use drunken circling.
RadiusSize	5.0+	Default radius size of circle.

StuckLogic Settings

This section is for settings related to stucklogic.

Setting	Value	What it does
StuckLogic	on off	If you have enabled stucklogic, detects and attempts to auto-correct getting stuck while moving.
DistStuck	0.01+	Distance needed to have moved or else stuck (compared against an average).
PulseCheck	1+	Amount of pulses used to calculate moving average.
PulseUnstuck	1+	Number of pulses successfully moved forward to be considered unstuck.
TryToJump	on off	Attempt to jump to help get unstuck.
TurnHalf	on off	If you have have turned halfway and failed to get unstuck, reset heading and try other direction instead.

Window Settings

Setting	Value	What it does
ChatTop		See EQ XML UI file settings
ChatBottom		See EQ XML UI file settings
ChatLeft		See EQ XML UI file settings
ChatRight		See EQ XML UI file settings
Fades		See EQ XML UI file settings
Alpha		See EQ XML UI file settings
FadeToAlpha		See EQ XML UI file settings
Duration		See EQ XML UI file settings
Locked		See EQ XML UI file settings
Delay		See EQ XML UI file settings
BGType		See EQ XML UI file settings
BGTint.red		See EQ XML UI file settings
BGTint.green		See EQ XML UI file settings
BGTint.blue		See EQ XML UI file settings
FontSize	1 to 10	default font size for window
WindowTitle		custom user title for the window

[yourserver.yourcharacter]

If savebychar is on, this section will be created for every character. The settings in this section could be desired to vary on a char-by-char basis (including WINDOW settings) with the exception of one value:

Setting	Value	What it does
DisregardMe	true false	If you want custom character values to load for some characters but this specific character to use the default values instead, set this to true and though a lot of entries will be written to this section, they will be ignored for this specific character.

Example [yourserver.yourcharacter] section:

[yourserver.yourcharacter]
DisregardMe=false
AllowMove=32.0
ArcBehind=45.0
ArcNotFront=135.0
AutoSave=on
AutoUW=off
DistBreak=250.0
BreakonGate=on
BreakonWarp=on
PauseonWarp=off
LockPause=off
DistSnaproll=10.0
FeignSupport=off
Heading=true
LeashLength=50.00
UseLeash=off
UseWindow=off
Verbosity=on
FullVerbosity=on
VerbosityFlags=33554431
CampRadius=40.00
RealtimePlayer=off
UseScatter=off
Bearing=0.00
ScatDist=10.00
ScatSize=10.00

Verbosity

The verbosity system has been revamped to use bit flags for superior control of what messages will be displayed by the plugin. The older system has not been removed - if this is difficult to understand you may still use verbosity, fullverbosity, and totalsilence as before. For those familiar with bit flags, the flags table is below. If you have never worked with bit flags before, here is a brief summary of how to use the information below. Each subset of messages is assigned a numerical value. By adding the numerical values of the messages you want on together, you are able to customize each message that is shown or not shown.

Examples:

• If you only wanted the plugin to display 'settings' and 'errors', you would look at the value of settings in the table below (8192) and the value of errors (4194304) and add them together to get (4202496). By setting your verbosity flag to 4202496 (using the set verbflags parameter or by saving the value in the INI file) the plugin would then filter out everything except messages related to changing settings or error messages.
• If you only wanted to display 'stick verbosity' messages and nothing else, you would look up the value in the table below (32) and set your flags to 32 without adding anything to it.
• If you want to display a large number of messages, you continue to add them all together and use the total. To display 'autopause', 'movepause', 'stick verbosity', 'stick fullverbosity', 'settings' and 'errors', you would add all their values from the below table (1 + 2 + 32 + 64 + 8192 + 4194304 = 4202595) and use that number for your flags setting (/stick set verbflags 4202595)

Flags Table

Flag	Description
0	total plugin silence
1	autopause
2	movepause, mousepause, breakonkb
4	breakonmouse
8	feign support
16	hidehelp
32	stick verbosity
64	stick full verbosity
128	moveto verbosity
256	moveto full verbosity
512	makecamp verbosity
1024	makecamp full verbosity
2048	circle verbosity
4096	circle full verbosity
8192	settings
16384	file input / output
32768	breakonwarp
65536	breakonaggro
131072	breakonhit
262144	breakonsummon
524288	breakongm
1048576	breakongate
2097152	stick always
4194304	error messages
8388608	arc randomization
16777216	pause / unpause
2720	prior 'verbosity' setting
11736390	prior 'fullverbosity' setting
33554431	all messages enabled

Flag Messages

The following are the messages that are tied to each flag:

Flag	Message
1	autopause AutoPause halting movement... (when autopaused if autopause is enabled)Movement pausing due to self target... (if self targeted during a stick with autopause off)
2	movepause, mousepause, breakonkb Current command ended from manual movement. Resuming previous command from movement pause.
4	breakonmouse Current command ended from mouse movement.
8	feign support Not standing as you are currently Feign Death.
16	hidehelp Hidehelp when turned on prevents the help output (seen in /stick help) from being automatically output if you input a command incorrectly
32	stick verbosity You are now sticking to TargetName. You are no longer sticking to anything. You will now stick to every valid NPC target supplied.
64	stick full verbosity Dir(ANY) Dist(10.0) Head(true) ID(31337) UW MB HEALER
128	moveto verbosity Moveto off. Arrived at moveto location
256	moveto full verbosity Moving to loc #, # Dist(10) Head(true)
512	makecamp verbosity MakeCamp actived. Y(#) X(#) Radius(#) Leash(#) LeashLen(#) Min(#) Max(#)MakeCamp returning to within camp radius immediatelyMakeCamp returning to altcamp immediately.MakeCamp returning to altcamp immediately. Current camp now off.MakeCamp player ended due to player leaving/deathOutside of leash length, breaking from current command
1024	makecamp full verbosity Ended '/moveto' or '/makecamp return' because leash is on.
2048	circle verbosity Circling radius (#), center (#, #) off
4096	circle full verbosity none at this time
8192	settings Stick modifier changed to Mod(#) Mod%(# %) (from /stick mod #)Stick mod changed Mod(#) ModPercent (# %) (from stick inline -# or #%) Moveto distance mod changed to #. (from /moveto dist #) Option turned on (from /command set option on, or /command toggle option)Option turned off (from /command set option off, or /command toggle option)Option set to # (from /command set option #)
16384	file input / output Debug file created. Saved settings to C:\yourpath\MQ2MoveUtils.ini (from /command save)Loaded settings from C:\yourpath\MQ2MoveUtils.ini (from /command load)
32768	breakonwarp Stick pausing until target back in BreakDist range...Stick ending from target warping out of BreakDist range.
65536	breakonaggro BreakonAggro's: Aggro gained during /moveto, Halting command...
131072	breakonhit BreakonHit's: Aggro gained during /moveto, Halting command...
262144	breakonsummon WARNING Command ended from character summoned # distance in a pulse. WARNING Verify you are not being monitored and type /stick imsafe to allow command usage.
524288	breakongm WARNING Plugin halted from [GM] Name in zone. [GM] Name has left the zone or turned invisible. Use /stick imsafe to allow command usage.
1048576	breakongate Mob gating ended previous command.
2097152	stick always Stick awaiting next valid NPC target...
4194304	error messages (ERROR) /moveto or /circle command used with no parameter. (ERROR) Plugin was already paused. (ERROR) Plugin was not paused. (ERROR) /stick mod [#] supplied incorrectly. (ERROR) /moveto yloc [Y] was supplied incorrectly. (ERROR) /moveto xloc [X] was supplied incorrectly. (ERROR) SpawnID must be a positive numerical value. (ERROR) You cannot use yourself or your mount. (ERROR) You cannot stick hold to yourself. (ERROR) Incorrectly used /moveto dist [#] (ERROR) /makecamp [radius <dist>] was supplied incorrectly. (ERROR) You do not have an active camp. (ERROR) You cannot use this command with a player-camp active. (ERROR) You cannot use this command until you've established an altcamp location. (ERROR) Invalid player name and do not have a valid player target. (ERROR) You cannot makecamp yourself. (ERROR) Use /circle radius [#] to set radius.ERROR: Invalid 'option set' syntax ( option ) [on off number] ERROR: Not a valid command toggle ( option ). ERROR: Not a valid command set option ( option ). Error - Font must be between 1 and 10. ERROR: Invalid 'command set' parameter ( option )(ERROR) You cannot stick to yourself! You must specify something to stick to! (ERROR) /moveto loc [ <Y> <X> [z] ] was supplied incorrectly. (ERROR) /makecamp loc [ <Y> <X> ] was supplied incorrectly. (ERROR) Usage /circle loc [ <Y> <X> ] [other options] (ERROR) Invalid SpawnID and do not have a valid target. (ERROR) /makecamp [mindelay maxdelay] [#] was supplied incorrectly.
8388608	arc randomization Arcs Randomized! Max: # Min: #
16777216	pause / unpause PAUSED (from /command pause)RESUMED (from /command unpause)

See also

• MQ2AdvPath
• MQ2Nav

• Resource Overview
• Support
• Source Code

Top-Level Object(s)

TLOs added by MQ2MoveUtils:

TLO	Data Type(s)	Description
Circle	circle	Used to return information about the circle created with the /circle command
MakeCamp	makecamp	Used to return information about the camp created with the /MakeCamp command
MoveTo	moveto	Used to return information about the /moveto command.
MoveUtils	MoveUtils	Used to return information about plugin settings and general plugin information
Stick	stick	Used to return information about the /stick command and settings

Members. More may be available if inherited. Typical usage, /echo ${TLO.Member}

TLO	Data Type	Return Type	Member	Description
Circle	circle	bool	Backwards	Displays true if movement direction backwards.
			Clockwise	Displays false if reverse circling.
			Drunken	Displays true if drunken.
		float	CircleX	Location of circle center X.
			CircleY	Location of circle center Y.
			Radius	Radius size of circle.
		string	Direction	Movement direction of current circle.
			Rotation	Displays CCW if reverse circling.
			Status	Returns off / paused / on. On if circling.
			To string	Same as Status
MakeCamp	makecamp	bool	Leash	Displays true if leash is enabled.
			ReturnHaveTarget	Displays true if ReturnHaveTarget is enabled.
			Returning	Displays true if /makecamp return issued.
			ReturnNoAggro	Displays true if ReturnNoAggro is enabled.
			ReturnNotLooting	Displays true if ReturnNotLooting is enabled.
			Scatter	Displays true if camp scattering enabled.
		float	AltAnchorX	Location of current altcamp X anchor.
			AltAnchorY	Location of current altcamp Y anchor.
			AltCampDist	Distance to altcamp anchor from your current location. Returns 0.00 if altcamp not established.
			AltRadius	Size of altcamp radius.
			AnchorX	Location of current camp X anchor.
			AnchorY	Location of current camp Y anchor.
			Bearing	Bearing (heading) of camp scattering.
			CampDist	Distance to camp anchor from your current location. Returns 0.00 if camp is disabled.
			CampRadius	Size of camp radius.
			LeashLength	Size of Leash Length. (Greater than or equal to CampRadius)
			ScatDist	Distance from anchor to perform scatter.
			ScatSize	Size of scattering radius.
		int	MaxDelay	Displays the max delay for auto-returning to camp in ms. (125 or more greater than MinDelay)
			MinDelay	Displays the min delay for auto-returning to camp in ms. (125 or greater)
		string	Status	Displays status of MakeCamp command. AltCamp returns off.
			To string	Same as Status.
MoveTo	moveto	bool	Broken	Returns true if BreakonAggro or BreakonHit event have halted moveto prematurely.
			CampStopped	Displays true if within moveto distance of makecamp Y X location.
			Moving	Displays true if moveto or camp return is active.
			Stopped	Displays true if the last moveto command completed successfully.
			To string	Displays on if a moveto command is active.
			UseWalk	Returns true if UseWalk is enabled.
		float	ArrivalDist	Acceptable arrival distance.
			ArrivalDistX	Acceptable arrival distance for precisex.
			ArrivalDistY	Acceptable arrival distance for precisey.
MoveUtils	MoveUtils	bool	Aggro	Displays true if you are facing your target and your target is facing you.
			FullVerbosity	Displays true if fullverbosity is enabled.
			GM	Displays true if BreakonGM fired.
			MovePause	Displays true if mpause (PauseKB) is enabled.
			Stuck	Displays true if plugin stucklogic has determined you are currently stuck.
			StuckLogic	Displays true if stucklogic is enabled.
			Summoned	Displays true if BreakonSummon is enabled and has fired due to your character being summoned beyond breakonsummon distance.
			TotalSilence	Displays true if totalsilence is enabled.
			TryToJump	Displays true if stucklogic trytojump is enabled.
			Verbosity	Displays true if verbosity is enabled.
		float	DistStuck	Displays the amount of distance needed to have moved (compared against pulse average) or else considered stuck by stucklogic.
			Version	Displays the version number of the plugin.
		int	PauseMaxDelay	Displays the max delay for mousepause and mpause to resume command in ms.
			PauseMinDelay	Displays the min delay for mousepause and mpause to resume command in ms.
			PulseCheck	Displays the number of pulses used to average movement rate for stucklogic.
			PulseUnstuck	Displays the number of pulses successfully moved forward after being stuck to be considered unstuck.
		string	Command	Displays the currently active command. MAKECAMP returns if a camp is setup but no other command is currently in use.
			To string	Same as Command
Stick	stick	bool	Active	Displays true if any form of stick is active.
			Always	Returns true if /stick always is active.
			Behind	Displays true if currently behind target (regardless of /stick behind), false if outside of stick dist or not behind.
			Broken	Returns true if BreakonHit event has halted stick prematurely.
			Loose	Displays true if loose sticking is enabled.
			MoveBack	Displays true if moveback is active.
			MoveBehind	Displays true if stick behind is active.
			Paused	Displays true if plugin is paused.
			Pin	Displays true if stick pin is active.
			Stopped	Displays true if stick is within stick distance.
		float	Distance	Current distance used by stick.
			DistMod	Current stickdist modifier.
			DistModPercent	Current stickdist percent modifier.
		int	StickTarget	Returns spawnid of stick target if stick id/hold used, else spawnid of current target, 0 if no target and id/hold not used.
		string	Status	Displays on if any form of stick is active.
			StickTargetName	Returns DisplayedName of stick target if stick id/hold used, else current target or None if no target and hold/id not used.
			To string	Same as Status