MUDTracker

java.lang.Object
- com.planet_ink.coffee_mud.Libraries.StdLibrary
- - com.planet_ink.coffee_mud.Libraries.MUDTracker

All Implemented Interfaces:

CMObject, Tickable, CMLibrary, TrackingLibrary, java.lang.Cloneable, java.lang.Comparable<CMObject>
```
public class MUDTracker
extends StdLibrary
implements TrackingLibrary
```

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`protected static class`	`MUDTracker.DefaultRFilters`
`protected static class`	`MUDTracker.DefaultTrackingFlags`
`protected static class`	`MUDTracker.RFilterNode`

Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.TrackingLibrary
TrackingLibrary.RFilter, TrackingLibrary.RFilters, TrackingLibrary.TrackingFlag, TrackingLibrary.TrackingFlags, TrackingLibrary.TrailFlag

Field Summary

Fields
Modifier and Type	Field	Description
`protected java.util.Map<java.lang.Integer,java.util.List<java.lang.String>>`	`closeCommandSets`
`protected java.util.Map<java.lang.Integer,java.util.List<java.lang.String>>`	`directionCommandSets`
`protected static TrackingLibrary.RFilters`	`EMPTY_FILTERS`
`protected static TrackingLibrary.TrackingFlags`	`EMPTY_FLAGS`
`protected TrackingLibrary.RFilters`	`emptyFilter`
`protected java.util.Map<java.lang.Integer,java.util.List<java.lang.String>>`	`openCommandSets`
`protected java.util.Map<TrackingLibrary.TrackingFlags,TrackingLibrary.RFilters>`	`trackingFilters`
`protected TrackingLibrary.RFilter`	`validIDFilter`

Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject
idConverter

Fields inherited from class com.planet_ink.coffee_mud.Libraries.StdLibrary
isDebugging, name, serviceClient, tickStatus

Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.Tickable
STATUS_AFFECT, STATUS_ALIVE, STATUS_BEHAVIOR, STATUS_CLASS, STATUS_DEAD, STATUS_END, STATUS_FIGHT, STATUS_MISC, STATUS_MISC2, STATUS_MISC3, STATUS_MISC4, STATUS_MISC5, STATUS_MISC6, STATUS_MISC7, STATUS_NOT, STATUS_OTHER, STATUS_RACE, STATUS_REBIRTH, STATUS_SCRIPT, STATUS_START, STATUS_WEATHER, TICKID_AREA, TICKID_BALLISTICK, TICKID_CLAN, TICKID_CLANITEM, TICKID_DEADBODY_DECAY, TICKID_ELECTRONICS, TICKID_EMAIL, TICKID_EVENT, TICKID_EXIT_BEHAVIOR, TICKID_EXIT_REOPEN, TICKID_ITEM_BEHAVIOR, TICKID_ITEM_BOUNCEBACK, TICKID_LIGHT_FLICKERS, TICKID_LIVEAUCTION, TICKID_LONGERMASK, TICKID_MISCELLANEOUS, TICKID_MOB, TICKID_PROPERTY_SPECIAL, TICKID_QUEST, TICKID_READYTOSTOP, TICKID_ROOM_BEHAVIOR, TICKID_ROOM_ITEM_REJUV, TICKID_SHORTERMASK, TICKID_SOLITARYMASK, TICKID_SPECIALCOMBAT, TICKID_SPECIALMANEUVER, TICKID_SPELL_AFFECT, TICKID_SUPPORT, TICKID_TIMEAUCTION, TICKID_TRAP_DESTRUCTION, TICKID_TRAP_RESET

Constructor Summary

Constructors
Constructor Description

MUDTracker()

