MQ2MoveUtils \(old\)¶
Description¶
For updated plugin information see MQ2MoveUtils:v9. The information below applies to the 7.0518 and earlier versions of MQ2MoveUtils.
MQ2MoveUtils is a very popular plugin which assists with most aspects of moving around within EQ. It has been worked on by a number of developers over the years \(tonio, CyberTech, Quagmire and Outlander\). For the history of this plugin and development notes please see MQ2MoveUtils:History.
The old forum thread for MQ2MoveUtils can be found here, in the VIP forums. Source for the version 7.0 MQ2MoveUtils is available.
Features¶
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¶
/stick¶
- /stick
Turn stick on and off. The default for /stick is to stick at max melee range.
- /stick
Sticks to current target even if you lose/change target
- /stick []
Stick at units to your target
- /stick
Subtract the dist used from the current stick distance \(ie. it will put you units closer to your target\)
- /stick
Stick at of max melee range from target. Eg. if max melee range is 20, then /stick 50% will stick you at 10 range
- /stick
Sticks you behind your target.
*Note: Be careful with this option if you do not have the Health of Target's Target Leadership Ability. If you have HoTT active and you are the Target of your Target, then you will not try to get behind. However if you do not have this ability and you gain aggro, you will spin around very quickly as you try and get behind your target while it continues to face you.*
- /stick
Get behind the target once then convert to a regular stick
- /stick
Sticks you to the side of the target, same considerations as /stick behind apply
- /stick
Sticks you anywhere but in front of the target, will only reposition you if you would be in front. Same considerations apply to this as the "behind" and "pin" options
- /stick
Moveback will back your toon up to the current value, keeping you at a consistant distance from your target
- /stick
Uses a time delay so adjustments to your position do not occur as frequently, simulating a more human-like control
- /stick
This changes the facing of your toon, and is very useful under water, where you will try and follow the Z coordinate of the spawn you are facing
- /stick
Allows you to stick to a specific spawn ID
- /stick
By enabling mpause, manually moving your toon will not break stick and will rather put it on hold. When you are done manually moving, the /stick command will once again kick in and you will continue following the same target as before
- /stick
Pause and unpause the stick command
- /stick
Some settings are stored in the INI file. This allows you to save your current preferences to the INI file, or load the saved preferences this file
- /stick
When used with /stick this delay is used when mpause is enabled to decide the smallest value to use to resume the /stick command after a manual move
- /stick
When used with /stick this delay is used when mpause is enabled to decide the largest value to use to resume the /stick command after a manual move
/moveto¶
- /moveto
Moves you to the specified location, or stops the current /moveto \(by using "/moveto off"\)
- /moveto []
Sets the maximum distance from your moveto point that you consider acceptable. This option is here because it's not always possible to move to the exact point that you specify, so the plugin will move you to within units of the moveto point before stopping. Eg. if you use "/moveto 5", you will always move to within 5 units from your moveto point
- /moveto
Subtract from the current moveto distance
- /moveto
By enabling mpause, manually moving your toon will not break moveto and will rather put it on hold. When you are done manually moving, the /moveto command will once again kick in and you will continue moving to your moveto point
- /moveto
Pause and unpause the moveto command
- /moveto ID
Moves to the specified Spawn ID or moves to your current target if no Spawn ID is provided
- /moveto
When used with /moveto this delay is used when mpause is enabled to decide the smallest value to use to resume the /moveto command after a manual move.
- /moveto
When used with /moveto this delay is used when mpause is enabled to decide the largest value to use to resume the /moveto command after a manual move.
- /moveto
Save or load the moveto settings
/makecamp¶
- /makecamp
Turns MakeCamp logic off or turns it on, using your current location as the anchor point
- /makecamp
Turns MakeCamp logic on using the supplied Y,X location as the camp anchor point
- /makecamp
If outside the MakeCamp radius this is the minimum delay used before returning to a point within the camp radius
- /makecamp
If outside the MakeCamp radius this is the maxium delay used before returning to a point within the camp radius
- /makecamp
Toggle the leash logic on and off. Leash is the maximum distance away from your camp anchor your toon will be allowed to go using another MQ2MoveUtils command such as /stick
- /makecamp
Turns leash logic ON and sets the leash length
- /makecamp
Sets the camp radius. This is the maximum distance you can be from the anchor point and still be considered "in camp"
- /makecamp
By enabling mpause, manually moving your toon will not break makecamp and will rather put it on hold. When you are done manually moving, the /makecamp command will once again kick
- /makecamp
Pause and unpause the MQ2MoveUtils makecamp functionality
- /makecamp
Returns your toon to the camp immediatly
- /makecamp
Save or load the makecamp settings
/circle¶
- /circle
Sets the anchor point to your current location, and uses the currently set radius
- /circle
Sets the anchor point to your current location, and uses the specified
- /circle
Sets Y,X anchor point around which to circle
- /circle
By enabling mpause manually moving your toon will not break the circle but will instead put it on hold, when you get done manually moving the toon the /circle command will once again kick in.
- /circle
Pause and unpause the /circle command
- /circle
Does not move in a perfect circle but instead the circle is more human-like
- /circle
When used with /circle this delay is used when mpause is enabled to decide the smallest value to use to resume the /stick command after a manual move.
- /circle
When used with /circle this delay is used when mpause is enabled to decide the largest value to use to resume the /stick command after a manual move.
- /circle
Save or load the circle settings from the INI file
Top-Level Objects¶
Stick¶
- string ${Stick}
Same as ${Stick.Status} \(see below\).
- string ${Stick.Status}
Return ON if currently sticking, OFF if not, or PAUSED if it is paused
- bool ${Stick.Active}
Returns TRUE if currently sticking, FALSE if not
- bool ${Stick.Behind}
Returns TRUE if behind target
- float ${Stick.Distance}
The current stick distance
- bool ${Stick.Loose}
Returns TRUE if stick loose is set
- bool ${Stick.MoveBack}
Returns TRUE if stick is set to moveback
- bool ${Stick.MoveBehind}
Returns TRUE if stick is set to move behind the target
- bool ${Stick.MovePause}
Returns TRUE if stick movement is paused due to manual intervention
- bool ${Stick.Paused}
Returns TRUE if stick has been paused with "/stick pause"
- bool ${Stick.Pin}
Returns TRUE if /stick pin is being used
- bool ${Stick.Stopped}
Returns TRUE if you are stationary
MoveTo¶
- string ${MoveTo}
Return ON if currently moving to a location, OFF if not, or PAUSED if it is paused
- bool ${MoveTo.Moving}
Returns TRUE if moving to location, FALSE if not
- bool ${MoveTo.Stopped}
Returns TRUE if stopped, FALSE if not
MakeCamp¶
- string ${MakeCamp}
Same as ${MakeCamp.Status} \(see below\).
- string ${MakeCamp.Status}
Return ON if MakeCamp is enabled, OFF if it is not enabled or PAUSED if it is paused
- float ${MakeCamp.AnchorX}
The X Loc of the anchor point
- float ${MakeCamp.AnchorY}
The Y Loc of the anchor point
- float ${MakeCamp.CampRadius}
The current camp radius
- bool ${MakeCamp.Leash}
Returns TRUE if the leash is enabled, FALSE if not
- float ${MakeCamp.LeashLength}
The length of the leash
- int ${MakeCamp.MaxDelay}
The maximum delay before resuming /makecamp functionality after manual intervention
- int ${MakeCamp.MinDelay}
The minimum delay before resuming /makecamp functionality after manual intervention
- bool ${MakeCamp.Returning}
Returns TRUE if returning to camp, FALSE if not
INI File¶
A default INI file is created \(if it doesn't exist\) when you issue one of the "save" commands \(eg. /stick save, /moveto save, etc\).
The section contains global defaults for all users. New sections can be added with character names as titles to override the default values. An example INI file is below, with explanations of the options underneath:
[Defaults]
AutoPause=on
BreakOnWarp=on
BreakDist=250.0
BreakOnGate=on
Verbosity=1
ManualPause=on
MinDelay=500
MaxDelay=5000
CampRadius=0.0
LeashLength=0.0
StuckLogic=on
stuckCheck=5
stuckDist=0.1
- AutoPause
This enables or disables the automatic pause on cast feature. This does not apply to bards, since they can move while singing.
- BreakOnWarp
With BreakOnWarp on, any movement will be terminated if the target moves too far away. See BreakDist to set the distance.
- BreakDist
This sets how far away the target has to be before it will be considered too far away to continue following.
- BreakOnGate
This enables/disables monitoring chat for "TargetName Gates". Movement will be terminated if it determines that the target has gated.
- ManualPause
Stores your preference for the mPause functionality built into the various commands.
- MinDelay and MaxDelay
Stores your preference for the resuming after manual move. These values are also used to return to camp at the end of a /stick or /moveto command when using /makecamp.
- CampRadius
This is the default value used for /makecamp radius.
- LeashLength
This is the default value used for /makecamp leash length
- StuckLogic
Enable or disable the logic used to determine if you are stuck behind an object when using /stick or /moveto.
- stickCheck
The number of pulses that are averaged out to come up with the stuckDist comparison number.
- stuckDist
This is the average distance covered during the the last stickCheck pulses to use as a comparison. Eg. if you normally would average .5 distance units covered in a 5 pulse period, then if your average drops down to .1 moved in the last 5 pulses then you are probably stuck and the stuck logic should kick in.
Troubleshooting¶
- You can see a list of options for each of the commands by typing the command and then "help". Eg. /stick help,
/moveto help, etc.