Sandbox.ModAPI.Ingame.IMyTerminalBlock

Assembly: Sandbox.Common.dll

public interface IMyTerminalBlock: IMyCubeBlock, IMyEntity

Describes terminal block (PB scripting interface)

Properties

Member	Description
CustomData	Gets or sets the Custom Data string. NOTE: Only use this for user input. For storing large mod configs, create your own MyModStorageComponent
CustomInfo	Gets information about block status (available from mods) `IMyTerminalBlock.AppendingCustomInfo`_prohibited `IMyTerminalBlock.RefreshCustomInfo`_prohibited .
CustomName	Gets or sets how block is named in Terminal menu
CustomNameWithFaction	Gets or sets how block is named in Terminal menu. Work only for Cockpit, LaserAntenna RadioAntenna, SpaceBall, Beacon
DetailedInfo	Gets information about block status. In Control panel bottom right text
ShowInInventory	Represent terminal gui toggle `Show block in Inventory Screen`. Gets or sets its value
ShowInTerminal	Represent terminal gui toggle `Show block in terminal`. Gets or sets its value
ShowInToolbarConfig	Represent terminal gui toggle `Show in toolbar config`. Gets or sets its value
ShowOnHUD	Represent terminal gui toggle `Show On HUD`. Gets or sets its value
BlockDefinition	Gets definition.Id assigned to this block Inherited from IMyCubeBlock
Closed	True if the block has been removed from the world. Inherited from IMyEntity
Components	Gets blocks component logic container Inherited from IMyEntity
CubeGrid	Grid in which the block is placed Inherited from IMyCubeBlock
DefinitionDisplayNameText	Definition name Inherited from IMyCubeBlock
DisassembleRatio	Is set in definition Ratio at which is the block disassembled (grinding) Bigger values - longer grinding Inherited from IMyCubeBlock
DisplayName	Gets user friendly name of entity. May be null For block terminal name use DisplayNameText Inherited from IMyEntity
DisplayNameText	Translated block name Inherited from IMyCubeBlock
EntityId	Id of entity Inherited from IMyEntity
HasInventory	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	Returns the count of the number of inventories this entity has. Inherited from IMyEntity
IsBeingHacked	Hacking of the block is in progress Inherited from IMyCubeBlock
IsFunctional	Gets if integrity is above breaking threshold Inherited from IMyCubeBlock
IsWorking	True if block is able to do its work depening on block type (is functional, powered, enabled, etc...) Inherited from IMyCubeBlock
Mass	Block mass Inherited from IMyCubeBlock
Max	Maximum coordinates of grid cells occupied by this block Inherited from IMyCubeBlock
Min	Minimum coordinates of grid cells occupied by this block Inherited from IMyCubeBlock
Name	Some entities can have uniq name, and game can find them by name `IMyEntities.TryGetEntityByName`_prohibited Inherited from IMyEntity
NumberInGrid	Order in which were the blocks of same type added to grid Used in default display name Inherited from IMyCubeBlock
Orientation	Returns block orientation in base 6 directions Inherited from IMyCubeBlock
OwnerId	IdentityId of player owning block (not steam Id) Inherited from IMyCubeBlock
Position	Position in grid coordinates Inherited from IMyCubeBlock
WorldAABB	Gets world axis-aligned bounding box Inherited from IMyEntity
WorldAABBHr	Gets world axis-aligned bounding box Inherited from IMyEntity
WorldMatrix	Gets world matrix of this entity Inherited from IMyEntity
WorldVolume	Gets bounding sphere of this entity Inherited from IMyEntity
WorldVolumeHr	Gets bounding sphere of this entity Inherited from IMyEntity

Methods

Member	Description
GetActions(List, Func<ITerminalAction, bool>)	Get all terminal actions available for block
GetActionWithName(string)	Get first found terminal action with name
GetProperties(List, Func<ITerminalProperty, bool>)	Get all terminal actions available for block.
GetProperty(string)	Finds terminal property with provided id
HasLocalPlayerAccess()	Returns if local player can use block. Executes HasPlayerAccess(long, MyRelationsBetweenPlayerAndBlock) with local player identityId. On Dedicated Server as identityId it is using 0 as playerId
HasNobodyPlayerAccessToBlock()	Returns if Nobody has access to block.
HasPlayerAccess(long, MyRelationsBetweenPlayerAndBlock)	Returns if local player can use block. It is also checking for admin access.
HasPlayerAccessWithNobodyCheck(long, bool)	Returns if player can use block. If playerId is 0 (Nobody), calls HasNobodyPlayerAccessToBlock instead It is also checking for admin access.
IsSameConstructAs(IMyTerminalBlock)	Determines whether this block is `Mechanical`_prohibited 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.
SearchActionsOfName(string, List, Func<ITerminalAction, bool>)	Get all terminal actions available for block. NOTE: First called `<br /><br />` and then `<br /><br />` check
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
GetOwnerFactionTag()	Tag of faction owning block Inherited from IMyCubeBlock
GetPosition()	Gets position in world coordinates Inherited from IMyEntity
GetUserRelationToOwner(long, MyRelationsBetweenPlayerAndBlock)	Gets relation to owner of block Inherited from IMyCubeBlock
SetCustomName(string)	Obsolete: Use the setter of Customname Obsolete
SetCustomName(StringBuilder)	Obsolete: Use the setter of Customname Obsolete
GetPlayerRelationToOwner()	Obsolete: GetPlayerRelationToOwner() is useless ingame. Mods should use the one in ModAPI.IMyCubeBlock Relation of local player to the block Should not be called on Dedicated Server. Inherited from IMyCubeBlock
UpdateIsWorking()	Obsolete Force refresh working state. Call if you change block state that could affect its working status. Inherited from IMyCubeBlock
UpdateVisual()	Obsolete Updates block visuals (ie. block emissivity) Inherited from IMyCubeBlock

Implements:

Inheritors: