Package com.planet_ink.coffee_mud.Libraries.interfaces

Interface WorldHuntLibrary

All Superinterfaces:

java.lang.Cloneable, CMLibrary, CMObject, java.lang.Comparable<CMObject>

All Known Implementing Classes:

WorldHuntUtils

public interface WorldHuntLibrary
extends CMLibrary

Utility library for global map searches.

Field Summary

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

idConverter

Method Summary

Modifier and Type	Method	Description
Room	findAreaRoomLiberally(MOB mob, Area A, java.lang.String cmd, java.lang.String srchWhatAERIPMVK, int timePct)	Given an area, searches the rooms liberally and returns the first room with a match.
java.util.List<Room>	findAreaRoomsLiberally(MOB mob, Area A, java.lang.String cmd, java.lang.String srchWhatAERIPMVK, int timePct)	Given an area, searches the rooms liberally and returns all rooms with a match.
MOB	findFirstInhabitant(java.util.Enumeration<Room> rooms, MOB mob, java.lang.String srchStr, int timePct)	Finds the first matched mob in the rooms of the given room enumerator.
Item	findFirstInventory(java.util.Enumeration<Room> rooms, MOB mob, java.lang.String srchStr, int timePct)	Finds the first matched item in the inventory of mobs in the given room enumerator, or in the inventory of players if null rooms are given.
Room	findFirstRoom(java.util.Enumeration<Room> rooms, MOB mob, java.lang.String srchStr, boolean displayOnly, int timePct)	Finds the first matched room in the rooms of the given room enumerator.
Item	findFirstRoomItem(java.util.Enumeration<Room> rooms, MOB mob, java.lang.String srchStr, boolean anyItems, int timePct)	Finds the first matched item in the rooms of the given room enumerator.
Environmental	findFirstShopStock(java.util.Enumeration<Room> rooms, MOB mob, java.lang.String srchStr, int timePct)	Finds the first matched stock item in the shops of shopkeepeers in the given room enumerator.
Environmental	findFirstShopStocker(java.util.Enumeration<Room> rooms, MOB mob, java.lang.String srchStr, int timePct)	Finds the first shopkeeper from the given room enumerator and given mob room accessor who has a shop stock item matching the given hunt search string.
java.util.List<MOB>	findInhabitants(java.util.Enumeration<Room> rooms, MOB mob, java.lang.String srchStr, int timePct)	Finds all the matched mobs in the rooms in the given room enumerator.
java.util.List<MOB>	findInhabitantsFavorExact(java.util.Enumeration<Room> rooms, MOB mob, java.lang.String srchStr, boolean returnFirst, int timePct)	Finds the matched mobs in the rooms in the given room enumerator.
java.util.List<Item>	findInventory(java.util.Enumeration<Room> rooms, MOB mob, java.lang.String srchStr, int timePct)	Finds all matched items in the inventory of mobs in the given room enumerator, or in the inventory of players if null rooms are given.
java.util.List<Item>	findRoomItems(java.util.Enumeration<Room> rooms, MOB mob, java.lang.String srchStr, boolean anyItems, int timePct)	Finds all the matched items in the rooms in the given room enumerator.
java.util.List<Room>	findRooms(java.util.Enumeration<Room> rooms, MOB mob, java.lang.String srchStr, boolean displayOnly, int timePct)	Finds all the matched rooms in the rooms in the given room enumerator.
java.util.List<Environmental>	findShopStock(java.util.Enumeration<Room> rooms, MOB mob, java.lang.String srchStr, int timePct)	Finds all the matched stock item in the shops of shopkeepeers in the given room enumerator.
java.util.List<Environmental>	findShopStockers(java.util.Enumeration<Room> rooms, MOB mob, java.lang.String srchStr, int timePct)	Finds all shopkeepers from the given room enumerator and given mob room accessor who has a shop stock item matching the given hunt search string.
Room	findWorldRoomLiberally(MOB mob, java.lang.String cmd, java.lang.String srchWhatAERIPMVK, int timePct, long maxMillis)	Searches the whole world's rooms liberally and returns the first room with a match.
java.util.List<Room>	findWorldRoomsLiberally(MOB mob, java.lang.String cmd, java.lang.String srchWhatAERIPMVK, int timePct, long maxMillis)	Searches the whole world's rooms liberally and returns all rooms with a match.
java.util.Set<Physical>	getAllGroupRiders(Physical P, Room hereOnlyR)	Gets the entire party -- group members, ridden things, followed and things riding them, etc, etc.
boolean	isAnAdminHere(Room R, boolean sysMsgsOnly)	Returns whether an authorized room or mob editor is in the room, optionally with sysmsgs turned on.
boolean	isHere(CMObject E2, Area here)	Returns whether the given object is in the given area.
boolean	isHere(CMObject E2, Room here)	Returns whether the given object is in the given room.

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, ID, initializeClass, name, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

