This repository has been archived by the owner on Oct 22, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 123
Sandbox.ModAPI.Ingame.IMyGasTank
Morten Aune Lyrstad edited this page Jul 30, 2021
·
61 revisions
← Index ← Namespace Index
public interface IMyGasTank: IMyFunctionalBlock, IMyTerminalBlock, IMyCubeBlock, IMyEntityNamespace: Sandbox.ModAPI.Ingame
Assembly: Sandbox.Common.dll
Implements:
Inheritors:
Type Definitions:
- MyObjectBuilder_OxygenTank/
- MyObjectBuilder_OxygenTank/LargeHydrogenTank
- MyObjectBuilder_OxygenTank/LargeHydrogenTankIndustrial
- MyObjectBuilder_OxygenTank/LargeHydrogenTankSmall
- MyObjectBuilder_OxygenTank/OxygenTankSmall
- MyObjectBuilder_OxygenTank/SmallHydrogenTank
- MyObjectBuilder_OxygenTank/SmallHydrogenTankSmall
| Member | Description |
|---|---|
| Stockpile { get; set; } | Gets or sets the stockpiling option for this gas tank. When stockpile is on, the tank will only allow itself to be filled, it will not release any gas. |
| AutoRefillBottles { get; set; } | Gets or sets whether storage bottles will be filled automatically when placed within this tank. |
| Capacity { get; } | Gets the gas capacity of this tank. |
| FilledRatio { get; } | Gets the current fill level of this tank as a value between 0 (empty) and 1 (full). |
| Components { get; } | Inherited from IMyEntity |
| EntityId { get; } | Inherited from IMyEntity |
| Name { get; } | Inherited from IMyEntity |
| DisplayName { get; } | 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; } | Inherited from IMyEntity |
| WorldAABBHr { get; } | Inherited from IMyEntity |
| WorldMatrix { get; } | Inherited from IMyEntity |
| WorldVolume { get; } | Inherited from IMyEntity |
| WorldVolumeHr { get; } | Inherited from IMyEntity |
| BlockDefinition { get; } | Inherited from IMyCubeBlock |
| CheckConnectionAllowed { get; } | Inherited from IMyCubeBlock |
| CubeGrid { get; } | Grid in which the block is placed Inherited from IMyCubeBlock |
| DefinitionDisplayNameText { get; } | Definition name Inherited from IMyCubeBlock |
| DisassembleRatio { get; } | Is set in definition Ratio at which is the block disassembled (grinding) Inherited from IMyCubeBlock |
| DisplayNameText { get; } | Translated block name Inherited from IMyCubeBlock |
| IsBeingHacked { get; } | Hacking of the block is in progress Inherited from IMyCubeBlock |
| IsFunctional { get; } | True if integrity is above breaking threshold Inherited from IMyCubeBlock |
| IsWorking { get; } | True if block is able to do its work depening on block type (is functional, powered, enabled, etc...) Inherited from IMyCubeBlock |
| Max { get; } | Maximum coordinates of grid cells occupied by this block Inherited from IMyCubeBlock |
| Mass { get; } | Block mass Inherited from IMyCubeBlock |
| Min { get; } | Minimum coordinates of grid cells occupied by this block Inherited from IMyCubeBlock |
| NumberInGrid { get; } | Order in which were the blocks of same type added to grid Used in default display name Inherited from IMyCubeBlock |
| Orientation { get; } | Returns block orientation in base 6 directions Inherited from IMyCubeBlock |
| OwnerId { get; } | Id of player owning block (not steam Id) Inherited from IMyCubeBlock |
| Position { get; } | Position in grid coordinates Inherited from IMyCubeBlock |
| CustomName { get; set; } | Inherited from IMyTerminalBlock |
| CustomNameWithFaction { get; } | Inherited from IMyTerminalBlock |
| DetailedInfo { get; } | Inherited from IMyTerminalBlock |
| CustomInfo { get; } | Inherited from IMyTerminalBlock |
| CustomData { get; set; } | Gets or sets the Custom Data string. NOTE: Only use this for user input. For storing large mod configs, create your own MyModStorageComponent Inherited from IMyTerminalBlock |
| ShowOnHUD { get; set; } | Inherited from IMyTerminalBlock |
| ShowInTerminal { get; set; } | Inherited from IMyTerminalBlock |
| ShowInToolbarConfig { get; set; } | Inherited from IMyTerminalBlock |
| ShowInInventory { get; set; } | Inherited from IMyTerminalBlock |
| Enabled { get; set; } | Inherited from IMyFunctionalBlock |
| Member | Description |
|---|---|
| RefillBottles() | Refills any stored storage bottles. |
| 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() | Inherited from IMyEntity |
| GetOwnerFactionTag() | Tag of faction owning block Inherited from IMyCubeBlock |
| GetPlayerRelationToOwner() |
Obsolete: GetPlayerRelationToOwner() is useless ingame. Mods should use the one in ModAPI.IMyCubeBlock Inherited from IMyCubeBlock |
| GetUserRelationToOwner(long, MyRelationsBetweenPlayerAndBlock) | Inherited from IMyCubeBlock |
| UpdateIsWorking() |
Obsolete Inherited from IMyCubeBlock |
| UpdateVisual() |
Obsolete Inherited from IMyCubeBlock |
| HasLocalPlayerAccess() | Inherited from IMyTerminalBlock |
| HasPlayerAccess(long, MyRelationsBetweenPlayerAndBlock) | Inherited from IMyTerminalBlock |
| SetCustomName(string) |
Obsolete: Use the setter of Customname Inherited from IMyTerminalBlock |
| SetCustomName(StringBuilder) |
Obsolete: Use the setter of Customname Inherited from IMyTerminalBlock |
| GetActions(List, Func) | Inherited from IMyTerminalBlock |
| SearchActionsOfName(string, List, Func) | Inherited from IMyTerminalBlock |
| GetActionWithName(string) | Inherited from IMyTerminalBlock |
| GetProperty(string) | Inherited from IMyTerminalBlock |
| GetProperties(List, Func) | Inherited from IMyTerminalBlock |
| IsSameConstructAs(IMyTerminalBlock) | Determines whether this block is mechanically connected to the other. This is any block 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. Inherited from IMyTerminalBlock |
| RequestEnable(bool) |
Obsolete: Use the setter of Enabled Inherited from IMyFunctionalBlock |
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!