Constructors
Constructor	Description
`MUDTracker()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static java.util.List<Rider>`	`addRiders(Rider theRider, Rideable riding, java.util.List<Rider> riders)`
`boolean`	`areNearEachOther(MOB whichM, MOB nearM)`	Returns true if the two give mobs are in the same room, or adjacent rooms.
`boolean`	`autoTrack(MOB mob, Room destR)`	Starts the given mob tracking from their current location to the given room.
`boolean`	`beMobile(MOB mob, boolean dooropen, boolean wander, boolean roomprefer, boolean roomobject, int[] status, java.util.Set<Room> rooms)`	The random mobility method, for controlling movement of a move from one room to an ajacent one.
`PairVector<Room,int[]>`	`buildGridList(Room room, java.lang.String ownerName, int maxDepth)`	Builts a radiating room list that is assumed to be in grid formation, and owned as private property.
`boolean`	`canValidTrail(Room startR, java.util.List<Room> radiantV, java.lang.String where, int radius, java.util.Set<Room> ignoreRooms, int maxSecs)`	Searches for a room fitting to the given search string, within the given radiant rooms, with a trail fitting the given trail flags, optionally ignoring any ignore rooms.
`MOB`	`createNavigationMob(NavigableItem ship)`	When large sailing ships or caravans navigate from room to room, a fake temporary mob is used to represent the agency of the ship per se.
`boolean`	`doFallenOffCheck(MOB mob)`	If the given mob is riding anything, this will schedule a check to see if it is STILL riding.
`Rideable`	`findALadder(MOB mob, Room room)`	If theres a ladder that can be seen in the same room as the given mob, this returns it.
`java.util.List<java.util.List<java.lang.Integer>>`	`findAllTrails(Room from, Room to, java.util.List<Room> radiantTrail)`	Returns every trail found from the starting to the ending room, given a radiantTrail that includes both.
`java.util.List<java.util.List<java.lang.Integer>>`	`findAllTrails(Room from, java.util.List<Room> tos, java.util.List<Room> radiantTrail)`	Returns every trail found from the starting to each ending room, given a radiantTrail that includes all.
`int`	`findExitDir(MOB mob, Room R, java.lang.String desc)`	Given a mob with eyes, and their location, and a match string, this will attempt to match one of the exits and return it.
`int`	`findRoomDir(MOB mob, Room R)`	Given a mob and a room, returns the direction from the mobs direction to the target room, if possible.
`java.util.List<Room>`	`findTrailToAnyRoom(Room location, TrackingLibrary.RFilter destFilter, TrackingLibrary.TrackingFlags flags, int maxRadius)`	Returns a trail of rooms to move through in order to go from the given location to a room that is not filtered out of the destFilter.
`java.util.List<Room>`	`findTrailToAnyRoom(Room location, java.util.List<Room> destRooms, TrackingLibrary.TrackingFlags flags, int maxRadius)`	Returns a trail of rooms to move through in order to go from the given location to one of the given destination rooms.
`java.util.List<Room>`	`findTrailToRoom(Room location, Room destRoom, TrackingLibrary.TrackingFlags flags, int maxRadius)`	Returns a trail of rooms to move through in order to go from the given location to the given destination room.
`java.util.List<Room>`	`findTrailToRoom(Room location, Room destRoom, TrackingLibrary.TrackingFlags flags, int maxRadius, java.util.List<Room> radiant)`	Returns a trail of rooms to move through in order to go from the given location to the given destination room.
`protected void`	`forceEntry(MOB M, Room toHere, boolean andFollowers, boolean forceLook, java.lang.String msg)`
`void`	`forceRecall(MOB mob, boolean includeFollowers)`	Attempts to recall the given mob, and optinally all their followers, by generating a recall message and previewing and sending it.
`Room`	`getCalculatedAdjacentGridRoom(PairVector<Room,int[]> rooms, Room R, int dir)`	Given a set of rooms built with grid coordinates, and a starting room inside that grid, and a direction, this will return the adjacent room based on the built grid.
`protected int`	`getCheckedDir(MOB M, Room toHere)`
`protected java.util.List<java.lang.String>`	`getCloseCommandSet(int direction)`
`protected java.util.List<java.lang.String>`	`getDirectionCommandSet(int direction)`
`protected int`	`getIndexEnsureSet(Room R1, Room R2, java.util.List<Room> set, int radius, java.util.Set<Room> ignoreRooms)`
`Room`	`getNearestValidIDRoom(Room R)`	Based on radiating rooms from the given room, this will return the nearest room that has a valid room id.
`protected java.util.List<java.lang.String>`	`getOpenCommandSet(int direction)`
`java.util.List<Area>`	`getRadiantAreas(Area area, int maxDepth)`	Generates an ordered list of areas radiating from the given area, with max depth.
`protected void`	`getRadiantAreas(Area area, java.util.List<Area> areas, Area radiateTo, int maxDepth, java.util.Set<Area> ignoreAreas)`
`java.util.List<Room>`	`getRadiantRooms(Room room, TrackingLibrary.RFilters filters, int maxDepth)`	Generates an ordered list of rooms radiating from the given room, with max depth and optional room radiating filters.
`java.util.List<Room>`	`getRadiantRooms(Room room, TrackingLibrary.TrackingFlags flags, int maxDepth)`	Generates an ordered list of rooms radiating from the given room, with max depth and optional room radiating filters.
`void`	`getRadiantRooms(Room room, java.util.List<Room> rooms, TrackingLibrary.RFilters filters, Room radiateTo, int maxDepth, java.util.Set<Room> ignoreRooms)`	Generates an ordered list of rooms radiating from the given room, with max depth, and optional ignore rooms, and radiating room filters.
`void`	`getRadiantRooms(Room room, java.util.List<Room> rooms, TrackingLibrary.TrackingFlags flags, Room radiateTo, int maxDepth, java.util.Set<Room> ignoreRooms)`	Generates an ordered list of rooms radiating from the given room, with max depth, and optional stopping room, ignore rooms, and flags.
`java.util.Enumeration<Room>`	`getRadiantRoomsEnum(Room room, TrackingLibrary.RFilters filters, Room radiateTo, int maxDepth, java.util.Set<Room> ignoreRooms)`	Generates a enumerator for an ordered list of rooms radiating from the given room, with max depth, and optional ignore rooms, and radiating room filters.
`protected boolean`	`getRadiantRoomsToTarget(Room room, java.util.List<Room> rooms, TrackingLibrary.RFilters filters, TrackingLibrary.RFilter radiateTo, int maxDepth)`
`boolean`	`getRadiantRoomsToTarget(Room room, java.util.List<Room> rooms, TrackingLibrary.TrackingFlags flags, TrackingLibrary.RFilter radiateTo, int maxDepth)`	Generates an ordered list of rooms radiating from the given room, to a given target room filter in, with max depth, and optional ignore rooms, and radiating room filters/flags.
`Room`	`getRadiantRoomTarget(Room room, TrackingLibrary.RFilters filters, TrackingLibrary.RFilter radiateTo)`	Returns a room that is not filtered out of the rooms radiating from the given room.
`protected int`	`getRoomDirection(Room R, Room toRoom, java.util.List<Room> ignore)`
`java.util.List<java.lang.Integer>`	`getShortestTrail(java.util.List<java.util.List<java.lang.Integer>> finalSets)`	Does nothing interesting.
`java.lang.String`	`getTrailToDescription(Room startR, java.util.List<Room> radiantV, java.lang.String where, java.util.Set<TrackingLibrary.TrailFlag> trailFlags, int radius, java.util.Set<Room> ignoreRooms, int maxSecs)`	Searches for a room fitting to the given search string, within the given radiant rooms, with a trail fitting the given trail flags, optionally ignoring any ignore rooms.
`protected Room`	`getWhere(java.lang.String where, java.util.List<Room> set)`
`java.lang.String`	`ID()`	The CoffeeMud Java Class ID shared by all instances of this object.
`void`	`initializeClass()`	Called ONCE after all objects are loaded, but before the map is read in during initialization.
`CMMsg.CheckedMsgResponse`	`isOkWaterSurfaceAffect(Room room, CMMsg msg)`	Utility method for handling movement into a water surface type room.
`boolean`	`makeFall(Physical P, Room room, boolean reverseFall)`	Causes the given mob or item to 'fall' from one room to another, usually down, if it can.
`void`	`makeSink(Physical P, Room room, boolean reverseSink)`	Causes the given mob or item to 'sink' from one room to another, usually down, if it can.
`void`	`markToWanderHomeLater(MOB M, int ticks)`	Marks the mob with a temporary behavior that will force the mob to wander back to their start room as soon as possible.
`protected boolean`	`move(MOB mob, int directionCode, boolean flee, boolean nolook, boolean noriders, boolean always, boolean running)`
`TrackingLibrary.TrackingFlags`	`newFlags()`	Constructs a new set of TrackingFlags, which are filters for use in radiant and room finding methods.
`void`	`postMountLadder(MOB mob, Rideable ladder)`	Causes the given mob to mount the given ladder.
`int`	`radiatesFromDir(Room room, java.util.List<Room> rooms)`	This method is helpful for traversing room trails.
`java.util.List<Rider>`	`ridersAhead(Rider theRider, Room sourceRoom, Room destRoom, int directionCode, boolean flee, boolean running)`
`void`	`ridersBehind(java.util.List<Rider> riders, Room sourceRoom, Room destRoom, int directionCode, boolean flee, boolean running)`
`boolean`	`run(MOB mob, int directionCode, boolean flee, boolean nolook, boolean noriders)`	Causes the given mob to attempt to run in the given direction.
`boolean`	`run(MOB mob, int directionCode, boolean flee, boolean nolook, boolean noriders, boolean always)`	Causes the given mob to attempt to run in the given direction.
`void`	`stopTracking(MOB mob)`	Uninvokes and deletes any Tracking-related effects on the given mob.
`int`	`trackNextDirectionFromHere(java.util.List<Room> theTrail, Room location, boolean openOnly)`	Given a room trail, with the destination room first, and the location last, this will return the next direction to travel from the given location, optionally stopping at doors.
`boolean`	`walk(Item I, int directionCode)`	Narrates the movement of an item, usually a rideable, in a given direction, from its current location.
`boolean`	`walk(MOB mob, int directionCode, boolean flee, boolean nolook)`	Causes the given mob to attempt to walk in the given direction.
`boolean`	`walk(MOB mob, int directionCode, boolean flee, boolean nolook, boolean noriders)`	Causes the given mob to attempt to walk in the given direction.
`boolean`	`walk(MOB mob, int directionCode, boolean flee, boolean nolook, boolean noriders, boolean always)`	Causes the given mob to attempt to walk in the given direction.
`void`	`walkForced(MOB M, Room fromHere, Room toHere, boolean andFollowers, boolean forceLook, java.lang.String msgStr)`	Forces the given mob to leave the from room and enter to the room, without preview.
`void`	`wanderAway(MOB M, boolean mindPCs, boolean andGoHome)`	Forces the given mob to leave the room, for aesthetic purposes.
`boolean`	`wanderCheckedAway(MOB M, boolean mindPCs, boolean andGoHome)`	Forces the given mob to leave the room, for aesthetic purposes.
`boolean`	`wanderCheckedFromTo(MOB M, Room toHere, boolean mindPCs)`	Aesthetically transports a mob from their location to a target room by having them leave their current room legitimately, and enter the target one.
`void`	`wanderFromTo(MOB M, Room toHere, boolean mindPCs)`	Aesthetically transports a mob from their location to a target room by having them leave their current room legitimately, and enter the target one.
`void`	`wanderIn(MOB M, Room toHere)`	Aesthetically transports a mob from their location to a target room by having them leave their current room legitimately, and enter the target one.

Methods inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.CMLibrary
activate, getServiceClient, L, propertiesLoaded, shutdown

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject
copyOf, name, newInstance

Methods inherited from interface java.lang.Comparable
compareTo

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from class com.planet_ink.coffee_mud.Libraries.StdLibrary
activate, checkDatabase, compareTo, copyOf, getServiceClient, getTickStatus, L, name, newInstance, propertiesLoaded, setThreadStatus, shutdown, tick

- Field Detail
  - directionCommandSets
```
protected java.util.Map<java.lang.Integer,java.util.List<java.lang.String>> directionCommandSets
```
  - openCommandSets
```
protected java.util.Map<java.lang.Integer,java.util.List<java.lang.String>> openCommandSets
```
  - closeCommandSets
```
protected java.util.Map<java.lang.Integer,java.util.List<java.lang.String>> closeCommandSets
```
  - trackingFilters
```
protected java.util.Map<TrackingLibrary.TrackingFlags,TrackingLibrary.RFilters> trackingFilters
```
  - EMPTY_FLAGS
```
protected static final TrackingLibrary.TrackingFlags EMPTY_FLAGS
```
  - EMPTY_FILTERS
```
protected static final TrackingLibrary.RFilters EMPTY_FILTERS
```
  - emptyFilter
```
protected final TrackingLibrary.RFilters emptyFilter
```
  - validIDFilter
```
protected final TrackingLibrary.RFilter validIDFilter
```
- Constructor Detail
  - MUDTracker
```
public MUDTracker()
```
- Method Detail
  - ID
```
public java.lang.String ID()
```
    Description copied from interface: CMObject
    
    The CoffeeMud Java Class ID shared by all instances of this object. Unlike the Java Class name, this method does not include package information. However, it must return a String value unique to its class category in the ClassLoader. Class categories include Libraries, Common, Areas, Abilities, Behaviors, CharClasses, Commands, Exits Locales, MOBS, Races, WebMacros, Basic Items, Armor, Weapons, ClanItems, Tech. The name is typically identical to the class name.
    
    Specified by:
    
    ID in interface CMObject
    
    Overrides:
    
    ID in class StdLibrary
    
    Returns:
    
    the name of this class
  - autoTrack
```
public boolean autoTrack(MOB mob,
                         Room destR)
```
    Description copied from interface: TrackingLibrary
    
    Starts the given mob tracking from their current location to the given room.
    
    Specified by:
    
    autoTrack in interface TrackingLibrary
    
    Parameters:
    
    mob - the mob to start tracking
    
    destR - the target room
    
    Returns:
    
    true if tracking was successfully started, false otherwise
    
    See Also:
    
    TrackingLibrary.stopTracking(MOB)
  - getDirectionCommandSet