findWorldRoomsLiberally

java.util.List<Room> findWorldRoomsLiberally(MOB mob,
                                             java.lang.String cmd,
                                             java.lang.String srchWhatAERIPMVK,
                                             int timePct,
                                             long maxMillis)

Searches the whole world's rooms liberally and returns all rooms with a match. Liberal codes are: wE)ak areas, strict A)areas, R)rooms, P)layers, room I)tems, M)obs, inV)entory, shop stocK)s.

Parameters:

mob - the mob whose room access to respect

cmd - the search string

srchWhatAERIPMVK - the librarl codes for what to search

timePct - % of a second to keep searching between rooms, 100% is full time

maxMillis - maximum amount of time to search before aborting

Returns:

the matching rooms

findWorldRoomLiberally

Room findWorldRoomLiberally(MOB mob,
                            java.lang.String cmd,
                            java.lang.String srchWhatAERIPMVK,
                            int timePct,
                            long maxMillis)

Searches the whole world's rooms liberally and returns the first room with a match. Liberal codes are: wE)ak areas, strict A)areas, R)rooms, P)layers, room I)tems, M)obs, inV)entory, shop stocK)s.

Parameters:

mob - the mob whose room access to respect

cmd - the search string

srchWhatAERIPMVK - the librarl codes for what to search

timePct - % of a second to keep searching between rooms, 100% is full time

maxMillis - maximum amount of time to search before aborting

Returns:

the first matching room

findAreaRoomsLiberally

java.util.List<Room> findAreaRoomsLiberally(MOB mob,
                                            Area A,
                                            java.lang.String cmd,
                                            java.lang.String srchWhatAERIPMVK,
                                            int timePct)

Given an area, searches the rooms liberally and returns all rooms with a match. Liberal codes are: wE)ak areas, strict A)areas, R)rooms, P)layers, room I)tems, M)obs, inV)entory, shop stocK)s.

Parameters:

mob - the mob whose room access to respect

A - the area to search

cmd - the search string

srchWhatAERIPMVK - the librarl codes for what to search

timePct - % of a second to keep searching between rooms, 100% is full time

Returns:

the first matching rooms

findAreaRoomLiberally

Room findAreaRoomLiberally(MOB mob,
                           Area A,
                           java.lang.String cmd,
                           java.lang.String srchWhatAERIPMVK,
                           int timePct)

Given an area, searches the rooms liberally and returns the first room with a match. Liberal codes are: wE)ak areas, strict A)areas, R)rooms, P)layers, room I)tems, M)obs, inV)entory, shop stocK)s.

Parameters:

mob - the mob whose room access to respect

A - the area to search

cmd - the search string

srchWhatAERIPMVK - the librarl codes for what to search

timePct - % of a second to keep searching between rooms, 100% is full time

Returns:

the first matching room

findRooms

java.util.List<Room> findRooms(java.util.Enumeration<Room> rooms,
                               MOB mob,
                               java.lang.String srchStr,
                               boolean displayOnly,
                               int timePct)

