Collapse All | Expand All

Movement Helpers

Version 3, last updated by anything at 2014-07-01

Movement helpers are for those situations where HB's navigation system can't work out how to get into or out of somewhere.

In a perfect world HB would be able to navigate everywhere without any help, and these wouldn't be needed. If only.


Example Movement helper File:

The following is the movement helper file used for entering Booty Bay without flying, via the tunnel.

<MovementHelper description="Booty Bay - Run through tunnel to access town" conditions="!Styx.Pathing.Flightor.CanFly">
	<InsideAreaPoints><!-- some hotspots within bootybay -->
		<!-- if we're trying to get to / from where within range of these points -->
		<Hotspot X="-14288.01" Y="549.4885" Z="8.6893" range="50" />
		<Hotspot X="-14316.64" Y="485.5213" Z="8.596956" range="50" />
		<Hotspot X="-14356.49" Y="434.4244" Z="7.359185" range="50" />
		<Hotspot X="-14405.86" Y="423.857" Z="8.554531" range="50" />
		<Hotspot X="-14446.01" Y="470.7079" Z="15.27298" range="50" />
		<Hotspot X="-14419.98" Y="518.7646" Z="5.00143" range="50" />
		<Hotspot X="-14452.3" Y="421.3456" Z="25.07514" range="50" />
		<Hotspot X="-14475.89" Y="465.9152" Z="30.77339" range="50" />
	</InsideAreaPoints>
	<OutsideToInsidePath><!-- from outside into booty bay -->
		<!-- then use these points -->
		<Hotspot X="-14245.46" Y="326.3994" Z="24.57152" />
		<Hotspot X="-14270.04" Y="350.2698" Z="32.68127" />
		<Hotspot X="-14279.59" Y="385.3638" Z="35.81862" />
		<Hotspot X="-14272.68" Y="412.0435" Z="37.07082" />
		<Hotspot X="-14286.64" Y="432.5653" Z="33.49641" />
		<Hotspot X="-14316.96" Y="443.1125" Z="23.02874" />
	</OutsideToInsidePath>
</MovementHelper>


Complete Movement Helper File:

<MovementHelper description="..." conditions="...">
	<InsideAreaPoints>
		<Hotspot X="..." Y="..." Z="..." range=".." />
		<Hotspot X="..." Y="..." Z="..." range=".." />
	</InsideAreaPoints>
	<OutsideAreaPoints>
		<Hotspot X="..." Y="..." Z="..." range=".." />
		<Hotspot X="..." Y="..." Z="..." range=".." />
	</OutsideAreaPoints>
	<OutsideToInsidePath>
		<Hotspot X="..." Y="..." Z="..." />
                <QueueItem ID="..." type="..." />
                ...
                <Hotspot X="..." Y="..." Z="..." />
		<QueueItem ID="..." type="..." />
	</OutsideToInsidePath>
	<InsideToOutsidePath>
		<Hotspot X="..." Y="..." Z="..." />
                <QueueItem ID="..." type="..." />
                ...
                <Hotspot X="..." Y="..." Z="..." />
		<QueueItem ID="..." type="..." />
	</InsideToOutsidePath>
</MovementHelper>

<MovementHelper>
description optional
(recommended)		 A description of this movement helper's purpose for logging & display purposes only
conditions optional Conditions in which this helper may be used.
Must be blank, or evaluate to be true before this helper is considered.
<InsideAreaPoints>
<OutsideAreaPoints>		 Required
Optional
Hotspot Required These hotspots (note that they include a range attribute also) specify the area that this movement helper is related to.
InsideAreaPoints are required - if we're attempting to move to any area within range of these hotspots, then this helper will be used.
OutsideAreaPoints are optional - in addition to InsideAreaPoints, we must be moving from a location in the OutsideAreaPoints area before this helper is used.
If OutsideAreaPoints is not provided it is assumed that anywhere in the world outside of the InsideAreaPoints is ok.
<OutsideToInsidePath>
<InsideToOutsidepath>		 Optional
Optional
Hotspot Optional
(recommended)		 These Hotspots represent the path to be taken to move from outside to inside the movement helper's area (or vice versa).
They are followed one by one in order. You should add as many hotspots as necessary.
If InsideToOutside is not provided then OutsideToInside is used, but in reverse order instead. Same goes for the opposite case.
QueueItem Optional Alternative to Hotspots you can create raw queue items instead.
An example is to allow the movement helper to click a portal crystal midway through the path.
See the RawQueueCreator behavior handler for more info on the QueueItem format.

Comments are disabled for this space. In order to enable comments, Messages tool must be added to project.

You can add Messages tool from Tools section on the Admin tab.