[This is preliminary documentation and is subject to change.]
The World type exposes the following methods.
Methods
| Member | Description | |
|---|---|---|
| AcceptPlayer(Player, Boolean) | ||
| ChangeMap(Map) | Creates a new World for the given Map, with same properties as this world. | |
| CountPlayers(Boolean) | Counts all players (optionally includes all hidden players). | |
| CountVisiblePlayers(Player) | Counts only the players who are not hidden from a given observer. | |
| Equals(Object) | (Inherited from Object.) | |
| Finalize()()()() |
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.) | |
| FindPlayerExact(String) | Gets player by name (without autocompletion) | |
| FindPlayers(Player, String) | ||
| Flush()()()() | ||
| GenerateWoMConfig(Boolean) | ||
| GetHashCode()()()() |
Serves as a hash function for a particular type.
(Inherited from Object.) | |
| GetNextPatrolTarget(Player) | ||
| GetNextPatrolTarget(Player, Predicate<(Of <<'(Player>)>>), Boolean) | ||
| GetType()()()() |
Gets the Type of the current instance.
(Inherited from Object.) | |
| IsValidName(String) | Ensures that player name has the correct length (2-16 characters)
and character set (alphanumeric chars and underscores allowed). | |
| LoadMap()()()() | Loads the map file, if needed.
Generates a default map if mapfile is missing or not loadable.
Guaranteed to return a Map object. | |
| Lock(Player) | ||
| MemberwiseClone()()()() |
Creates a shallow copy of the current Object.
(Inherited from Object.) | |
| ReleasePlayer(Player) | ||
| SaveBackup(String) | ||
| SaveMap()()()() | ||
| ToString()()()() | (Overrides Object..::..ToString()()()().) | |
| Unlock(Player) | ||
| UpdatePlayerList()()()() | Caches the player list to an array (Players -> PlayerList) |