```
protected java.util.List<java.lang.String> getDirectionCommandSet(int direction)
```
  - getOpenCommandSet
```
protected java.util.List<java.lang.String> getOpenCommandSet(int direction)
```
  - getCloseCommandSet
```
protected java.util.List<java.lang.String> getCloseCommandSet(int direction)
```
  - findTrailToRoom
```
public java.util.List<Room> findTrailToRoom(Room location,
                                            Room destRoom,
                                            TrackingLibrary.TrackingFlags flags,
                                            int maxRadius)
```
    Description copied from interface: TrackingLibrary
    
    Returns a trail of rooms to move through in order to go from the given location to the given destination room. The trail will have the destination room first, and the location last.
    
    Specified by:
    
    findTrailToRoom in interface TrackingLibrary
    
    Parameters:
    
    location - the starting room for the trail
    
    destRoom - the target room for the trail
    
    flags - any Radiant flags -- not used in the trail calculation
    
    maxRadius - maximum radius for the Radiant rooms
    
    Returns:
    
    the trail, or null if a failure
    
    See Also:
    
    TrackingLibrary.trackNextDirectionFromHere(List, Room, boolean), TrackingLibrary.findAllTrails(Room, List, List), TrackingLibrary.findAllTrails(Room, Room, List), TrackingLibrary.findTrailToAnyRoom(Room, List, TrackingFlags, int), TrackingLibrary.findTrailToAnyRoom(Room, RFilter, TrackingFlags, int), TrackingLibrary.findTrailToRoom(Room, Room, TrackingFlags, int, List), TrackingLibrary.getShortestTrail(List), TrackingLibrary.getTrailToDescription(Room, List, String, Set, int, Set, int), TrackingLibrary.canValidTrail(Room, List, String, int, Set, int)
  - findTrailToRoom
```
public java.util.List<Room> findTrailToRoom(Room location,
                                            Room destRoom,
                                            TrackingLibrary.TrackingFlags flags,
                                            int maxRadius,
                                            java.util.List<Room> radiant)
```
    Description copied from interface: TrackingLibrary
    
    Returns a trail of rooms to move through in order to go from the given location to the given destination room. The trail will have the destination room first, and the location last. Providing radiant rooms is optional, but they should have the location first and destination last.
    
    Specified by:
    
    findTrailToRoom in interface TrackingLibrary
    
    Parameters:
    
    location - the starting room for the trail
    
    destRoom - the target room for the trail
    
    flags - any Radiant flags -- not used in the trail calculation
    
    maxRadius - maximum radius for the Radiant rooms
    
    radiant - optional radiant rooms list
    
    Returns:
    
    the trail, or null if a failure
    
    See Also:
    
    TrackingLibrary.trackNextDirectionFromHere(List, Room, boolean), TrackingLibrary.findAllTrails(Room, List, List), TrackingLibrary.findAllTrails(Room, Room, List), TrackingLibrary.findTrailToAnyRoom(Room, List, TrackingFlags, int), TrackingLibrary.findTrailToAnyRoom(Room, RFilter, TrackingFlags, int), TrackingLibrary.findTrailToRoom(Room, Room, TrackingFlags, int), TrackingLibrary.getShortestTrail(List), TrackingLibrary.getTrailToDescription(Room, List, String, Set, int, Set, int), TrackingLibrary.canValidTrail(Room, List, String, int, Set, int)
  - markToWanderHomeLater
```
public void markToWanderHomeLater(MOB M,
                                  int ticks)
```
    Description copied from interface: TrackingLibrary
    
    Marks the mob with a temporary behavior that will force the mob to wander back to their start room as soon as possible.
    
    Specified by:
    
    markToWanderHomeLater in interface TrackingLibrary
    
    Parameters:
    
    M - the mob to move
    
    ticks - the number of ticks to wait, or 0
    
    See Also:
    
    TrackingLibrary.wanderAway(MOB, boolean, boolean), TrackingLibrary.wanderCheckedAway(MOB, boolean, boolean), TrackingLibrary.wanderCheckedFromTo(MOB, Room, boolean), TrackingLibrary.wanderFromTo(MOB, Room, boolean), TrackingLibrary.wanderIn(MOB, Room), TrackingLibrary.forceRecall(MOB, boolean)
  - findTrailToAnyRoom
```
public java.util.List<Room> findTrailToAnyRoom(Room location,
                                               java.util.List<Room> destRooms,
                                               TrackingLibrary.TrackingFlags flags,
                                               int maxRadius)
```
    Description copied from interface: TrackingLibrary
    
    Returns a trail of rooms to move through in order to go from the given location to one of the given destination rooms. It will prefer the closest, and prefer one in the same area as the start room. It does every search to make sure. The trail will have the destination room first, and the location last.
    
    Specified by:
    
    findTrailToAnyRoom in interface TrackingLibrary
    
    Parameters:
    
    location - the starting room for the trail
    
    destRooms - a list of rooms, any of which may be the destination
    
    flags - any Radiant flags -- not used in the trail calculation
    
    maxRadius - maximum radius for the Radiant rooms
    
    Returns:
    
    the trail, or null if a failure
    
    See Also:
    
    TrackingLibrary.trackNextDirectionFromHere(List, Room, boolean), TrackingLibrary.findAllTrails(Room, List, List), TrackingLibrary.findAllTrails(Room, Room, List), TrackingLibrary.findTrailToAnyRoom(Room, RFilter, TrackingFlags, int), TrackingLibrary.findTrailToRoom(Room, Room, TrackingFlags, int), TrackingLibrary.findTrailToRoom(Room, Room, TrackingFlags, int, List), TrackingLibrary.getShortestTrail(List), TrackingLibrary.getTrailToDescription(Room, List, String, Set, int, Set, int), TrackingLibrary.canValidTrail(Room, List, String, int, Set, int)
  - findTrailToAnyRoom
```
public java.util.List<Room> findTrailToAnyRoom(Room location,
                                               TrackingLibrary.RFilter destFilter,
                                               TrackingLibrary.TrackingFlags flags,
                                               int maxRadius)
```
    Description copied from interface: TrackingLibrary
    
    Returns a trail of rooms to move through in order to go from the given location to a room that is not filtered out of the destFilter. It will prefer the closest, and prefer one in the same area as the start room. It does every search to make sure. The trail will have the destination room first, and the location last.
    
    Specified by:
    
    findTrailToAnyRoom in interface TrackingLibrary
    
    Parameters:
    
    location - the starting room for the trail
    
    destFilter - a filter to identify the destination, by filtering OUT
    
    flags - any Radiant flags -- not used in the trail calculation
    
    maxRadius - maximum radius for the Radiant rooms
    
    Returns:
    
    the trail, or null if a failure
    
    See Also:
    
    TrackingLibrary.trackNextDirectionFromHere(List, Room, boolean), TrackingLibrary.findAllTrails(Room, List, List), TrackingLibrary.findAllTrails(Room, Room, List), TrackingLibrary.findTrailToAnyRoom(Room, List, TrackingFlags, int), TrackingLibrary.findTrailToRoom(Room, Room, TrackingFlags, int), TrackingLibrary.findTrailToRoom(Room, Room, TrackingFlags, int, List), TrackingLibrary.getShortestTrail(List), TrackingLibrary.getTrailToDescription(Room, List, String, Set, int, Set, int), TrackingLibrary.canValidTrail(Room, List, String, int, Set, int)
  - trackNextDirectionFromHere
```
public int trackNextDirectionFromHere(java.util.List<Room> theTrail,
                                      Room location,
                                      boolean openOnly)
```
    Description copied from interface: TrackingLibrary
    
    Given a room trail, with the destination room first, and the location last, this will return the next direction to travel from the given location, optionally stopping at doors.
    
    Specified by:
    
    trackNextDirectionFromHere in interface TrackingLibrary
    
    Parameters:
    
    theTrail - the room trail
    
    location - the current room on the trail
    
    openOnly - true to skip doors
    
    Returns:
    
    the next direction, or -1, or 999 if you have arrived
    
    See Also:
    
    TrackingLibrary.findTrailToAnyRoom(Room, List, TrackingFlags, int), TrackingLibrary.findTrailToAnyRoom(Room, RFilter, TrackingFlags, int), TrackingLibrary.findTrailToRoom(Room, Room, TrackingFlags, int), TrackingLibrary.findTrailToRoom(Room, Room, TrackingFlags, int, List)
  - radiatesFromDir
```
public int radiatesFromDir(Room room,
                           java.util.List<Room> rooms)
```
    Description copied from interface: TrackingLibrary
    
    This method is helpful for traversing room trails. If the given room is higher in the given room list than a connecting room, it returns -1. If a room that connects to this one is found, the direction from the given room to that one is returned.
    
    Specified by:
    
    radiatesFromDir in interface TrackingLibrary
    
    Parameters:
    
    room - the source room
    
    rooms - the list of rooms
    
    Returns:
    
    the direction from the room to the lowest room in the list
  - getRadiantRooms