Finds all the matched rooms in the rooms in the given room enumerator.

Parameters:

rooms - the rooms with mobs to search

mob - the mob whose room access to confirm

srchStr - the search string, using full world hunt rules

displayOnly - true to search only display, and skip description

timePct - % of a second to keep searching between rooms, 100% is full time

Returns:

the found room rooms

findFirstRoom

Room findFirstRoom(java.util.Enumeration<Room> rooms,
                   MOB mob,
                   java.lang.String srchStr,
                   boolean displayOnly,
                   int timePct)

Finds the first matched room in the rooms of the given room enumerator.

Parameters:

rooms - the rooms to search

mob - the mob whose room access to confirm

srchStr - the search string, using full world hunt rules

displayOnly - true to search only display, and skip description

timePct - % of a second to keep searching between rooms, 100% is full time

Returns:

null, or the first room

findFirstInhabitant

MOB findFirstInhabitant(java.util.Enumeration<Room> rooms,
                        MOB mob,
                        java.lang.String srchStr,
                        int timePct)

Finds the first matched mob in the rooms of the given room enumerator.

Parameters:

rooms - the rooms to search

mob - the mob whose room access to confirm

srchStr - the search string, using full world hunt rules

timePct - % of a second to keep searching between rooms, 100% is full time

Returns:

null, or the first room mob

findInhabitantsFavorExact

java.util.List<MOB> findInhabitantsFavorExact(java.util.Enumeration<Room> rooms,
                                              MOB mob,
                                              java.lang.String srchStr,
                                              boolean returnFirst,
                                              int timePct)

Finds the matched mobs in the rooms in the given room enumerator. If any exact matches are found, those are returned. Otherwise, the slightly looser matches are all returned.

Parameters:

rooms - the rooms with mobs to search

mob - the mob whose room access to confirm

srchStr - the search string, using full world hunt rules

returnFirst - true to return only 1 match, false for all

timePct - % of a second to keep searching between rooms, 100% is full time

Returns:

the found room mobs

findInhabitants

java.util.List<MOB> findInhabitants(java.util.Enumeration<Room> rooms,
                                    MOB mob,
                                    java.lang.String srchStr,
                                    int timePct)

Finds all the matched mobs in the rooms in the given room enumerator.

Parameters:

rooms - the rooms with mobs to search

mob - the mob whose room access to confirm

srchStr - the search string, using full world hunt rules

timePct - % of a second to keep searching between rooms, 100% is full time

Returns:

the found room mobs

findRoomItems

java.util.List<Item> findRoomItems(java.util.Enumeration<Room> rooms,
                                   MOB mob,
                                   java.lang.String srchStr,
                                   boolean anyItems,
                                   int timePct)

Finds all the matched items in the rooms in the given room enumerator.

Parameters:

rooms - the rooms with mobs to search

mob - the mob whose room access to confirm

srchStr - the search string, using full world hunt rules

anyItems - true to include container searches, false for non-contained only

timePct - % of a second to keep searching between rooms, 100% is full time

Returns:

the found room items

findFirstRoomItem

Item findFirstRoomItem(java.util.Enumeration<Room> rooms,
                       MOB mob,
                       java.lang.String srchStr,
                       boolean anyItems,
                       int timePct)

Finds the first matched item in the rooms of the given room enumerator.

Parameters:

rooms - the rooms to search

mob - the mob whose room access to confirm

srchStr - the search string, using full world hunt rules

anyItems - true to include container searches, false for non-contained only

timePct - % of a second to keep searching between rooms, 100% is full time

Returns:

null, or the first room item

findShopStock

java.util.List<Environmental> findShopStock(java.util.Enumeration<Room> rooms,
                                            MOB mob,
                                            java.lang.String srchStr,
                                            int timePct)

Finds all the matched stock item in the shops of shopkeepeers in the given room enumerator.

Parameters:

rooms - the rooms with mobs to search

mob - the mob whose room access to confirm

