Package com.planet_ink.coffee_mud.Libraries.interfaces

Interface TrackingLibrary.RFilters

All Known Implementing Classes:

MUDTracker.DefaultRFilters, StdThinInstance.AllWaterFilters, StdThinInstance.EmptyFilters

Enclosing interface:

TrackingLibrary

public static interface TrackingLibrary.RFilters

A filtering interface for rooms, or for moving from a host room to a target room. Consists of one or more smaller filters, all checked in sequence.

Method Summary

Modifier and Type	Method	Description
TrackingLibrary.RFilters	copyOf()	Make a copy of this filter.
boolean	isFilteredOut(Room hostR, Room R, Exit E, int dir)	The room in question is always the second one, "R".
TrackingLibrary.RFilters	minus(TrackingLibrary.RFilter filter)	Del a filter from this filter set.
TrackingLibrary.RFilters	plus(TrackingLibrary.RFilter filter)	Add a new filter to this filter set.

Method Detail

isFilteredOut

boolean isFilteredOut(Room hostR,
                      Room R,
                      Exit E,
                      int dir)

The room in question is always the second one, "R". The hostR is a room being travelled from, and is optional. The exit and direction are the travelling means, if any.

Parameters:

hostR - the starting room

R - the room being filtered, and the target room

E - the exit from the host to target room

dir - the direction from host to target room

Returns:

true if the room is to be skipped, or false otherwise

plus

TrackingLibrary.RFilters plus(TrackingLibrary.RFilter filter)

Add a new filter to this filter set.

Parameters:

filter - the new filter

Returns:

the filter set

minus

TrackingLibrary.RFilters minus(TrackingLibrary.RFilter filter)

Del a filter from this filter set.

Parameters:

filter - the old filter

Returns:

the filter set

copyOf

TrackingLibrary.RFilters copyOf()

Make a copy of this filter.

Returns:

the filter set