```
public java.util.List<Room> getRadiantRooms(Room room,
                                            TrackingLibrary.TrackingFlags flags,
                                            int maxDepth)
```
    Description copied from interface: TrackingLibrary
    
    Generates an ordered list of rooms radiating from the given room, with max depth and optional room radiating filters. The radiant rooms start with the origin room and get increasingly outward as you go down the list.
    
    Specified by:
    
    getRadiantRooms in interface TrackingLibrary
    
    Parameters:
    
    room - the starting room
    
    flags - one or more filters that blocks various radiation paths
    
    maxDepth - the maximum depth of the radiation
    
    Returns:
    
    the radiant rooms output
    
    See Also:
    
    TrackingLibrary.getRadiantAreas(Area, int), TrackingLibrary.getRadiantRooms(Room, RFilters, int), TrackingLibrary.getRadiantRooms(Room, List, RFilters, Room, int, Set), TrackingLibrary.getRadiantRooms(Room, List, TrackingFlags, Room, int, Set), TrackingLibrary.getRadiantRoomsEnum(Room, RFilters, Room, int, Set), TrackingLibrary.getRadiantRoomsToTarget(Room, List, TrackingFlags, RFilter, int), TrackingLibrary.getRadiantRoomTarget(Room, RFilters, RFilter)
  - getRadiantRooms
```
public java.util.List<Room> getRadiantRooms(Room room,
                                            TrackingLibrary.RFilters filters,
                                            int maxDepth)
```
    Description copied from interface: TrackingLibrary
    
    Generates an ordered list of rooms radiating from the given room, with max depth and optional room radiating filters. The radiant rooms start with the origin room and get increasingly outward as you go down the list.
    
    Specified by:
    
    getRadiantRooms in interface TrackingLibrary
    
    Parameters:
    
    room - the starting room
    
    filters - one or more filters that blocks various radiation paths
    
    maxDepth - the maximum depth of the radiation
    
    Returns:
    
    the radiant rooms list
    
    See Also:
    
    TrackingLibrary.getRadiantAreas(Area, int), TrackingLibrary.getRadiantRooms(Room, TrackingFlags, int), TrackingLibrary.getRadiantRooms(Room, List, RFilters, Room, int, Set), TrackingLibrary.getRadiantRooms(Room, List, TrackingFlags, Room, int, Set), TrackingLibrary.getRadiantRoomsEnum(Room, RFilters, Room, int, Set), TrackingLibrary.getRadiantRoomsToTarget(Room, List, TrackingFlags, RFilter, int), TrackingLibrary.getRadiantRoomTarget(Room, RFilters, RFilter)
  - getRadiantAreas
```
public java.util.List<Area> getRadiantAreas(Area area,
                                            int maxDepth)
```
    Description copied from interface: TrackingLibrary
    
    Generates an ordered list of areas radiating from the given area, with max depth. The radiant areas start with the origin area and get increasingly outward as you go down the list.
    
    Specified by:
    
    getRadiantAreas in interface TrackingLibrary
    
    Parameters:
    
    area - the starting area
    
    maxDepth - the maximum depth of the radiation
    
    Returns:
    
    the radiant areas output
    
    See Also:
    
    TrackingLibrary.getRadiantRooms(Room, RFilters, int), TrackingLibrary.getRadiantRooms(Room, TrackingFlags, int), TrackingLibrary.getRadiantRooms(Room, List, RFilters, Room, int, Set), TrackingLibrary.getRadiantRooms(Room, List, TrackingFlags, Room, int, Set), TrackingLibrary.getRadiantRoomsEnum(Room, RFilters, Room, int, Set), TrackingLibrary.getRadiantRoomsToTarget(Room, List, TrackingFlags, RFilter, int), TrackingLibrary.getRadiantRoomTarget(Room, RFilters, RFilter)
  - getRadiantRooms
```
public void getRadiantRooms(Room room,
                            java.util.List<Room> rooms,
                            TrackingLibrary.TrackingFlags flags,
                            Room radiateTo,
                            int maxDepth,
                            java.util.Set<Room> ignoreRooms)
```
    Description copied from interface: TrackingLibrary
    
    Generates an ordered list of rooms radiating from the given room, with max depth, and optional stopping room, ignore rooms, and flags. The radiant rooms start with the origin room and get increasingly outward as you go down the list.
    
    Specified by:
    
    getRadiantRooms in interface TrackingLibrary
    
    Parameters:
    
    room - the starting room
    
    rooms - the radiant rooms output
    
    flags - optional flags to limit the radiant paths
    
    radiateTo - optional room to stop at, which would be last on the list
    
    maxDepth - the maximum depth of the radiation
    
    ignoreRooms - optional rooms to ignore in radiation
    
    See Also:
    
    TrackingLibrary.getRadiantAreas(Area, int), TrackingLibrary.getRadiantRooms(Room, RFilters, int), TrackingLibrary.getRadiantRooms(Room, TrackingFlags, int), TrackingLibrary.getRadiantRooms(Room, List, RFilters, Room, int, Set), TrackingLibrary.getRadiantRoomsEnum(Room, RFilters, Room, int, Set), TrackingLibrary.getRadiantRoomsToTarget(Room, List, TrackingFlags, RFilter, int), TrackingLibrary.getRadiantRoomTarget(Room, RFilters, RFilter)
  - newFlags
```
public TrackingLibrary.TrackingFlags newFlags()
```
    Description copied from interface: TrackingLibrary
    
    Constructs a new set of TrackingFlags, which are filters for use in radiant and room finding methods. These must then be filled with TrackingFlag (RFilter) objects.
    
    Specified by:
    
    newFlags in interface TrackingLibrary
    
    Returns:
    
    the new tracking flags set
  - getRadiantRooms
```
public void getRadiantRooms(Room room,
                            java.util.List<Room> rooms,
                            TrackingLibrary.RFilters filters,
                            Room radiateTo,
                            int maxDepth,
                            java.util.Set<Room> ignoreRooms)
```
    Description copied from interface: TrackingLibrary
    
    Generates an ordered list of rooms radiating from the given room, with max depth, and optional ignore rooms, and radiating room filters. The radiant rooms start with the origin room and get increasingly outward as you go down the list.
    
    Specified by:
    
    getRadiantRooms in interface TrackingLibrary
    
    Parameters:
    
    room - the starting room
    
    rooms - the radiant rooms output
    
    filters - one or more filters that blocks various radiation paths
    
    radiateTo - optional room to stop at, which would be last on the list
    
    maxDepth - the maximum depth of the radiation
    
    ignoreRooms - optional rooms to ignore in radiation
    
    See Also:
    
    TrackingLibrary.getRadiantAreas(Area, int), TrackingLibrary.getRadiantRooms(Room, RFilters, int), TrackingLibrary.getRadiantRooms(Room, TrackingFlags, int), TrackingLibrary.getRadiantRooms(Room, List, TrackingFlags, Room, int, Set), TrackingLibrary.getRadiantRoomsEnum(Room, RFilters, Room, int, Set), TrackingLibrary.getRadiantRoomsToTarget(Room, List, TrackingFlags, RFilter, int), TrackingLibrary.getRadiantRoomTarget(Room, RFilters, RFilter)
  - getRadiantAreas
```
protected void getRadiantAreas(Area area,
                               java.util.List<Area> areas,
                               Area radiateTo,
                               int maxDepth,
                               java.util.Set<Area> ignoreAreas)
```
  - getRadiantRoomsEnum
```
public java.util.Enumeration<Room> getRadiantRoomsEnum(Room room,
                                                       TrackingLibrary.RFilters filters,
                                                       Room radiateTo,
                                                       int maxDepth,
                                                       java.util.Set<Room> ignoreRooms)
```
    Description copied from interface: TrackingLibrary
    
    Generates a enumerator for an ordered list of rooms radiating from the given room, with max depth, and optional ignore rooms, and radiating room filters. The radiant rooms start with the origin room and get increasingly outward as you go down the list.
    
    Specified by:
    
    getRadiantRoomsEnum in interface TrackingLibrary
    
    Parameters:
    
    room - the starting room
    
    filters - one or more filters that blocks various radiation paths
    
    radiateTo - optional room to stop at, which would be last on the list
    
    maxDepth - the maximum depth of the radiation
    
    ignoreRooms - optional rooms to ignore in radiation
    
    Returns:
    
    the enumerator of radiating rooms
    
    See Also:
    
    TrackingLibrary.getRadiantAreas(Area, int), TrackingLibrary.getRadiantRooms(Room, RFilters, int), TrackingLibrary.getRadiantRooms(Room, TrackingFlags, int), TrackingLibrary.getRadiantRooms(Room, List, RFilters, Room, int, Set), TrackingLibrary.getRadiantRooms(Room, List, TrackingFlags, Room, int, Set), TrackingLibrary.getRadiantRoomsToTarget(Room, List, TrackingFlags, RFilter, int), TrackingLibrary.getRadiantRoomTarget(Room, RFilters, RFilter)
  - getRadiantRoomsToTarget