srchStr - the search string, using full world hunt rules

timePct - % of a second to keep searching between rooms, 100% is full time

Returns:

the found stock items

findFirstShopStock

Environmental findFirstShopStock(java.util.Enumeration<Room> rooms,
                                 MOB mob,
                                 java.lang.String srchStr,
                                 int timePct)

Finds the first matched stock item in the shops of shopkeepeers in the given room enumerator.

Parameters:

rooms - the rooms with mobs to search

mob - the mob whose room access to confirm

srchStr - the search string, using full world hunt rules

timePct - % of a second to keep searching between rooms, 100% is full time

Returns:

null, or the first stock item

findShopStockers

java.util.List<Environmental> findShopStockers(java.util.Enumeration<Room> rooms,
                                               MOB mob,
                                               java.lang.String srchStr,
                                               int timePct)

Finds all shopkeepers from the given room enumerator and given mob room accessor who has a shop stock item matching the given hunt search string.

Parameters:

rooms - the rooms to iterate through

mob - the mob whose room access to confirm

srchStr - the search string, using full world hunt rules

timePct - % of a second to keep searching between rooms, 100% is full time

Returns:

the list of shopkeepers

findFirstShopStocker

Environmental findFirstShopStocker(java.util.Enumeration<Room> rooms,
                                   MOB mob,
                                   java.lang.String srchStr,
                                   int timePct)

Finds the first shopkeeper from the given room enumerator and given mob room accessor who has a shop stock item matching the given hunt search string.

Parameters:

rooms - the rooms to iterate through

mob - the mob whose room access to confirm

srchStr - the search string, using full world hunt rules

timePct - % of a second to keep searching between rooms, 100% is full time

Returns:

the first shopkeeper

findInventory

java.util.List<Item> findInventory(java.util.Enumeration<Room> rooms,
                                   MOB mob,
                                   java.lang.String srchStr,
                                   int timePct)

Finds all matched items in the inventory of mobs in the given room enumerator, or in the inventory of players if null rooms are given.

Parameters:

rooms - null for players, or the rooms with mobs to search

mob - the mob whose room access to confirm

srchStr - the search string, using full world hunt rules

timePct - % of a second to keep searching between rooms, 100% is full time

Returns:

null, or the found items

findFirstInventory

Item findFirstInventory(java.util.Enumeration<Room> rooms,
                        MOB mob,
                        java.lang.String srchStr,
                        int timePct)

Finds the first matched item in the inventory of mobs in the given room enumerator, or in the inventory of players if null rooms are given.

Parameters:

rooms - null for players, or the rooms with mobs to search

mob - the mob whose room access to confirm

srchStr - the search string, using full world hunt rules

timePct - % of a second to keep searching between rooms, 100% is full time

Returns:

null, or the first found item

isHere

boolean isHere(CMObject E2,
               Area here)

Returns whether the given object is in the given area.

Parameters:

E2 - the object to look for

here - the room to see if its in

Returns:

true if the object is in the area

See Also:

isHere(CMObject, Room)

isHere

boolean isHere(CMObject E2,
               Room here)

Returns whether the given object is in the given room.

Parameters:

E2 - the object to look for

here - the room to see if its in

Returns:

true if the object is in the room

See Also:

isHere(CMObject, Area)

isAnAdminHere

boolean isAnAdminHere(Room R,
                      boolean sysMsgsOnly)

Returns whether an authorized room or mob editor is in the room, optionally with sysmsgs turned on.

Parameters:

R - the room to check

sysMsgsOnly - true to return true only if sysmsgs are on

Returns:

true if admin mode is in effect for the room

getAllGroupRiders

java.util.Set<Physical> getAllGroupRiders(Physical P,
                                          Room hereOnlyR)

Gets the entire party -- group members, ridden things, followed and things riding them, etc, etc.

Parameters:

P - the starting point for the group

hereOnlyR - null, or the room they must all ne present in

Returns:

the entire happy family