VRage.ModAPI
IMyStorage
Assembly: VRage.Game.dll
public interface IMyStorage
ModAPI interface giving access to voxel functions
Properties
| Member | Description |
|---|---|
| Closed | Returns true if voxel storage was closed |
| DeleteSupported | Returns if deletion is supported |
| MarkedForClose | Returns true if the voxel storage is marked for a pending close |
| Size | The size of the voxel storage, in voxel coordinates |
Methods
| Member | Description |
|---|---|
| DeleteRange(MyStorageDataTypeFlags, Vector3I, Vector3I, bool) | Deletes content in cache and storage |
| ExecuteOperationFast |
|
| Intersect(ref BoundingBox, bool) | Returns the intersection with the storage region |
| Intersect(ref LineD) | Returns true if the specific line intersects the storage region |
| NotifyRangeChanged(ref Vector3I, ref Vector3I, MyStorageDataTypeFlags) | Notify that range changed |
| PinAndExecute(Action) | Pins the voxel storage to prevent closing, then executes specified action. Unpins when action completes. |
| PinAndExecute(Action |
Pins the voxel storage to prevent closing, then executes specified action. Unpins when action completes. |
| ReadRange(MyStorageData, MyStorageDataTypeFlags, int, Vector3I, Vector3I, ref MyVoxelRequestFlags) | Reads range of content and/or materials from specified LOD. If you want to write data back later, you must read LOD0 as that is the only writable one. |
| ReadRange(MyStorageData, MyStorageDataTypeFlags, int, Vector3I, Vector3I) | Reads range of content and/or materials from specified LOD. If you want to write data back later, you must read LOD0 as that is the only writable one. |
| Reset(MyStorageDataTypeFlags) | Resets the data specified by flags to values from data provider, or default if no provider is assigned. |
| Save(out Byte[]) | Gets compressed voxel data |
| WriteRange(MyStorageData, MyStorageDataTypeFlags, Vector3I, Vector3I, bool, bool) | Writes range of content and/or materials from cache to storage. Note that this can only write to LOD0 (higher LODs must be computed based on that). |
| OverwriteAllMaterials(byte) | Obsolete Replaces all materials in range with the specific material |