```
public boolean getRadiantRoomsToTarget(Room room,
                                       java.util.List<Room> rooms,
                                       TrackingLibrary.TrackingFlags flags,
                                       TrackingLibrary.RFilter radiateTo,
                                       int maxDepth)
```
    Description copied from interface: TrackingLibrary
    
    Generates an ordered list of rooms radiating from the given room, to a given target room filter in, with max depth, and optional ignore rooms, and radiating room filters/flags. The radiant rooms start with the origin room and get increasingly outward as you go down the list.
    
    Specified by:
    
    getRadiantRoomsToTarget in interface TrackingLibrary
    
    Parameters:
    
    room - the starting room
    
    rooms - the radiant rooms output
    
    flags - one or more filters that blocks various radiation paths
    
    radiateTo - filter for the room to stop at, which would be last on the list
    
    maxDepth - the maximum depth of the radiation
    
    Returns:
    
    true if the radiation was successful, false otherwise
    
    See Also:
    
    TrackingLibrary.getRadiantAreas(Area, int), TrackingLibrary.getRadiantRooms(Room, RFilters, int), TrackingLibrary.getRadiantRooms(Room, TrackingFlags, int), TrackingLibrary.getRadiantRooms(Room, List, RFilters, Room, int, Set), TrackingLibrary.getRadiantRooms(Room, List, TrackingFlags, Room, int, Set), TrackingLibrary.getRadiantRoomsEnum(Room, RFilters, Room, int, Set), TrackingLibrary.getRadiantRoomTarget(Room, RFilters, RFilter)
  - getRadiantRoomsToTarget
```
protected boolean getRadiantRoomsToTarget(Room room,
                                          java.util.List<Room> rooms,
                                          TrackingLibrary.RFilters filters,
                                          TrackingLibrary.RFilter radiateTo,
                                          int maxDepth)
```
  - getRadiantRoomTarget
```
public Room getRadiantRoomTarget(Room room,
                                 TrackingLibrary.RFilters filters,
                                 TrackingLibrary.RFilter radiateTo)
```
    Description copied from interface: TrackingLibrary
    
    Returns a room that is not filtered out of the rooms radiating from the given room. May also include optional filters for the radiating room path. No max depth, so this will just continue until it runs through the entire connected map!
    
    Specified by:
    
    getRadiantRoomTarget in interface TrackingLibrary
    
    Parameters:
    
    room - the starting room
    
    filters - one or more filters that blocks various radiation paths
    
    radiateTo - filter that the returned room is NOT filtered out of
    
    Returns:
    
    null, or the found room
    
    See Also:
    
    TrackingLibrary.getRadiantAreas(Area, int), TrackingLibrary.getRadiantRooms(Room, RFilters, int), TrackingLibrary.getRadiantRooms(Room, TrackingFlags, int), TrackingLibrary.getRadiantRooms(Room, List, RFilters, Room, int, Set), TrackingLibrary.getRadiantRooms(Room, List, TrackingFlags, Room, int, Set), TrackingLibrary.getRadiantRoomsEnum(Room, RFilters, Room, int, Set), TrackingLibrary.getRadiantRoomsToTarget(Room, List, TrackingFlags, RFilter, int)
  - getNearestValidIDRoom
```
public Room getNearestValidIDRoom(Room R)
```
    Description copied from interface: TrackingLibrary
    
    Based on radiating rooms from the given room, this will return the nearest room that has a valid room id.
    
    Specified by:
    
    getNearestValidIDRoom in interface TrackingLibrary
    
    Parameters:
    
    R - the room that is prob not valid
    
    Returns:
    
    the nearest valid room
  - stopTracking
```
public void stopTracking(MOB mob)
```
    Description copied from interface: TrackingLibrary
    
    Uninvokes and deletes any Tracking-related effects on the given mob.
    
    Specified by:
    
    stopTracking in interface TrackingLibrary
    
    Parameters:
    
    mob - the mob to untrack
    
    See Also:
    
    TrackingLibrary.autoTrack(MOB, Room)
  - beMobile
```
public boolean beMobile(MOB mob,
                        boolean dooropen,
                        boolean wander,
                        boolean roomprefer,
                        boolean roomobject,
                        int[] status,
                        java.util.Set<Room> rooms)
```
    Description copied from interface: TrackingLibrary
    
    The random mobility method, for controlling movement of a move from one room to an ajacent one. Will swim if they can swim, crawl if crawling needed, climb if possible, etc.
    
    Specified by:
    
    beMobile in interface TrackingLibrary
    
    Parameters:
    
    mob - the mob who needs to be moved
    
    dooropen - true attempt to open any closed doors, unless its private property
    
    wander - true to cross area boundaries
    
    roomprefer - only take a room on the optional list
    
    roomobject - take any room UNLES it is on the optional list
    
    status - optional status tracker for debugging
    
    rooms - optional set of rooms for prefer or object
    
    Returns:
    
    true if the movement was successful
    
    See Also:
    
    TrackingLibrary.walk(Item, int), TrackingLibrary.walk(MOB, int, boolean, boolean), TrackingLibrary.walk(MOB, int, boolean, boolean, boolean), TrackingLibrary.walk(MOB, int, boolean, boolean, boolean, boolean), TrackingLibrary.walkForced(MOB, Room, Room, boolean, boolean, String), TrackingLibrary.run(MOB, int, boolean, boolean, boolean), TrackingLibrary.run(MOB, int, boolean, boolean, boolean, boolean)
  - wanderAway
```
public void wanderAway(MOB M,
                       boolean mindPCs,
                       boolean andGoHome)
```
    Description copied from interface: TrackingLibrary
    
    Forces the given mob to leave the room, for aesthetic purposes. Always aborts if mob is a mount with a rider nearby. Optionally aborts if pcs are present, and optionally does a legit re-enter of their start room.
    
    Specified by:
    
    wanderAway in interface TrackingLibrary
    
    Parameters:
    
    M - the mob to move
    
    mindPCs - true to not leave if pcs are present
    
    andGoHome - true to also aesthetically go back to start room
    
    See Also:
    
    TrackingLibrary.wanderCheckedAway(MOB, boolean, boolean), TrackingLibrary.wanderCheckedFromTo(MOB, Room, boolean), TrackingLibrary.wanderFromTo(MOB, Room, boolean), TrackingLibrary.wanderIn(MOB, Room), TrackingLibrary.markToWanderHomeLater(MOB, int), TrackingLibrary.forceRecall(MOB, boolean)
  - areNearEachOther
```
public boolean areNearEachOther(MOB whichM,
                                MOB nearM)
```
    Description copied from interface: TrackingLibrary
    
    Returns true if the two give mobs are in the same room, or adjacent rooms.
    
    Specified by:
    
    areNearEachOther in interface TrackingLibrary
    
    Parameters:
    
    whichM - the first mob
    
    nearM - the second mob
    
    Returns:
    
    true if they are near each other, false otherwise
  - wanderCheckedAway
```
public boolean wanderCheckedAway(MOB M,
                                 boolean mindPCs,
                                 boolean andGoHome)
```
    Description copied from interface: TrackingLibrary
    
    Forces the given mob to leave the room, for aesthetic purposes.
    
    Specified by:
    
    wanderCheckedAway in interface TrackingLibrary
    
    Parameters:
    
    M - the mob to leave
    
    mindPCs - true to NOT leave if pcs are present
    
    andGoHome - true to be transported to start room
    
    Returns:
    
    true if this was successful, and false otherwise
    
    See Also:
    
    TrackingLibrary.wanderAway(MOB, boolean, boolean), TrackingLibrary.wanderCheckedFromTo(MOB, Room, boolean), TrackingLibrary.wanderFromTo(MOB, Room, boolean), TrackingLibrary.wanderIn(MOB, Room), TrackingLibrary.markToWanderHomeLater(MOB, int), TrackingLibrary.forceRecall(MOB, boolean)
  - wanderFromTo
```
public void wanderFromTo(MOB M,
                         Room toHere,
                         boolean mindPCs)
```
    Description copied from interface: TrackingLibrary
    
    Aesthetically transports a mob from their location to a target room by having them leave their current room legitimately, and enter the target one.
    
    Specified by:
    
    wanderFromTo in interface TrackingLibrary
    
    Parameters:
    
    M - the mob to move
    
    toHere - the destination room
    
    mindPCs - true to not leave if pcs are present
    
    See Also:
    
    TrackingLibrary.wanderAway(MOB, boolean, boolean), TrackingLibrary.wanderCheckedAway(MOB, boolean, boolean), TrackingLibrary.wanderCheckedFromTo(MOB, Room, boolean), TrackingLibrary.wanderIn(MOB, Room), TrackingLibrary.markToWanderHomeLater(MOB, int), TrackingLibrary.forceRecall(MOB, boolean)
  - getCheckedDir
```
protected int getCheckedDir(MOB M,
                            Room toHere)
```
  - wanderCheckedFromTo
