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

Sandbox.ModAPI.Ingame.IMyTerminalBlock

Jump to bottom
Morten Aune Lyrstad edited this page Apr 16, 2022 · 67 revisions

← Index ← Namespace Index

IMyTerminalBlock Interface

public interface IMyTerminalBlock: IMyCubeBlock, IMyEntity

Describes terminal block (PB scripting interface)

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

Implements:

Inheritors:

Properties

Member Description
SerializableDefinitionId BlockDefinition { get; } Gets definition.Id assigned to this block

Inherited from IMyCubeBlock
bool Closed { get; } True if the block has been removed from the world.

Inherited from IMyEntity
MyEntityComponentContainer Components { get; } Gets blocks component logic container

Inherited from IMyEntity
IMyCubeGrid CubeGrid { get; } Grid in which the block is placed

Inherited from IMyCubeBlock
string 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
string CustomInfo { get; } Gets information about block status (available from mods) Sandbox.ModAPI.IMyTerminalBlock.AppendingCustomInfo Sandbox.ModAPI.IMyTerminalBlock.RefreshCustomInfo .
string CustomName { get; set; } Gets or sets how block is named in Terminal menu
string CustomNameWithFaction { get; } Gets or sets how block is named in Terminal menu. Work only for Cockpit, LaserAntenna RadioAntenna, SpaceBall, Beacon
string DefinitionDisplayNameText { get; } Definition name

Inherited from IMyCubeBlock
string DetailedInfo { get; } Gets information about block status. In Control panel bottom right text
float DisassembleRatio { get; } Is set in definition Ratio at which is the block disassembled (grinding) Bigger values - longer grinding

Inherited from IMyCubeBlock
string DisplayName { get; } Gets user friendly name of entity. May be null For block terminal name use DisplayNameText

Inherited from IMyEntity
string DisplayNameText { get; } Translated block name

Inherited from IMyCubeBlock
long EntityId { get; } Id of entity

Inherited from IMyEntity
bool 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
int InventoryCount { get; } Returns the count of the number of inventories this entity has.

Inherited from IMyEntity
bool IsBeingHacked { get; } Hacking of the block is in progress

Inherited from IMyCubeBlock
bool IsFunctional { get; } Gets if integrity is above breaking threshold

Inherited from IMyCubeBlock
bool IsWorking { get; } True if block is able to do its work depening on block type (is functional, powered, enabled, etc...)

Inherited from IMyCubeBlock
float Mass { get; } Block mass

Inherited from IMyCubeBlock
Vector3I Max { get; } Maximum coordinates of grid cells occupied by this block

Inherited from IMyCubeBlock
Vector3I Min { get; } Minimum coordinates of grid cells occupied by this block

Inherited from IMyCubeBlock
string 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
int NumberInGrid { get; } Order in which were the blocks of same type added to grid Used in default display name

Inherited from IMyCubeBlock
MyBlockOrientation Orientation { get; } Returns block orientation in base 6 directions

Inherited from IMyCubeBlock
long OwnerId { get; } IdentityId of player owning block (not steam Id)

Inherited from IMyCubeBlock
Vector3I Position { get; } Position in grid coordinates

Inherited from IMyCubeBlock
bool ShowInInventory { get; set; } Represent terminal gui toggle Show block in Inventory Screen. Gets or sets its value
bool ShowInTerminal { get; set; } Represent terminal gui toggle Show block in terminal. Gets or sets its value
bool ShowInToolbarConfig { get; set; } Represent terminal gui toggle Show in toolbar config. Gets or sets its value
bool ShowOnHUD { get; set; } Represent terminal gui toggle Show On HUD. Gets or sets its value
BoundingBoxD WorldAABB { get; } Gets world axis-aligned bounding box

Inherited from IMyEntity
BoundingBoxD WorldAABBHr { get; } Gets world axis-aligned bounding box

Inherited from IMyEntity
MatrixD WorldMatrix { get; } Gets world matrix of this entity

Inherited from IMyEntity
BoundingSphereD WorldVolume { get; } Gets bounding sphere of this entity

Inherited from IMyEntity
BoundingSphereD WorldVolumeHr { get; } Gets bounding sphere of this entity

Inherited from IMyEntity

Methods

Member Description
void GetActions(List<ITerminalAction>, Func<ITerminalAction, bool> = null) Get all terminal actions available for block
ITerminalAction GetActionWithName(string) Get first found terminal action with name
IMyInventory GetInventory() Simply get the MyInventoryBase component stored in this entity.

Inherited from IMyEntity
IMyInventory GetInventory(int) Search for inventory component with maching index.

Inherited from IMyEntity
string GetOwnerFactionTag() Tag of faction owning block

Inherited from IMyCubeBlock
MyRelationsBetweenPlayerAndBlock 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
Vector3D GetPosition() Gets position in world coordinates

Inherited from IMyEntity
void GetProperties(List<ITerminalProperty>, Func<ITerminalProperty, bool> = null) Get all terminal actions available for block.
ITerminalProperty GetProperty(string) Finds terminal property with provided id
MyRelationsBetweenPlayerAndBlock GetUserRelationToOwner(long, MyRelationsBetweenPlayerAndBlock = MyRelationsBetweenPlayerAndBlock.NoOwnership) Gets relation to owner of block

Inherited from IMyCubeBlock
bool HasLocalPlayerAccess() Returns if local player can use block. Executes HasPlayerAccess(long, MyRelationsBetweenPlayerAndBlock = MyRelationsBetweenPlayerAndBlock.NoOwnership) with local player identityId. On Dedicated Server as identityId it is using 0 as playerId
bool HasPlayerAccess(long, MyRelationsBetweenPlayerAndBlock = MyRelationsBetweenPlayerAndBlock.NoOwnership) Returns if local player can use block. It is also checking for admin access.
bool IsSameConstructAs(IMyTerminalBlock) Determines whether this block is VRage.Game.ModAPI.GridLinkTypeEnum.Mechanical 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.
void SearchActionsOfName(string, List<ITerminalAction>, Func<ITerminalAction, bool> = null) Get all terminal actions available for block. NOTE: First called <br /><br /> and then <br /><br /> check
void SetCustomName(string) Obsolete: Use the setter of Customname
void SetCustomName(StringBuilder) Obsolete: Use the setter of Customname
void UpdateIsWorking() Obsolete

Force refresh working state. Call if you change block state that could affect its working status.

Inherited from IMyCubeBlock
void UpdateVisual() Obsolete

Updates block visuals (ie. block emissivity)

Inherited from IMyCubeBlock

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!

Clone this wiki locally