Class Towns

java.lang.Object

io.github.emcw.caching.BaseCache<SquaremapTown>

io.github.emcw.squaremap.api.Towns

All Implemented Interfaces:

ILocatable<SquaremapTown>

public class Towns
extends BaseCache<SquaremapTown>
implements ILocatable<SquaremapTown>

Field Summary

Fields inherited from interface io.github.emcw.interfaces.ILocatable

INT_ARRAY_X, INT_ARRAY_Z

Constructor Summary

Constructors

Constructor	Description
Towns(KnownMap map, SquaremapParser parser, CacheOptions options)

Method Summary

Modifier and Type	Method	Description
protected Map<String,SquaremapTown>	fetchCacheData()
Map<String,SquaremapTown>	invitableFromNation(SquaremapNation nation)	Gets all towns that the specified nation can invite by measuring their distances.

Methods inherited from class io.github.emcw.caching.BaseCache

cacheIsEmpty, getAll, getMultiple, getSingle, updateCache

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.github.emcw.interfaces.ILocatable

getNearbyEntities, getNearbyEntities

Constructor Details

Towns

public Towns(KnownMap map,
 SquaremapParser parser,
 CacheOptions options)

Method Details

fetchCacheData

protected Map<String,SquaremapTown> fetchCacheData()

Specified by:

fetchCacheData in class BaseCache<SquaremapTown>

invitableFromNation

public Map<String,SquaremapTown> invitableFromNation(SquaremapNation nation)

Gets all towns that the specified nation can invite by measuring their distances. Includes all towns within 3500 blocks on Aurora or 3000 blocks on other maps.

Parameters:

nation - The nation we want to gather all invitable towns for.

Returns:

A new Map containing the in-range (invitable) towns where the key is the town name.