```
public boolean wanderCheckedFromTo(MOB M,
                                   Room toHere,
                                   boolean mindPCs)
```
    Description copied from interface: TrackingLibrary
    
    Aesthetically transports a mob from their location to a target room by having them leave their current room legitimately, and enter the target one. Will optionally abort if PCs are present.
    
    Specified by:
    
    wanderCheckedFromTo in interface TrackingLibrary
    
    Parameters:
    
    M - the mob to move
    
    toHere - the target room
    
    mindPCs - true to not leave if pcs are present
    
    Returns:
    
    true if the movement was successful
    
    See Also:
    
    TrackingLibrary.wanderAway(MOB, boolean, boolean), TrackingLibrary.wanderCheckedAway(MOB, boolean, boolean), TrackingLibrary.wanderFromTo(MOB, Room, boolean), TrackingLibrary.wanderIn(MOB, Room), TrackingLibrary.markToWanderHomeLater(MOB, int), TrackingLibrary.forceRecall(MOB, boolean)
  - wanderIn
```
public void wanderIn(MOB M,
                     Room toHere)
```
    Description copied from interface: TrackingLibrary
    
    Aesthetically transports a mob from their location to a target room by having them leave their current room legitimately, and enter the target one. It will force them to enter if necessary.
    
    Specified by:
    
    wanderIn in interface TrackingLibrary
    
    Parameters:
    
    M - the mob to move
    
    toHere - the destination room
    
    See Also:
    
    TrackingLibrary.wanderAway(MOB, boolean, boolean), TrackingLibrary.wanderCheckedAway(MOB, boolean, boolean), TrackingLibrary.wanderCheckedFromTo(MOB, Room, boolean), TrackingLibrary.wanderFromTo(MOB, Room, boolean), TrackingLibrary.markToWanderHomeLater(MOB, int), TrackingLibrary.forceRecall(MOB, boolean)
  - forceEntry
```
protected void forceEntry(MOB M,
                          Room toHere,
                          boolean andFollowers,
                          boolean forceLook,
                          java.lang.String msg)
```
  - walkForced
```
public void walkForced(MOB M,
                       Room fromHere,
                       Room toHere,
                       boolean andFollowers,
                       boolean forceLook,
                       java.lang.String msgStr)
```
    Description copied from interface: TrackingLibrary
    
    Forces the given mob to leave the from room and enter to the room, without preview.
    
    Specified by:
    
    walkForced in interface TrackingLibrary
    
    Parameters:
    
    M - the mob who needs to move
    
    fromHere - the room left
    
    toHere - the room entered
    
    andFollowers - true to include followers
    
    forceLook - true to force the mob to look around after entering the new room
    
    msgStr - the entering message string
    
    See Also:
    
    TrackingLibrary.beMobile(MOB, boolean, boolean, boolean, boolean, int[], Set), TrackingLibrary.walk(Item, int), TrackingLibrary.walk(MOB, int, boolean, boolean), TrackingLibrary.walk(MOB, int, boolean, boolean, boolean), TrackingLibrary.walk(MOB, int, boolean, boolean, boolean, boolean), TrackingLibrary.run(MOB, int, boolean, boolean, boolean), TrackingLibrary.run(MOB, int, boolean, boolean, boolean, boolean)
  - doFallenOffCheck
```
public boolean doFallenOffCheck(MOB mob)
```
    Description copied from interface: TrackingLibrary
    
    If the given mob is riding anything, this will schedule a check to see if it is STILL riding. This must be done on the mobs tick because boats dont tick.
    
    Specified by:
    
    doFallenOffCheck in interface TrackingLibrary
    
    Parameters:
    
    mob - the mob to check
    
    Returns:
    
    n/a
  - ridersBehind
```
public void ridersBehind(java.util.List<Rider> riders,
                         Room sourceRoom,
                         Room destRoom,
                         int directionCode,
                         boolean flee,
                         boolean running)
```
  - addRiders
```
public static java.util.List<Rider> addRiders(Rider theRider,
                                              Rideable riding,
                                              java.util.List<Rider> riders)
```
  - createNavigationMob
```
public MOB createNavigationMob(NavigableItem ship)
```
    Description copied from interface: TrackingLibrary
    
    When large sailing ships or caravans navigate from room to room, a fake temporary mob is used to represent the agency of the ship per se. This will create that mob. The mob MUST be destroyed after use.
    
    Specified by:
    
    createNavigationMob in interface TrackingLibrary
    
    Parameters:
    
    ship - the navigable ship
    
    Returns:
    
    the mob to use, then destroy
  - ridersAhead
```
public java.util.List<Rider> ridersAhead(Rider theRider,
                                         Room sourceRoom,
                                         Room destRoom,
                                         int directionCode,
                                         boolean flee,
                                         boolean running)
```
  - walk
```
public boolean walk(MOB mob,
                    int directionCode,
                    boolean flee,
                    boolean nolook,
                    boolean noriders)
```
    Description copied from interface: TrackingLibrary
    
    Causes the given mob to attempt to walk in the given direction.
    
    Specified by:
    
    walk in interface TrackingLibrary
    
    Parameters:
    
    mob - the mob who needs to move
    
    directionCode - the direction to walk
    
    flee - true to generate a FLEE from combat message
    
    nolook - true to avoid looking around when entering the next room
    
    noriders - true to prevent rideables being involved
    
    Returns:
    
    true if the movement was successful
    
    See Also:
    
    TrackingLibrary.beMobile(MOB, boolean, boolean, boolean, boolean, int[], Set), TrackingLibrary.walk(Item, int), TrackingLibrary.walk(MOB, int, boolean, boolean), TrackingLibrary.walk(MOB, int, boolean, boolean, boolean, boolean), TrackingLibrary.walkForced(MOB, Room, Room, boolean, boolean, String), TrackingLibrary.run(MOB, int, boolean, boolean, boolean), TrackingLibrary.run(MOB, int, boolean, boolean, boolean, boolean)
  - run
```
public boolean run(MOB mob,
                   int directionCode,
                   boolean flee,
                   boolean nolook,
                   boolean noriders)
```
    Description copied from interface: TrackingLibrary
    
    Causes the given mob to attempt to run in the given direction.
    
    Specified by:
    
    run in interface TrackingLibrary
    
    Parameters:
    
    mob - the mob who needs to move
    
    directionCode - the direction to walk
    
    flee - true to generate a FLEE from combat message
    
    nolook - true to avoid looking around when entering the next room
    
    noriders - true to prevent rideables being involved
    
    Returns:
    
    true if the movement was successful
    
    See Also:
    
    TrackingLibrary.beMobile(MOB, boolean, boolean, boolean, boolean, int[], Set), TrackingLibrary.walk(Item, int), TrackingLibrary.walk(MOB, int, boolean, boolean), TrackingLibrary.walk(MOB, int, boolean, boolean, boolean), TrackingLibrary.walk(MOB, int, boolean, boolean, boolean, boolean), TrackingLibrary.walkForced(MOB, Room, Room, boolean, boolean, String), TrackingLibrary.run(MOB, int, boolean, boolean, boolean, boolean)
  - walk
```
public boolean walk(MOB mob,
                    int directionCode,
                    boolean flee,
                    boolean nolook,
                    boolean noriders,
                    boolean always)
```
    Description copied from interface: TrackingLibrary
    
    Causes the given mob to attempt to walk in the given direction.
    
    Specified by:
    
    walk in interface TrackingLibrary
    
    Parameters:
    
    mob - the mob who needs to move
    
    directionCode - the direction to walk
    
    flee - true to generate a FLEE from combat message
    
    nolook - true to avoid looking around when entering the next room
    
    noriders - true to prevent rideables being involved
    
    always - true to set the always message flag, preventing preventative checks
    
    Returns:
    
    true if the movement was successful
    
    See Also:
    
    TrackingLibrary.beMobile(MOB, boolean, boolean, boolean, boolean, int[], Set), TrackingLibrary.walk(Item, int), TrackingLibrary.walk(MOB, int, boolean, boolean), TrackingLibrary.walk(MOB, int, boolean, boolean, boolean), TrackingLibrary.walkForced(MOB, Room, Room, boolean, boolean, String), TrackingLibrary.run(MOB, int, boolean, boolean, boolean), TrackingLibrary.run(MOB, int, boolean, boolean, boolean, boolean)
  - run
```
public boolean run(MOB mob,
                   int directionCode,
                   boolean flee,
                   boolean nolook,
                   boolean noriders,
                   boolean always)
```
    Description copied from interface: TrackingLibrary
    
    Causes the given mob to attempt to run in the given direction.
    
    Specified by:
    
    run in interface TrackingLibrary
    
    Parameters:
    
    mob - the mob who needs to move
    
    directionCode - the direction to walk
    
    flee - true to generate a FLEE from combat message
    
    nolook - true to avoid looking around when entering the next room
    
    noriders - true to prevent rideables being involved
    
    always - true to set the always message flag, preventing preventative checks
    
    Returns:
    
    true if the movement was successful
    
    See Also:
    
    TrackingLibrary.beMobile(MOB, boolean, boolean, boolean, boolean, int[], Set), TrackingLibrary.walk(Item, int), TrackingLibrary.walk(MOB, int, boolean, boolean), TrackingLibrary.walk(MOB, int, boolean, boolean, boolean), TrackingLibrary.walk(MOB, int, boolean, boolean, boolean, boolean), TrackingLibrary.walkForced(MOB, Room, Room, boolean, boolean, String), TrackingLibrary.run(MOB, int, boolean, boolean, boolean)
  - move
