hopper
hopper: (WorldDomain) -> WorldHopperWorld hopping.
The world directory, world hopping, and PvP threats.
world| Method | Returns | Description |
|---|---|---|
hopper() | WorldHopper | World hopping. |
pvp() | WorldPvp | Wilderness threat reads. |
current() | WorldInfo? | The current world's directory entry. |
find(number) | WorldInfo? | One world's directory entry. |
search() | WorldQuery | A query over the directory. |
isPvp() | boolean | Whether the current world is PvP: a PvP or a Deadman world. |
location(number) | WorldLocationInfo? | A world's datacenter, which also tells US East from US West. |
hasType(WorldTypeName, number?) | boolean | Whether a world is of a kind. Raises for a name outside WorldTypeName. |
ping(number) | WorldPing? | The last measured latency to a world. |
requestPing(number, boolean?) | boolean | Measure a world's latency, on a later tick. |
hopperhopper: (WorldDomain) -> WorldHopperWorld hopping.
pvppvp: (WorldDomain) -> WorldPvpWilderness threat reads.
currentcurrent: (WorldDomain) -> WorldInfo?The current world's directory entry.
nil before the directory has been fetched.findfind: (WorldDomain, number) -> WorldInfo?One world's directory entry.
worldnil when it is not in the directory.searchsearch: (WorldDomain) -> WorldQueryA query over the directory.
local everywhere = world:search():collect()
local nearby = world:search():region(world:current().region):online():first()isPvpisPvp: (WorldDomain) -> booleanWhether the current world is PvP: a PvP or a Deadman world.
locationlocation: (WorldDomain, number) -> WorldLocationInfo?A world's datacenter, which also tells US East from US West.
worldnil when it is not in the directory.hasTypehasType: (WorldDomain, WorldTypeName, number?) -> booleanWhether a world is of a kind. Raises for a name outside WorldTypeName.
local members = world:hasType("members", 301)
local hereIsLeagues = world:hasType("seasonal")kindworldfalse when it is not in the directory.pingping: (WorldDomain, number) -> WorldPing?The last measured latency to a world.
worldnil when it has not been measured.requestPingrequestPing: (WorldDomain, number, boolean?) -> booleanMeasure a world's latency, on a later tick.
worldforce