This repository was archived by the owner on Dec 13, 2025. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 123
VRage.Game.ModAPI.Ingame.IMyCubeGrid
Morten Aune Lyrstad edited this page Feb 3, 2022
·
44 revisions
← Index ← Namespace Index
public interface IMyCubeGrid: IMyEntityGrid interface
Namespace: VRage.Game.ModAPI.Ingame
Assembly: VRage.Game.dll
Implements:
| Member | Description |
|---|---|
| CustomName { get; set; } | Getter and setter for display name of the grid (as seen in Info terminal tab) |
| GridSize { get; } | Getter of grid size in meters |
| GridSizeEnum { get; } | Getter for grid size enum |
| IsStatic { get; } | Determines if the grid is static (unmoveable) |
| Max { get; } | Maximum coordinates of blocks in grid |
| Min { get; } | Minimum coordinates of blocks in grid |
| Components { get; } | Gets blocks component logic container Inherited from IMyEntity |
| EntityId { get; } | Id of entity Inherited from IMyEntity |
| Name { get; } | Some entities can have uniq name, and game can find them by name VRage.ModAPI.IMyEntities.TryGetEntityByName(System.String,VRage.ModAPI.IMyEntity@) Inherited from IMyEntity |
| DisplayName { get; } | Gets user friendly name of entity. May be null For block terminal name use DisplayNameText Inherited from IMyEntity |
| HasInventory { get; } | Returns true if this entity has got at least one inventory. Note that one aggregate inventory can contain zero simple inventories => zero will be returned even if GetInventory() != null. Inherited from IMyEntity |
| InventoryCount { get; } | Returns the count of the number of inventories this entity has. Inherited from IMyEntity |
| Closed { get; } | True if the block has been removed from the world. Inherited from IMyEntity |
| WorldAABB { get; } | Gets world axis-aligned bounding box Inherited from IMyEntity |
| WorldAABBHr { get; } | Gets world axis-aligned bounding box Inherited from IMyEntity |
| WorldMatrix { get; } | Gets world matrix of this entity Inherited from IMyEntity |
| WorldVolume { get; } | Gets bounding sphere of this entity Inherited from IMyEntity |
| WorldVolumeHr { get; } | Gets bounding sphere of this entity Inherited from IMyEntity |
| Member | Description |
|---|---|
| CubeExists(Vector3I) | Returns true if there is any block occupying given position |
| GetCubeBlock(Vector3I) | Get cube block at given position |
| GridIntegerToWorld(Vector3I) | Converts grid coordinates to world space |
| WorldToGridInteger(Vector3D) | Converts world coordinates to grid space cell coordinates |
| IsSameConstructAs(IMyCubeGrid) | Determines whether this grid is VRage.Game.ModAPI.GridLinkTypeEnum.Mechanical connected to the other. This is any grid connected with rotors or pistons or other mechanical devices, but not things like connectors. This will in most cases constitute your complete construct. Be aware that using merge blocks combines grids into one, so this function will not filter out grids connected that way. Also be aware that detaching the heads of pistons and rotors will cause this connection to change. |
| GetInventory() | Simply get the MyInventoryBase component stored in this entity. Inherited from IMyEntity |
| GetInventory(int) | Search for inventory component with maching index. Inherited from IMyEntity |
| GetPosition() | Gets position in world coordinates Inherited from IMyEntity |
Do you have questions, comments, suggestions for improvements? Is there something I can do better? Did I make a mistake? Please add an issue here, and prefix your issue title with Wiki. Thank you, your help will be very appreciated!