```
protected boolean move(MOB mob,
                       int directionCode,
                       boolean flee,
                       boolean nolook,
                       boolean noriders,
                       boolean always,
                       boolean running)
```
  - walk
```
public boolean walk(MOB mob,
                    int directionCode,
                    boolean flee,
                    boolean nolook)
```
    Description copied from interface: TrackingLibrary
    
    Causes the given mob to attempt to walk in the given direction.
    
    Specified by:
    
    walk in interface TrackingLibrary
    
    Parameters:
    
    mob - the mob who needs to move
    
    directionCode - the direction to walk
    
    flee - true to generate a FLEE from combat message
    
    nolook - true to avoid looking around when entering the next room
    
    Returns:
    
    true if the movement was successful
    
    See Also:
    
    TrackingLibrary.beMobile(MOB, boolean, boolean, boolean, boolean, int[], Set), TrackingLibrary.walk(Item, int), TrackingLibrary.walk(MOB, int, boolean, boolean, boolean), TrackingLibrary.walk(MOB, int, boolean, boolean, boolean, boolean), TrackingLibrary.walkForced(MOB, Room, Room, boolean, boolean, String), TrackingLibrary.run(MOB, int, boolean, boolean, boolean), TrackingLibrary.run(MOB, int, boolean, boolean, boolean, boolean)
  - walk
```
public boolean walk(Item I,
                    int directionCode)
```
    Description copied from interface: TrackingLibrary
    
    Narrates the movement of an item, usually a rideable, in a given direction, from its current location. Will move as a rideable with riders if possible.
    
    Specified by:
    
    walk in interface TrackingLibrary
    
    Parameters:
    
    I - the item to move
    
    directionCode - the direction to walk
    
    Returns:
    
    true if the movement was successful
    
    See Also:
    
    TrackingLibrary.beMobile(MOB, boolean, boolean, boolean, boolean, int[], Set), TrackingLibrary.walk(MOB, int, boolean, boolean), TrackingLibrary.walk(MOB, int, boolean, boolean, boolean), TrackingLibrary.walk(MOB, int, boolean, boolean, boolean, boolean), TrackingLibrary.walkForced(MOB, Room, Room, boolean, boolean, String), TrackingLibrary.run(MOB, int, boolean, boolean, boolean), TrackingLibrary.run(MOB, int, boolean, boolean, boolean, boolean)
  - findExitDir
```
public int findExitDir(MOB mob,
                       Room R,
                       java.lang.String desc)
```
    Description copied from interface: TrackingLibrary
    
    Given a mob with eyes, and their location, and a match string, this will attempt to match one of the exits and return it. It does not check direction codes, it must be an exit name-like match.
    
    Specified by:
    
    findExitDir in interface TrackingLibrary
    
    Parameters:
    
    mob - the mob who needs to move
    
    R - the room to find exits in
    
    desc - the exit match string
    
    Returns:
    
    null, or the exit direction
  - findRoomDir
```
public int findRoomDir(MOB mob,
                       Room R)
```
    Description copied from interface: TrackingLibrary
    
    Given a mob and a room, returns the direction from the mobs direction to the target room, if possible.
    
    Specified by:
    
    findRoomDir in interface TrackingLibrary
    
    Parameters:
    
    mob - the mob
    
    R - the target room
    
    Returns:
    
    the direction or -1
  - getShortestTrail
```
public java.util.List<java.lang.Integer> getShortestTrail(java.util.List<java.util.List<java.lang.Integer>> finalSets)
```
    Description copied from interface: TrackingLibrary
    
    Does nothing interesting. Just returns the shortest list of integers given a list of lists.
    
    Specified by:
    
    getShortestTrail in interface TrackingLibrary
    
    Parameters:
    
    finalSets - the shorted list > 0
    
    Returns:
    
    the shortest list.
    
    See Also:
    
    TrackingLibrary.findAllTrails(Room, List, List), TrackingLibrary.findAllTrails(Room, Room, List), TrackingLibrary.findTrailToAnyRoom(Room, List, TrackingFlags, int), TrackingLibrary.findTrailToAnyRoom(Room, RFilter, TrackingFlags, int), TrackingLibrary.findTrailToRoom(Room, Room, TrackingFlags, int), TrackingLibrary.findTrailToRoom(Room, Room, TrackingFlags, int, List), TrackingLibrary.getTrailToDescription(Room, List, String, Set, int, Set, int), TrackingLibrary.canValidTrail(Room, List, String, int, Set, int)
  - findAllTrails
```
public java.util.List<java.util.List<java.lang.Integer>> findAllTrails(Room from,
                                                                       Room to,
                                                                       java.util.List<Room> radiantTrail)
```
    Description copied from interface: TrackingLibrary
    
    Returns every trail found from the starting to the ending room, given a radiantTrail that includes both. The trails will have the direction from starting room first. Providing radiant rooms is required, and they should have the location first and destination last.
    
    Specified by:
    
    findAllTrails in interface TrackingLibrary
    
    Parameters:
    
    from - the starting room
    
    to - the target room
    
    radiantTrail - the radiant rooms from the starting room
    
    Returns:
    
    the set of all valid trails, as directions
    
    See Also:
    
    TrackingLibrary.findAllTrails(Room, List, List), TrackingLibrary.findTrailToAnyRoom(Room, List, TrackingFlags, int), TrackingLibrary.findTrailToAnyRoom(Room, RFilter, TrackingFlags, int), TrackingLibrary.findTrailToRoom(Room, Room, TrackingFlags, int), TrackingLibrary.findTrailToRoom(Room, Room, TrackingFlags, int, List), TrackingLibrary.getShortestTrail(List), TrackingLibrary.getTrailToDescription(Room, List, String, Set, int, Set, int), TrackingLibrary.canValidTrail(Room, List, String, int, Set, int)
  - findAllTrails
```
public java.util.List<java.util.List<java.lang.Integer>> findAllTrails(Room from,
                                                                       java.util.List<Room> tos,
                                                                       java.util.List<Room> radiantTrail)
```
    Description copied from interface: TrackingLibrary
    
    Returns every trail found from the starting to each ending room, given a radiantTrail that includes all. The trails will have the direction from starting room first. Providing radiant rooms is required, and they should have the location first and destination last.
    
    Specified by:
    
    findAllTrails in interface TrackingLibrary
    
    Parameters:
    
    from - the starting room
    
    tos - the target rooms
    
    radiantTrail - the radiant rooms from the starting room
    
    Returns:
    
    the set of all valid trails, as directions
    
    See Also:
    
    TrackingLibrary.findAllTrails(Room, Room, List), TrackingLibrary.findTrailToAnyRoom(Room, List, TrackingFlags, int), TrackingLibrary.findTrailToAnyRoom(Room, RFilter, TrackingFlags, int), TrackingLibrary.findTrailToRoom(Room, Room, TrackingFlags, int), TrackingLibrary.findTrailToRoom(Room, Room, TrackingFlags, int, List), TrackingLibrary.getShortestTrail(List), TrackingLibrary.getTrailToDescription(Room, List, String, Set, int, Set, int), TrackingLibrary.canValidTrail(Room, List, String, int, Set, int)
  - getRoomDirection
```
protected int getRoomDirection(Room R,
                               Room toRoom,
                               java.util.List<Room> ignore)
```
  - getWhere
```
protected Room getWhere(java.lang.String where,
                        java.util.List<Room> set)
```
  - getIndexEnsureSet
```
protected int getIndexEnsureSet(Room R1,
                                Room R2,
                                java.util.List<Room> set,
                                int radius,
                                java.util.Set<Room> ignoreRooms)
```
  - canValidTrail
```
public boolean canValidTrail(Room startR,
                             java.util.List<Room> radiantV,
                             java.lang.String where,
                             int radius,
                             java.util.Set<Room> ignoreRooms,
                             int maxSecs)
```
    Description copied from interface: TrackingLibrary
    
    Searches for a room fitting to the given search string, within the given radiant rooms, with a trail fitting the given trail flags, optionally ignoring any ignore rooms. Returns whether there is a trail from the start room to the target, or not. Can also have a time limit on finding the way.
    
    Specified by:
    
    canValidTrail in interface TrackingLibrary
    
    Parameters:
    
    startR - the starting room
    
    radiantV - the complete radiant rooms
    
    where - the target to search for
    
    radius - the maximum radius to travel
    
    ignoreRooms - optional set of rooms to ignore in the trail
    
    maxSecs - maximum seconds to keep looking for trail
    
    Returns:
    
    true if you can get from here to there
    
    See Also:
    
    TrackingLibrary.findAllTrails(Room, List, List), TrackingLibrary.findAllTrails(Room, Room, List), TrackingLibrary.findTrailToAnyRoom(Room, List, TrackingFlags, int), TrackingLibrary.findTrailToAnyRoom(Room, RFilter, TrackingFlags, int), TrackingLibrary.findTrailToRoom(Room, Room, TrackingFlags, int), TrackingLibrary.findTrailToRoom(Room, Room, TrackingFlags, int, List), TrackingLibrary.getShortestTrail(List), TrackingLibrary.getTrailToDescription(Room, List, String, Set, int, Set, int)
  - getTrailToDescription
