[This is preliminary documentation and is subject to change.]
Database of block changes. Each BlockDB object is associated with a world.
Provides controls for storage/retention, and methods to look up data.
Namespace: fCraftAssembly: fCraft (in fCraft.dll) Version: 0.6.3.5 (0.6.3.5)
Syntax
| C# |
public sealed class BlockDB
Members
| All Members | Fields  | Properties  | Methods  |
 Public Protected | Instance Static  | Declared Inherited | XNA Framework Only  .NET Compact Framework Only  |
| Member | Description | |
|---|---|---|
| AutoToggleIfNeeded()()()() | If EnabledState is set to Auto, calling this auto-enables / auto-disables
BlockDB depending on world's BuildSecurity.MinRank and BlockDBAutoEnableRank config key. |
| Clear()()()() | Clears cache and deletes the .fbdb file. |
| EnabledState | Sets this BlockDB's enabled state to Yes (always on), No (aways off),
or Auto (on or off depending on BlockDBAutoEnableRank config key and World's build permissions). |
| Equals(Object) | (Inherited from Object.) |
| FileName | Full path to the file where BlockDB data is stored. |
 | 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.) |
| GetHashCode()()()() |
Serves as a hash function for a particular type.
(Inherited from Object.) |
| GetReadLock()()()() | Acquires and returns a shared (read) lock for this BlockDB.
Disposing the object returned by this method releases the lock. |
| GetType()()()() |
Gets the Type of the current instance.
(Inherited from Object.) |
| GetWriteLock()()()() | Acquires and returns an exclusive (write) lock for this BlockDB.
Disposing the object returned by this method releases the lock. |
| HasLimit | Whether this BlockDB instance has a limit on the number of entries. |
| HasTimeLimit | |
| IsEnabled | Checks whether this BlockDB is enabled (either automatically or manually).
Set EnabledState to enable/disable. |
| IsEnabledGlobally | Whether BlockDB was enabled at startup.
Changing this setting currently requires a server restart. |
| IsPreloaded | |
| Limit | |
| LoadSettings(XElement) | |
| Lookup(Int32) | |
| Lookup(Int32, BoundingBox) | |
| Lookup(Int32, Vector3I) | Returns list of all changes done to the map at the given coordinate, newest to oldest. |
| Lookup(Int32, TimeSpan) | |
| Lookup(Int32, BlockDBSearchType, Func<(Of <<'(BlockDBEntry, Boolean>)>>)) | Searches the database for BlockDBEntries, based on given criteria. |
| Lookup(Int32, BoundingBox, TimeSpan) | |
| Lookup(Int32, PlayerInfo, Boolean) | |
| Lookup(Int32, array<PlayerInfo>[]()[][], Boolean) | |
| Lookup(Int32, BoundingBox, PlayerInfo, Boolean) | |
| Lookup(Int32, BoundingBox, array<PlayerInfo>[]()[][], Boolean) | |
| Lookup(Int32, PlayerInfo, Boolean, TimeSpan) | |
| Lookup(Int32, array<PlayerInfo>[]()[][], Boolean, TimeSpan) | |
| Lookup(Int32, BoundingBox, PlayerInfo, Boolean, TimeSpan) | |
| Lookup(Int32, BoundingBox, array<PlayerInfo>[]()[][], Boolean, TimeSpan) | |
| MemberwiseClone()()()() |
Creates a shallow copy of the current Object.
(Inherited from Object.) |
| SaveSettings()()()() | |
| SaveSettings(String) | |
| TimeLimit | |
| ToString()()()() | (Inherited from Object.) |
| Traverse(IBlockDBQueryProcessor) | Traverses the database, newest to oldest entries, processing each entry with the given IBlockDBQueryProcessor. |
| World | World associated with this BlockDB. |
| XmlRootName |
