WorldInfo
A value shape that methods take or return.
Getting one
world:current()
world:find(…)
world:search():first()Fields
| Field | Type | Description |
|---|---|---|
id | number | The world number. |
address | string | The world's hostname. |
activity | string | The activity label the directory shows, e.g. a minigame's name. |
players | number | How many players the directory last reported. |
online | boolean | Whether the world is up. |
members | boolean | Whether it is a members world. |
region | WorldRegionCode | "??" | The country the world is hosted in; "??" for a location this client does not know. |
Returned by
| Method | Returns | Description |
|---|---|---|
WorldDomain.current | WorldInfo? | The current world's directory entry. |
WorldDomain.find | WorldInfo? | 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.first | WorldInfo? | The first world that survived the filters. Consumes the query. |
WorldQuery.random | WorldInfo? | One survivor, chosen at random. Consumes the query. |