MQ2MoveUtils:v9

From MacroQuest Wiki

Contents 1 General Details 1.1 Links 1.2 Development Notes 1.3 Help 2 Command Information 2.1 Main Plugin Commands 2.2 Main Plugin Settings 2.3 /stick 2.4 /moveto 2.5 /circle 2.6 /makecamp 3 Top-Level Objects 3.1 ${MoveUtils} 3.2 ${Stick} 3.3 ${MoveTo} 3.4 ${MakeCamp} 3.5 ${Circle} 4 Configuration 4.1 Default INI File 4.2 INI options 4.2.1 [Defaults] 4.2.2 [Stick] 4.2.3 [MakeCamp] 4.2.4 [MoveTo] 4.2.5 [Circle] 4.2.6 [StuckLogic] 4.2.7 [yourserver.yourcharacter] 4.3 Verbosity 4.3.1 Flags Table 4.3.2 Actual Messages 5 See Also

General Details

Version 9 of MQ2MoveUtils was a rewrite from the ground up by pms. The original goal behind this rewrite was to cleanup numerous logical errors and reduce the amount of code duplication that existed in previous releases. Once this rewrite was complete and functional, version 9 expanded including more enhancements and more extensive configuration.

Links

• Link to current source: MQ2MoveUtils v9.x Source
• Link to current discussion thread: MQ2MoveUtils v9.x Thread

Development Notes

For the development history of this plugin see the article MQ2MoveUtils 9.x Revision History

Help

• Frequently Asked Questions
• Configuration Examples

Command Information

Main Plugin Commands

These 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.

• /stick help [settings]
  • Displays generic help information, and help for the command used
  • The settings optional parameter displays help information for all plugin 'set' and 'toggle' commands

• /stick debug
  • Dumps the current values of all plugin variables to a debug INI file

• /stick status [all]
  • ChatWnd output for the status of the issuing command (stick in this example)
  • The all optional parameter displays status output for all aspects of the plugin

• /stick pause | unpause
  • Pauses or resumes all aspects of the plugin
  • Note: These do not toggle

• /stick save | load
  • Saves or load your current configuration settings to MQ2MoveUtils.ini

• /stick imsafe
  • BreakOnSummon has built-in protection disabling the ability to re-issue commands when triggered. This prevents macros from continuing to issue commands in a possibly unsafe situation
  • The imsafe parameter allows command usage to resume

Main Plugin Settings

These setting parameters can be used from any of the four main plugin commands.
The following can be used with toggle or set name on | off.

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

name can be one of the following:

• 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

• 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

• 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

• hidehelp
  • If enabled, the help output will not be displayed upon command failure (e.g. invalid parameters)

• 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

• 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

• 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

• breakonhit
  • 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

• breakonaggro
  • Breaks from moveto command if you are aggro to an NPC
  • Note: This checks the player window for the crossed swords indicator

• 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 above to unlock the plugin

• alwaysdrunk
  • Use drunken by default when circling

• alwaysbackwards
  • Run backwards by default when circling

• alwaysccw
  • Circle in a counter-clockwise direction by default

• alwaystruehead
  • Always use truehead style heading adjustments

• truehead
  • Active command switches truehead style heading adjustments on|off

• 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

• returnnoaggro
  • Makecamp will auto-return to camp only if not aggro (checks crossed swords indicator)

• 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

• returnnotlooting
  • Makecamp will not auto-return to camp if character has an open loot corpse window

• 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

• 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

• 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

• autoUW
  • If enabled, stick and moveto will use the uw parameter whenever underwater (look up and down at target)

• useback
  • 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

The following 'set' commands require a numeric value, and can be used from any of the four main plugin commands.

