[This is preliminary documentation and is subject to change.]
The World type exposes the following properties.
Properties
| Member | Description | |
|---|---|---|
| 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 | ||
| 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 | ||
| 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). | |
| LoadedBy | ||
| LoadedByClassy | ||
| LoadedOn | ||
| Map | Map of this world. May be null if world is not loaded. | |
| MapChangedBy | ||
| MapChangedByClassy | ||
| MapChangedOn | ||
| MapFileName | Returns the map filename, including MapPath. | |
| Name | World name (no formatting).
Use WorldManager.RenameWorld() method to change this. | |
| NeverUnload | ||
| Players |