[This is preliminary documentation and is subject to change.]

The World type exposes the following properties.

Properties

 Public

 Protected
 Instance

 Static
 Declared

 Inherited
 XNA Framework Only

 .NET Compact Framework Only

 MemberDescription
AccessSecurity
Controls which players may access this world.
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
BlockDB instance used to store/lookup block changes for this world.
BuildSecurity
Controls which players may build in this world.
ClassyName
Returns a nicely formatted name, with optional color codes.
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".
Greeting
Message shown to players who join this map. Null if no message is set.
HasChangedSinceBackup
Whether the map was saved since last time it was backed up.
IsFlushing
Whether this world is currently being flushed.
IsFull
Whether the current world is full, determined by ConfigKey.MaxPlayersPerWorld
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).
LoadedBy
Name of the player/entity who created this world, null if the player is unknown.
LoadedByClassy
LoadedOn
Date (UTC) that this world was created on.
LockedBy
The name of player/entity who last locked this world.
LockedOn
Date (UTC) when this world was last locked.
Map
Map of this world. May be null if world is not loaded.
MapChangedBy
Name of the player/entity who last loaded this map, Null if the player is unknown or if map has never been changed.
MapChangedByClassy
MapChangedOn
Date (UTC) of the most recent map change.
MapFileName
Returns the map file name, including MapPath.
Name
World name (no formatting). Use WorldManager.RenameWorld() method to change this.
Players
Preload
Controls if the map should be loaded before players enter. Map is immediately loaded when Preload is set to true. Map is unloaded if Preloaded is set to false, and there are no players on this world.
UnlockedBy
The name of player/entity who last unlocked this world.
UnlockedOn
Date (UTC) when this world was last locked.

See Also