[This is preliminary documentation and is subject to change.]
[Missing <summary> documentation for "T:fCraft.World"]
Assembly: fCraft (in fCraft.dll) Version: 0.6.3.0 (0.6.3.0)
Syntax
| C# |
public sealed class World : IClassy
Members
| All Members | Fields  | Properties  | Methods  |
 Public Protected | Instance Static  | Declared Inherited | XNA Framework Only  .NET Compact Framework Only  |
| Member | Description | |
|---|---|---|
| AcceptPlayer(Player, Boolean) | |
| AccessSecurity | |
| BackupEnabledState | Backup state. Use "Yes" to enable, "No" to disable, and "Auto" to use default settings.
If setting to "Yes", make sure to set BackupInterval property value first. |
| BackupInterval | Timed backup interval.
If BackupEnabledState is set to "Yes", value must be positive.
If BackupEnabledState is set to "No" or "Auto", this property has no effect. |
| BackupsEnabled | Whether timed backups are enabled (either manually or by default) on this world. |
| BlockDB | |
| BuildSecurity | |
| ChangeMap(Map) | Creates a new World for the given Map, with same properties as this world. |
| ClassyName | Returns a nicely formatted name, with optional color codes. |
| CloudColor | |
| CountPlayers(Boolean) | Counts all players (optionally includes all hidden players). |
| CountVisiblePlayers(Player) | Counts only the players who are not hidden from a given observer. |
| DefaultBackupInterval | Default backup interval, for worlds that have BackupEnabledState set to "Auto". |
| DefaultBackupsEnabled | Whether timed backups are enabled by default for worlds that have BackupEnabledState set to "Auto". |
| EdgeBlock | |
| EdgeLevel | |
| 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()()()() | |
| FogColor | |
| 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.) |
| Greeting | |
| HasChangedSinceBackup | Whether the map was saved since last time it was backed up. |
| IsFlushing | |
| IsFull | |
| IsHidden | Whether the world shows up on the /Worlds list.
Can be assigned directly. |
| IsLoaded | Whether the map is currently loaded. |
| IsLocked | Whether the world is currently locked (in read-only mode). |
| IsPendingMapUnload | Whether this world is currently pending unload
(waiting for block updates to finish processing before unloading). |
| IsValidName(String) | Ensures that player name has the correct length (2-16 characters)
and character set (alphanumeric chars and underscores allowed). |
| LoadedBy | |
| LoadedByClassy | |
| LoadedOn | |
| 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) | |
| LockedBy | |
| LockedOn | |
| Map | Map of this world. May be null if world is not loaded. |
| MapChangedBy | |
| MapChangedByClassy | |
| MapChangedOn | |
| MapFileName | Returns the map filename, including MapPath. |
| MemberwiseClone()()()() |
Creates a shallow copy of the current Object.
(Inherited from Object.) |
| Name | World name (no formatting).
Use WorldManager.RenameWorld() method to change this. |
| Players | |
| Preload | Controls if the map should be loaded before players enter |
| ReleasePlayer(Player) | |
| SaveBackup(String) | |
| SaveMap()()()() | |
| SkyColor | |
| ToString()()()() | (Overrides Object..::..ToString()()()().) |
| Unlock(Player) | |
| UnlockedBy | |
| UnlockedOn | |
| UpdatePlayerList()()()() | Caches the player list to an array (Players -> PlayerList) |
