WorldInfo

A value shape that methods take or return.

Group
world
Methods
None
Fields
7

Getting one

world:current()
world:find(…)
world:search():first()

Fields

FieldTypeDescription
idnumberThe world number.
addressstringThe world's hostname.
activitystringThe activity label the directory shows, e.g. a minigame's name.
playersnumberHow many players the directory last reported.
onlinebooleanWhether the world is up.
membersbooleanWhether it is a members world.
regionWorldRegionCode | "??"The country the world is hosted in; "??" for a location this client does not know.

Returned by

MethodReturnsDescription
WorldDomain.currentWorldInfo?The current world's directory entry.
WorldDomain.findWorldInfo?One world's directory entry.
WorldHopper.candidates{ WorldInfo }Every world this account could hop to: the worlds hopToAny picks from.
WorldQuery.collect{ WorldInfo }Every world that survived the filters. Consumes the query.
WorldQuery.firstWorldInfo?The first world that survived the filters. Consumes the query.
WorldQuery.randomWorldInfo?One survivor, chosen at random. Consumes the query.