```
public java.lang.String getTrailToDescription(Room startR,
                                              java.util.List<Room> radiantV,
                                              java.lang.String where,
                                              java.util.Set<TrackingLibrary.TrailFlag> trailFlags,
                                              int radius,
                                              java.util.Set<Room> ignoreRooms,
                                              int maxSecs)
```
    Description copied from interface: TrackingLibrary
    
    Searches for a room fitting to the given search string, within the given radiant rooms, with a trail fitting the given trail flags, optionally ignoring any ignore rooms. Returns a descriptions of the turns and movements from the start room to the target, or null. Can also have a time limit on finding the way.
    
    Specified by:
    
    getTrailToDescription in interface TrackingLibrary
    
    Parameters:
    
    startR - the starting room
    
    radiantV - the complete radiant rooms
    
    where - the target to search for
    
    trailFlags - the flags for rooms to travel through
    
    radius - the maximum radius to travel
    
    ignoreRooms - optional set of rooms to ignore in the trail
    
    maxSecs - maximum seconds to keep looking for trail
    
    Returns:
    
    the description of the way to get there
    
    See Also:
    
    TrackingLibrary.findAllTrails(Room, List, List), TrackingLibrary.findAllTrails(Room, Room, List), TrackingLibrary.findTrailToAnyRoom(Room, List, TrackingFlags, int), TrackingLibrary.findTrailToAnyRoom(Room, RFilter, TrackingFlags, int), TrackingLibrary.findTrailToRoom(Room, Room, TrackingFlags, int), TrackingLibrary.findTrailToRoom(Room, Room, TrackingFlags, int, List), TrackingLibrary.getShortestTrail(List), TrackingLibrary.canValidTrail(Room, List, String, int, Set, int)
  - findALadder
```
public Rideable findALadder(MOB mob,
                            Room room)
```
    Description copied from interface: TrackingLibrary
    
    If theres a ladder that can be seen in the same room as the given mob, this returns it.
    
    Specified by:
    
    findALadder in interface TrackingLibrary
    
    Parameters:
    
    mob - the mob who wants a ladder
    
    room - the room that might have a ladder in it
    
    Returns:
    
    null, or the ladder
    
    See Also:
    
    TrackingLibrary.postMountLadder(MOB, Rideable)
  - postMountLadder
```
public void postMountLadder(MOB mob,
                            Rideable ladder)
```
    Description copied from interface: TrackingLibrary
    
    Causes the given mob to mount the given ladder. So they can ride it up, presumably.
    
    Specified by:
    
    postMountLadder in interface TrackingLibrary
    
    Parameters:
    
    mob - the mob who wants to use a ladder
    
    ladder - the ladder
    
    See Also:
    
    TrackingLibrary.findALadder(MOB, Room)
  - makeFall
```
public boolean makeFall(Physical P,
                        Room room,
                        boolean reverseFall)
```
    Description copied from interface: TrackingLibrary
    
    Causes the given mob or item to 'fall' from one room to another, usually down, if it can.
    
    Specified by:
    
    makeFall in interface TrackingLibrary
    
    Parameters:
    
    P - the thing to fall
    
    room - the things location
    
    reverseFall - true to fall UP instead of down
    
    Returns:
    
    true if falling was started, false otherwise
  - isOkWaterSurfaceAffect
```
public CMMsg.CheckedMsgResponse isOkWaterSurfaceAffect(Room room,
                                                       CMMsg msg)
```
    Description copied from interface: TrackingLibrary
    
    Utility method for handling movement into a water surface type room. It receives the room being moved into or out of, and an event message to preview. It returns a Tri-State response: Either to approve immediately, fail immediately, or continue with any other checks.
    
    Specified by:
    
    isOkWaterSurfaceAffect in interface TrackingLibrary
    
    Parameters:
    
    room - the watery room an event occurred in
    
    msg - the event happening in the
    
    Returns:
    
    the state that the caller should respect.
  - makeSink
```
public void makeSink(Physical P,
                     Room room,
                     boolean reverseSink)
```
    Description copied from interface: TrackingLibrary
    
    Causes the given mob or item to 'sink' from one room to another, usually down, if it can.
    
    Specified by:
    
    makeSink in interface TrackingLibrary
    
    Parameters:
    
    P - the thing to fall
    
    room - the things location
    
    reverseSink - true to sink 'up'
  - forceRecall
```
public void forceRecall(MOB mob,
                        boolean includeFollowers)
```
    Description copied from interface: TrackingLibrary
    
    Attempts to recall the given mob, and optinally all their followers, by generating a recall message and previewing and sending it.
    
    Specified by:
    
    forceRecall in interface TrackingLibrary
    
    Parameters:
    
    mob - the mob to move
    
    includeFollowers - true to also recall followers
    
    See Also:
    
    TrackingLibrary.wanderAway(MOB, boolean, boolean), TrackingLibrary.wanderCheckedAway(MOB, boolean, boolean), TrackingLibrary.wanderCheckedFromTo(MOB, Room, boolean), TrackingLibrary.wanderFromTo(MOB, Room, boolean), TrackingLibrary.wanderIn(MOB, Room), TrackingLibrary.markToWanderHomeLater(MOB, int)
  - buildGridList
```
public PairVector<Room,int[]> buildGridList(Room room,
                                            java.lang.String ownerName,
                                            int maxDepth)
```
    Description copied from interface: TrackingLibrary
    
    Builts a radiating room list that is assumed to be in grid formation, and owned as private property. The list of rooms is returned with their relative grid position to the starting room. Only rooms owned by the given owner, if given, are returned.
    
    Specified by:
    
    buildGridList in interface TrackingLibrary
    
    Parameters:
    
    room - the starting room
    
    ownerName - "", or the owner of the rooms to return
    
    maxDepth - the max depth to radiate
    
    Returns:
    
    the list of rooms and grid information
    
    See Also:
    
    TrackingLibrary.getCalculatedAdjacentGridRoom(PairVector, Room, int)
  - getCalculatedAdjacentGridRoom
```
public Room getCalculatedAdjacentGridRoom(PairVector<Room,int[]> rooms,
                                          Room R,
                                          int dir)
```
    Description copied from interface: TrackingLibrary
    
    Given a set of rooms built with grid coordinates, and a starting room inside that grid, and a direction, this will return the adjacent room based on the built grid.
    
    Specified by:
    
    getCalculatedAdjacentGridRoom in interface TrackingLibrary
    
    Parameters:
    
    rooms - the built grid array of rooms and locations
    
    R - the room to start from
    
    dir - the direction to inquire about
    
    Returns:
    
    the room in that direction, or null
    
    See Also:
    
    TrackingLibrary.buildGridList(Room, String, int)
  - initializeClass
```
public void initializeClass()
```
    Description copied from interface: CMObject
    
    Called ONCE after all objects are loaded, but before the map is read in during initialization.
    
    Specified by:
    
    initializeClass in interface CMObject
    
    Overrides:
    
    initializeClass in class StdLibrary

Class MUDTracker

Nested Class Summary

Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.TrackingLibrary

Field Summary

Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

Fields inherited from class com.planet_ink.coffee_mud.Libraries.StdLibrary

Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.Tickable

Constructor Summary

Method Summary

Methods inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.CMLibrary

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

Methods inherited from interface java.lang.Comparable

Methods inherited from class java.lang.Object

Methods inherited from class com.planet_ink.coffee_mud.Libraries.StdLibrary

Field Detail

directionCommandSets

openCommandSets

closeCommandSets

trackingFilters

EMPTY_FLAGS

EMPTY_FILTERS

emptyFilter

validIDFilter

Constructor Detail

MUDTracker

Method Detail

ID

autoTrack

getDirectionCommandSet

getOpenCommandSet

getCloseCommandSet

findTrailToRoom

findTrailToRoom

markToWanderHomeLater

findTrailToAnyRoom

findTrailToAnyRoom

trackNextDirectionFromHere

radiatesFromDir

getRadiantRooms

getRadiantRooms

getRadiantAreas

getRadiantRooms

newFlags

getRadiantRooms

getRadiantAreas

getRadiantRoomsEnum

getRadiantRoomsToTarget

getRadiantRoomsToTarget

getRadiantRoomTarget

getNearestValidIDRoom

stopTracking

beMobile

wanderAway

areNearEachOther

wanderCheckedAway

wanderFromTo

getCheckedDir

wanderCheckedFromTo

wanderIn

forceEntry

walkForced

doFallenOffCheck

ridersBehind

addRiders

createNavigationMob

ridersAhead

walk

run

walk

run

move

walk

walk

findExitDir

findRoomDir

getShortestTrail

findAllTrails

findAllTrails

getRoomDirection

getWhere