World

Group
player
Methods
14
Fields
None

Getting one

client:createWorld()

Methods

MethodReturnsDescription
getId()numberThe world number.
setId(number)()Set the world number.
getTypes(){[WorldType]: boolean}Its types.
setTypes({[WorldType]: boolean})()Set its types.
getPlayerCount()numberHow many players are on it.
setPlayerCount(number)()Set the player count.
getLocation()numberIts location (region) code.
setLocation(number)()Set the location code.
getIndex()numberIts index in the client's world list.
setIndex(number)()Set the index.
getActivity()stringIts activity text.
setActivity(string)()Set the activity text.
getAddress()stringIts host address.
setAddress(string)()Set the host address.

Returned by

MethodReturnsDescription
Client.createWorldWorldA new, empty world description to fill in with the World setters.
WorldListLoad.getWorlds{World}Every world, in the order the server sent them, before the client sorts the list. Each World is a copy: its setters change only it.

Method details

setId

setId: (World, number) -> ()

Set the world number.

getIndex

getIndex: (World) -> number

Its index in the client's world list.