/stick [set] [pulsecheck] [#] - sets number of pulses used to calculate average movement distance in stucklogic (1+)
/stick [set] [pulseunstuck] [#] - sets number of pulses successfully moved forward before considered unstuck (1+)
/stick [set] [diststuck] [#.##] - ts minimum distance needed to move or else considered stuck (compares against pulse average, 0.01+)
/stick [set] [campmindelay] [#] - sets minimum delay before auto-returning to camp (in ms, 125+)
/stick [set] [campmaxdelay] [#] - sets maximum delay before auto-returning to camp (in ms, 125 more than min)
/stick [set] [pausemindelay] [#] - sets minimum delay before resuming from mpause/mousepause (in ms, 125+)
/stick [set] [pausemaxdelay] [#] - sets maximum delay before resuming from mpause/mousepause (in ms, 125 more than min))
/stick [set] [ydist] [#.##] - sets acceptable distance to have "arrived" for precisey moveto (1.0+)
/stick [set] [xdist] [#.##] - sets acceptable distance to have "arrived" for precisex moveto (1.0+)
/stick [set] [turnrate] [#.#] - sets rate at which loose heading turns (12.0 to 24.0)
/stick [set] [breakdist] [#.##] - sets distance to check for breakonwarp (1.0+)
/stick [set] [campradius] [#.##] - sets default camp radius and radius for active camp (10.0+)
/stick [set] [circleradius] [#.##] - sets default circle radius and radius for active circle (5.0+)
/stick [set] [leashlength] [#.##] - sets default leash length and length for active leash (greater or equal to camp radius)
/stick [set] [bearing] [#.##] - sets bearing (direction from center) used for scatter camp
/stick [set] [scatsize] [#.##] - sets radius size for scattering (1.0+)
/stick [set] [scatdist] [#.##] - sets distance from center of camp to scatter at (1.0+)

The following are command-specific, use the command in the example only

/stick [toggle|set] [alwaysloose] [on|off] - always use loose stick
/stick [toggle|set] [loose] [on|off] - adjust loose movement for current stick
/moveto [toggle|set] [alwaysloose] [on|off] - always use loose moveto
/moveto [toggle|set] [loose] [on|off] - adjust loose movement for current moveto
/moveto [set] [dist] [#.##] - sets acceptable distance to have "arrived" for standard moveto

/stick

The stick command sticks you to your target, so that if your target moves you will move along with it. There are many different parameters that cause this command to behave in different ways.

/stick - stick with no parameters will stick you to your current target, using max melee range
/stick [on|off] - turns stick on and off with default values
/stick [id <#>] - sticks to the given spawn id or your current target if no spawn id is given. this allows you to continue sticking when your target changes
/stick [<#>%] - modify stick distance by the supplied percentage
/stick [-<dist>] - decrease stick distance by the supplied amount
/stick [<dist>] - stick at the supplied distance
/stick [moveback] - stick will back up to the <dist> value if the target gets closer
/stick [loose] - stick using more human-like movement
/stick [uw|underwater] - face angle will look up/down at the stick target
/stick [hold] - stick to the current target even if your target changes
/stick [behind] - stick to the rear of the target unless you are on HoTT. will spin in circles if you do not have HoTT and gain aggro
/stick [behindonce] - stick behind the target when first used, only using <dist> enforcement after that
/stick [!front] - stick to target anywhere but the frontal arc, same considerations as behind apply
/stick [pin] - stick to the side of the target, same consideration as behind apply
/stick [front] - stick to the front arc of the target. if you have HoTT and lose aggro you will not spin. this will not work by default without HoTT
/stick [(any value above)] [always] - when current target is lost, will resume sticking using supplied values upon next NPC targeted
/stick [snaproll <left|right|face>] - runs in a straight line behind your target then turns to face. left/right/front of target if other direction supplied after
/stick [mod <#>|<-#>] - modify stick distance by the supplied amount (does not turn stick on)

/moveto

The moveto command will move you from your current location to a specific location or target.

/moveto [id <#>]- moves to the supplied spawn id, or your current target if no id is given
/moveto [loc <Y> <X>] - moves to the specified location
/moveto [yloc|xloc <Y|X>] - beeline to the Y or X supplied - different from precisey/x
/moveto [off] - stop moving to the current target/location
/moveto [loose] - moveto using more human-like movement
/moveto [id <#>|loc <Y> <X>] [loose] - moves to target/specified location using more human-like movement
/moveto [id|loc <Y> <X>] [precisey|precisex] - moves to loc stopping when within x or y arrival dist values instead of both
/moveto [dist <#>] - sets value for how close to actual location is considered arrival (does not turn moveto on)

/circle

The circle command spins you in a circle. If you are like me, looking at this for the first time wondering what the point is, this is mainly for bards to use while circle kiting, but could equally be used for amusement.

/circle [on|off] - begin circling using your current location as the center with default radius | stop circling
/circle [on <#>] - begin circling using your current location as the center, with # as radius size
/circle [loc <Y> <X>] - begin circling using the specified location as the center
/circle [on|loc <Y> <X>] [drunken] - turn to complete the circle at random intervals
/circle [on|loc <Y> <X>] [clockwise|cw] - circle in a clockwise direction. default
/circle [on|loc <Y> <X>] [ccw|counterclockwise|reverse] - circle in a counter-clockwise direction
/circle [radius <#>] - sets the default size of the circle radius
/circle [drunken] - turns at random intervals
/circle [ccw|reverse] - circles counter-clockwise instead of clockwise
/circle [backwards] - runs backwards instead of forwards

/makecamp

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.

/makecamp - using makecamp with no parameters will set up a camp at your current location, using default values
/makecamp [on|off] - set up a camp at current location with default values | disable current camp
/makecamp [on <#>] - setup a camp at current location using '#' as camp radius size
/makecamp [loc <Y> <X>] - set up a camp at the specified location
/makecamp [player <name>] - set up a dynamic camp based on a certain pc name if in zone, or targeted pc if name not supplied
/makecamp [leash] - toggles leashing to camp radius so you cannot leave boundry
/makecamp [leash <#>] - sets how far beyond camp radius you can move before leashing
/makecamp [radius <#>] - sets the radius of the camp size, does not turn camp on if supplied on its own
/makecamp [mindelay|maxdelay <#>] - sets the delay time before auto-returning to camp
/makecamp [return] - returns to the camp immediately
/makecamp [altreturn] - returns to the camp spot you had before your current one, or a camp that is now off

Top-Level Objects

${MoveUtils}

Members of this datatype relate to plugin settings and generic information

Member Name	Return Values	Description
string - Command	NONE STICK MOVETO MAKECAMP CIRCLE	Displays the currently active command. MAKECAMP returns if a camp is setup but no other command is currently in use
bool - Stuck	TRUE FALSE	Displays true if plugin stucklogic has determined you are currently stuck
bool - Summoned	TRUE FALSE	Displays true if BreakOnSummon is enabled and has fired due to your character being summoned beyond breakonsummon distance
bool - StuckLogic	TRUE FALSE	Displays true if stucklogic is enabled
bool - Verbosity	TRUE FALSE	Displays true if verbosity is enabled
bool - FullVerbosity	TRUE FALSE	Displays true if fullverbosity is enabled
bool - TotalSilence	TRUE FALSE	Displays true if totalsilence is enabled
bool - Aggro	TRUE FALSE	Displays true if you are facing your target and your target is facing you
bool - TryToJump	TRUE FALSE	Displays true if stucklogic trytojump is enabled
int - PauseMinDelay	125 or greater	Displays the min delay for mousepause and mpause to resume command in ms
int - PauseMaxDelay	125 or more greater than PauseMinDelay	Displays the max delay for mousepause and mpause to resume command in ms
int - PulseCheck	1 or greater	Displays the number of pulses used to average movement rate for stucklogic
int - PulseUnstuck	1 or greater	Displays the number of pulses successfully moved forward after being stuck to be considered unstuck
float - DistStuck	0.01 or greater	Displays the amount of distance needed to have moved (compared against pulse average) or else considered stuck by stucklogic
float - Version	9.####	Displays the version number of the plugin
To String	Same as Command	Same as Command

${Stick}

Members of this datatype relate to the '/stick' command

Member Name	Return Values	Description
string - Status	OFF PAUSED ON	Displays ON if any form of stick is active
bool - Active	TRUE FALSE	Displays true if any form of stick is active
float - Distance	#.##	Current distance used by stick
bool - MoveBehind	TRUE FALSE	Displays true if stick behind is active
bool - MovePause	TRUE FALSE	Displays true if mpause is enabled
bool - MoveBack	TRUE FALSE	Displays true if moveback is active
bool - Loose	TRUE FALSE	Displays true if loose sticking is enabled
bool - Paused	TRUE FALSE	Displays true if plugin is paused
bool - Behind	TRUE FALSE	Displays true if currently behind target (regardless of /stick behind), false if outside of stick dist or not behind
bool - Stopped	TRUE FALSE	Displays true if stick is within stick distance
bool - Pin	TRUE FALSE	Displays true if stick pin is active
int - StickTarget	SpawnID	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 - StickTargetName	NONE DisplayedName	Returns DisplayedName of stick target if stick id/hold used, else current target or NONE if no target and hold/id not used
float - DistMod	[-]#.##	Current stickdist modifier
float - DistModPercent	#.##	Current stickdist percent modifier
bool - Always	TRUE FALSE	Returns true if /stick always is active
To String	Same as Status	Same as Status

${MoveTo}

Members of this datatype relate to the '/moveto' command

Member Name	Return Values	Description
bool - Moving	TRUE FALSE	Displays true if moveto or camp return is active
bool - Stopped	TRUE FALSE	Displays true if the last moveto command completed successfully
bool - UseWalk	TRUE FALSE	Returns true if UseWalk is enabled
float - ArrivalDist	1.00+	Acceptable arrival distance
float - ArrivalDistY	1.00+	Acceptable arrival distance for precisey
float - ArrivalDistX	1.00+	Acceptable arrival distance for precisex
To String	OFF PAUSED ON	Displays ON if a moveto command is active

${MakeCamp}

Members of this datatype relate to the '/makecamp' command

Member Name	Return Values	Description
string - Status	OFF PAUSED ON	Displays status of MakeCamp command. AltCamp returns OFF
bool - Leash	TRUE FALSE	Displays true if leash is enabled
float - AnchorX	0.00	Location of current camp X anchor
float - AnchorY	0.00	Location of current camp Y anchor
float - LeashLength	Greater than or equal to CampRadius	Size of Leash Length
float - CampRadius	10.0+	Size of camp radius
int - MinDelay	125 or greater	Displays the min delay for auto-returning to camp in ms
int - MaxDelay	125 or more greater than MinDelay	Displays the max delay for auto-returning to camp in ms
bool - Returning	TRUE FALSE	Displays true if /makecamp return issued
float - AltAnchorX	0.00	Location of current altcamp X anchor
float - AltAnchorY	0.00	Location of current altcamp Y anchor
float - CampDist	0.00	Distance to camp anchor from your current location. Returns 0.00 if camp is disabled
float - AltCampDist	0.00	Distance to altcamp anchor from your current location. Returns 0.00 if altcamp not established
float - AltRadius	10.0+	Size of altcamp radius
bool - Scatter	TRUE FALSE	Displays true if camp scattering enabled
bool - ReturnNoAggro	TRUE FALSE	Displays true if ReturnNoAggro is enabled
bool - ReturnNotLooting	TRUE FALSE	Displays true if ReturnNotLooting is enabled
bool - ReturnNoTarget	TRUE FALSE	Displays true if ReturnNoTarget is enabled
float - Bearing	0.00	Bearing (heading) of camp scattering
float - ScatDist	1.0+	Distance from anchor to perform scatter
float - ScatSize	1.0+	Size of scattering radius
To String	Same as Status	Same as Status

${Circle}

Members of this datatype relate to the '/circle' command

Member Name	Return Values	Description
string - Status	OFF PAUSED ON	Returns ON if circling
float - CircleY	0.00	Location of circle center Y
float - CircleX	0.00	Location of circle center X
bool - Drunken	TRUE FALSE	Displays true if drunken
string - Rotation	CW CCW	Displays CCW if reverse circling
string - Direction	FORWARDS BACKWARDS	Movement direction of current circle
bool - Clockwise	TRUE FALSE	Displays false if reverse circling
bool - Backwards	TRUE FALSE	Displays true if movement direction backwards
To String	Same as Status	Same as Status

Configuration

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

Default INI File

[Defaults]
AutoPause=on
AutoSave=on
BreakKeyboard=on
BreakMouse=off
BreakOnSummon=off
BreakSummonDist=8.00
FeignSupport=off
HideHelp=off
KeyboardPause=off
MousePause=off
PauseMinDelay=500
PauseMaxDelay=5000
SaveByChar=on
TurnRate=14.00
Verbosity=on
FullVerbosity=on
TotalSilence=off
[Stick]
AwareAggro=off
AwareNotAggro=off
BreakDist=250.00
BreakOnGate=on
BreakOnWarp=on
LooseStick=on
StickDistMod=0.00
StickDistModPercent=1.00
[MakeCamp]
CampRadius=40.00
MinDelay=500
MaxDelay=1500
ReturnNoAggro=off
ReturnNoTarget=off
ReturnNotLooting=off
UseLeash=off
LeashLength=50.00
UseScatter=off
Bearing=0.00
ScatDist=10.00
ScatSize=10.00
[MoveTo]
ArrivalDist=5.00
ArrivalDistX=5.00
ArrivalDistY=5.00
LooseMoveTo=on
MoveToMod=0.00
UseWalk=on
[Circle]
AlwaysBackwards=off
AlwaysCounterClockwise=off
AlwaysDrunken=off
RadiusSize=30.00
[StuckLogic]
StuckLogic=on
DistStuck=0.20
PulseCheck=6
PulseUnstuck=8
TryToJump=on
TurnHalf=on
[yourserver.yourcharacter]
AutoSave=on
BreakDist=250.00
BreakOnGate=on
BreakOnWarp=on
FeignSupport=off
LeashLength=50.00
UseLeash=off
Verbosity=on
FullVerbosity=on
CampRadius=40.00
UseScatter=off
Bearing=0.00
ScatDist=10.00
ScatSize=10.00

INI options

[Defaults]

This section is for default plugin settings

• AutoPause= - on or off, pauses command if casting spells, stunned, rooted, sitting, or self targeted
• AutoSave= - on or off, automatically save ini file when using 'toggle' or 'set'
• BreakKeyboard= - on or off, break command from keyboard press
• BreakMouse= - on or off, break command from mouselook usage
• BreakOnSummon= - on or off, halt command and ability to use commands if summoned beyond certain distance
• BreakSummonDist= - 1.0+, distance moved in a single pulse to trigger breakonsummon (if on)
• FeignSupport= - on or off, fd support waits for you to stand up manually before moving, if feigned
• HideHelp= - on or off, never automatically display help output unless requested
• KeyboardPause= - on or off, pause command for a delay if keyboard press
• MousePause= - on or 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 or off, save CharName section of ini file for individual character settings
• TurnRate= - 12.0 to 24.0, rate at which loose heading turns
• Verbosity= - on or off, ChatWnd output for basic command info
• FullVerbosity= - on or off, ChatWnd output for enhanced plugin info
• TotalSilence= - on or off overrides verb/fullverb, silence ChatWnd output except for critical or user-requested messages

[Stick]

This section is for settings related to /stick

• AwareAggro= - on or off experimental, detect aggro if using stick pin/!front/behind and attempt to not spin in circles
• AwareNotAggro= - on or off, detect aggro loss if using stick front
• BreakDist= - 1.0+, distance mob moved in a single pulse to trigger breakonwarp (if on)
• BreakOnGate= - on or off, break from stick if "target Gates." message occurs
• BreakOnWarp= - on or off, break from stick if target warps beyond certain distance
• LooseStick= - on or off, always use loose heading changes for stick
• StickDistMod= - #, adjust default/supplied stick distance by this amount
• StickDistModPercent= - %, adjust default/supplied stick distance by this percent

[MakeCamp]

This section is for settings related to /makecamp

• CampRadius= - 10.0+, default camp radius size
• MinDelay= - 125+ (in ms), minimum delay before auto-returning to camp
• MaxDelay= - 125 above min (in ms), maximum delay before auto-returning to camp
• ReturnNoAggro= - on or off, Auto-Return to camp only if not aggro
• ReturnNoTarget= - on or off, if on Auto-Return to camp even if you have a target
• ReturnNotLooting= - on or off, dont Auto-Return to camp if looting a corpse
• UseLeash= - on or off, dont allow character to move beyond leashlength
• LeashLength= - >= camp radius, length of leash
• UseScatter= - on or off, use specific scatter values instead of random return location
• Bearing= - #, bearing of scatter
• ScatDist= - 1.0+, distance from camp center to perform scatter
• ScatSize= - 1.0+, radius size of scatter area

[MoveTo]

This section is for settings related to /moveto

• 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
• LooseMoveTo= - on or off, always use loose heading changes for moveto
• MoveToMod= - #, modifier applied to moveto arrivaldist
• UseWalk= - on or off, turn on walk when close to moveto location and camp return spot

[Circle]

This section is for settings related to /circle

• AlwaysBackwards= - on or off, always run backwards instead of forwards when circling
• AlwaysCounterClockwise= - on or off, always run in a ccw circle instead of default clockwise
• AlwaysDrunken= - on or off, always use drunken circling
• RadiusSize= - 5.0+, default radius size of circle

[StuckLogic]

This section is for settings related to stucklogic

• StuckLogic= - on or off, if 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 or off, attempt to jump to help get unstuck
• TurnHalf= - on or off, if have turned halfway and failed to get unstuck, reset heading and try other direction instead

[yourserver.yourcharacter]

if savebychar is on, this section will be created for every character The settings in this section are some of the above values that could be desired to vary on a char-by-char basis

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

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

Actual Messages

Here is a list of exactly what messages are tied to each flag:

• 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 immediately

  MakeCamp returning to altcamp immediately.

  MakeCamp returning to altcamp immediately. Current camp now OFF.

  MakeCamp player ended due to player leaving/death

  Outside 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

• MQ2MoveUtils 9.0 Revision History
• MQ2MoveUtils Older Versions
• MQ2MoveUtils History
• MacroQuest2 Plugins
• Top-Level Objects
• Data Types