Skip to content
This repository has been archived by the owner on Oct 22, 2024. It is now read-only.

Sandbox.ModAPI.Ingame.IMyTerminalBlock

Morten Aune Lyrstad edited this page Jun 28, 2020 · 67 revisions

IndexNamespace Index

IMyTerminalBlock Interface

public interface IMyTerminalBlock: IMyCubeBlock, IMyEntity

Namespace: Sandbox.ModAPI.Ingame
Assembly: Sandbox.Common.dll

Implements:

Inheritors:

Properties

Member Description
CustomName { get; set; }
CustomNameWithFaction { get; }
DetailedInfo { get; }
CustomInfo { get; }
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
ShowOnHUD { get; set; }
ShowInTerminal { get; set; }
ShowInToolbarConfig { get; set; }
ShowInInventory { get; set; }
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
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

Methods

Member Description
HasLocalPlayerAccess()
HasPlayerAccess(long)
SetCustomName(string) Obsolete: Use the setter of Customname
SetCustomName(StringBuilder) Obsolete: Use the setter of Customname
GetActions(List, Func)
SearchActionsOfName(string, List, Func)
GetActionWithName(string)
GetProperty(string)
GetProperties(List, Func)
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.
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) Inherited from IMyCubeBlock
UpdateIsWorking() Obsolete

Inherited from IMyCubeBlock
UpdateVisual() Obsolete

Inherited from IMyCubeBlock
Clone this wiki locally