Assembly: Sandbox.Common.dll

public interface IMyTerminalBlock: IMyCubeBlock, IMyCubeBlock, IMyEntity, IMyEntity, IMyTerminalBlock

Describes assembler block (mods interface)

Events

Member Description
AppendingCustomInfo Event to append custom info.
CustomDataChanged Called when custom data of block changed
CustomNameChanged Called when custom name of block changed
OwnershipChanged Called when block ownership changed
PropertiesChanged Called when any of block properties changed. It could be anything, starting from CustomName ending with Inventory items
ShowOnHUDChanged Called when ShowOnHUD Changed
VisibilityChanged Called properties that modify the visibility of this block's controls, are changed
CubeGridChanged Triggers when blocks cube grid is changed

Inherited from IMyCubeBlock
IsWorkingChanged Called when "WorkingState" is changed.

Inherited from IMyCubeBlock
OnClose Called when Close() is called. Order 1) OnMarkForClose 2) OnClosing 3) OnClose .

Inherited from IMyEntity
OnClosing Called when Close() is called. Order 1) OnMarkForClose 2) OnClosing 3) OnClose .

Inherited from IMyEntity
OnMarkForClose Called when Close() is called. Order 1) OnMarkForClose 2) OnClosing 3) OnClose .

Inherited from IMyEntity
OnPhysicsChanged Called when havok rigid body physics are changed: inited, closed, modified.

Inherited from IMyEntity
OnUpgradeValuesChanged Event called when upgrade values are changed Either upgrades were built or destroyed, or they become damaged or unpowered

Inherited from IMyCubeBlock

Properties

Member Description
IsDetailedInfoDirty Gets whether detailed info is dirty and to be updated
BlockDefinition Gets definition.Id assigned to this block

Inherited from IMyCubeBlock
CastShadows Gets or sets flag CastShadows

Inherited from IMyEntity
CheckConnectionAllowed Whether the grid should call the ConnectionAllowed method for this block (ConnectionAllowed checks mount points and other per-block requirements)

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
CubeGrid Grid in which the block is placed

Inherited from IMyCubeBlock
CustomData 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
CustomInfo Gets information about block status (available from mods) AppendingCustomInfo RefreshCustomInfo() .

Inherited from IMyTerminalBlock
CustomName Gets or sets how block is named in Terminal menu

Inherited from IMyTerminalBlock
CustomNameWithFaction Gets or sets how block is named in Terminal menu. Work only for Cockpit, LaserAntenna RadioAntenna, SpaceBall, Beacon

Inherited from IMyTerminalBlock
DebugAsyncLoading Used for internal usage. Modders should not use it. Will be eventually removed

Inherited from IMyEntity
DefinitionDisplayNameText Definition name

Inherited from IMyCubeBlock
DetailedInfo Gets information about block status. In Control panel bottom right text

Inherited from IMyTerminalBlock
DisassembleRatio Is set in definition Ratio at which is the block disassembled (grinding) Bigger values - longer grinding

Inherited from IMyCubeBlock
DisplayName Gets or sets user friendly name of entity

Inherited from IMyEntity
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 Uniq id of entity.

Inherited from IMyEntity
EntityId Id of entity

Inherited from IMyEntity
FastCastShadowResolve Gets or sets flag CastShadows

Inherited from IMyEntity
Flags Gets or set some behavior of entity. EntityFlags

Inherited from IMyEntity
GameLogic Gets or sets game logic for object. If there is more than 1 game logic attached it should be wrapped into.

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
Hierarchy Gets or sets Hierarchy component

Inherited from IMyEntity
InScene Gets or set if grid is InScene. Objects that are not in scene are not updated and drawn.

Inherited from IMyEntity
InvalidateOnMove Gets if entity is invalidated on move When visual look of entity depends on position - then InvalidateOnMove should be true

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
IsVolumetric Always returns false

Inherited from IMyEntity
IsWorking True if block is able to do its work depening on block type (is functional, powered, enabled, etc...)

Inherited from IMyCubeBlock
LocalAABB Gets or sets local axis aligned bounding box. Same as LocalAABBHr , LocalAABB

Inherited from IMyEntity
LocalAABBHr Gets local axis aligned bounding box. Same as LocalAABB , LocalAABB

Inherited from IMyEntity
LocalMatrix Gets or sets local matrix. When entity, has parent, it's world coordinates are calculated from localMatrix and parent world matrix

Inherited from IMyEntity
LocalVolume Gets or sets local volume. Same as LocalVolume

Inherited from IMyEntity
LocalVolumeOffset Gets or sets local volume offset. Same as LocalVolumeOffset

Inherited from IMyEntity
MarkedForClose Checked if Close() was called

Inherited from IMyEntity
Mass Block mass

Inherited from IMyCubeBlock
Max Maximum coordinates of grid cells occupied by this block

Inherited from IMyCubeBlock
MaxGlassDistSq Not used in game anymore

Inherited from IMyEntity
Min Minimum coordinates of grid cells occupied by this block

Inherited from IMyCubeBlock
Model Gets model of block

Inherited from IMyEntity
ModelCollision Gets collision model of block

Inherited from IMyEntity
Name Uniq name of entity. Can be used to find entity by name

Inherited from IMyEntity
Name Some entities can have uniq name, and game can find them by name TryGetEntityByName(string, out IMyEntity)

Inherited from IMyEntity
NearFlag Gets or sets flag Near

Inherited from IMyEntity
NeedsDraw Gets or sets flag NeedsDraw

Inherited from IMyEntity
NeedsDrawFromParent Gets or sets flag NeedsDrawFromParent

Inherited from IMyEntity
NeedsResolveCastShadow Gets or sets flag NeedsResolveCastShadow

Inherited from IMyEntity
NeedsUpdate Gets or sets how often the entity should be updated.

Inherited from IMyEntity
NeedsWorldMatrix Gets or sets if WorldMatrix should be calculated when parent WorldMatrix is changed.

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
Parent Gets parent of entity or null, if this entity doesn't have parent. Ex: character sitting in cockpit, has parent - cockpit, cockpit has parent - cube grid, connected grids also has main grid, which would be parent for other grids.

Inherited from IMyEntity
PersistentFlags Gets or sets persistent flags that are used in rendering.

Inherited from IMyEntity
Physics Gets or sets physics for object

Inherited from IMyEntity
Position Position in grid coordinates

Inherited from IMyCubeBlock
PositionComp Gets or sets position provider logic

Inherited from IMyEntity
Render Gets or sets render logic

Inherited from IMyEntity
ResourceSink Resource sink (draws power)

Inherited from IMyCubeBlock
Save Gets or sets Save . Entity won't be saved if Save is false

Inherited from IMyEntity
ShadowBoxLod Gets or sets flag ShadowBoxLod

Inherited from IMyEntity
ShowInInventory Represent terminal gui toggle Show block in Inventory Screen. Gets or sets its value

Inherited from IMyTerminalBlock
ShowInTerminal Represent terminal gui toggle Show block in terminal. Gets or sets its value

Inherited from IMyTerminalBlock
ShowInToolbarConfig Represent terminal gui toggle Show in toolbar config. Gets or sets its value

Inherited from IMyTerminalBlock
ShowOnHUD Represent terminal gui toggle Show On HUD. Gets or sets its value

Inherited from IMyTerminalBlock
SkipIfTooSmall Gets or sets flag SkipIfTooSmall

Inherited from IMyEntity
SlimBlock Gets the SlimBlock associated with this block

Inherited from IMyCubeBlock
StopPhysicsActivation Inherited from IMyEntity
Storage Custom storage for mods. Shared with all mods.

Inherited from IMyEntity
Synchronized Gets or sets if the entity should be synced.

Inherited from IMyEntity
SyncObject Gets SyncObject used for synchronizing data over network with

Inherited from IMyEntity
Transparent Gets or sets Transparency . When setting true entity would be 25% transparent

Inherited from IMyEntity
UpgradeValues Get all values changed by upgrade modules Should only be used as read-only

Inherited from IMyCubeBlock
Visible Gets or sets flag Visible

Inherited from IMyEntity
WorldAABB Gets world axis-aligned bounding box

Inherited from IMyEntity
WorldAABBHr Gets world axis-aligned bounding box

Inherited from IMyEntity
WorldMatrix Gets or sets world matrix.

Inherited from IMyEntity
WorldMatrix Gets world matrix of this entity

Inherited from IMyEntity
WorldMatrixInvScaled Get scaled, inverted world matrix. Same as GetViewMatrix() , GetWorldMatrixNormalizedInv() , WorldMatrixNormalizedInv , but not normalized

Inherited from IMyEntity
WorldMatrixNormalizedInv Get normalized, inverted world matrix. Same as GetViewMatrix() , WorldMatrixNormalizedInv

Inherited from IMyEntity
WorldVolume Gets bounding sphere of this entity

Inherited from IMyEntity
WorldVolumeHr Gets bounding sphere of this entity

Inherited from IMyEntity
IsCCDForProjectiles Obsolete

Inherited from IMyEntity
LocationForHudMarker Obsolete

Inherited from IMyEntity

Methods

Member Description
ClearDetailedInfo() Clears detailed info
GetDetailedInfo() Gets detailed info instance
IsInSameLogicalGroupAs(IMyTerminalBlock) Determines whether this block is in the same logical group as the other, meaning they're connected either mechanically or via blocks like connectors. Be aware that using merge blocks combines grids into one, so this function will not filter out grids connected that way.
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.
RefreshCustomInfo() Raises AppendingCustomInfo so every subscriber can append custom info.
SetDetailedInfoDirty() Sets detailed info dirty and to be updated
AddUpgradeValue(string, float) Preferred way of registering a block for upgrades Adding directly to the dictionary can have unintended consequences when multiple mods are involved.

Inherited from IMyCubeBlock
BeforeSave() Called before method GetObjectBuilder, when saving sector

Inherited from IMyEntity
CalcLocalMatrix(out Matrix, out string) Calculates local matrix, and currentModel

Inherited from IMyCubeBlock
CalculateCurrentModel(out Matrix) Calculates model currently used by block depending on its build progress and other factors

Inherited from IMyCubeBlock
Close() This method marks this entity for close which means, that Close will be called after all entities are updated

Inherited from IMyEntity
DebugDraw() Calls debug draw of entity

Inherited from IMyEntity
DebugDrawInvalidTriangles() Calls special debug draw, that highlighting invalid triangles in model

Inherited from IMyEntity
Delete() Performs real cleaning of entity. Should be called by game. Modders should prefer Close() method.

Inherited from IMyEntity
DoOverlapSphereTest(float, Vector3D) Checks if intersects Works only with IMyVoxelBase

Inherited from IMyEntity
EnableColorMaskForSubparts(bool) Allows subparts have different color than their parent

Inherited from IMyEntity
GetActions(List, Func<ITerminalAction, bool>) Get all terminal actions available for block

Inherited from IMyTerminalBlock
GetActionWithName(string) Get first found terminal action with name

Inherited from IMyTerminalBlock
GetChildren(List, Func<IMyEntity, bool>) Gets children of entity. Child - entity, who's Parent is this entity

Inherited from IMyEntity
GetDiffuseColor() Gets render diffuse color

Inherited from IMyEntity
GetDistanceBetweenCameraAndBoundingSphere() Distance from camera to bounding sphere of this phys object. Result is always positive, even if camera is inside the sphere. (in meters)

Inherited from IMyEntity
GetDistanceBetweenCameraAndPosition() Distance from camera to position of entity.

Inherited from IMyEntity
GetFriendlyName() Not used. Actually not a friendly name

Inherited from IMyEntity
GetIntersectionWithAABB(ref BoundingBoxD) Return true if object intersects specified bounding box.

Inherited from IMyEntity
GetIntersectionWithLine(ref LineD, out MyIntersectionResultLineTriangleEx?, IntersectionFlags) Get intersection of model with provided line

Inherited from IMyEntity
GetIntersectionWithLineAndBoundingSphere(ref LineD, float) Calculates intersection of line with any bounding sphere in this model instance. Center of the bounding sphere will be returned. It takes boundingSphereRadiusMultiplier argument which serves for extending the influence (radius) for interaction with line.

Inherited from IMyEntity
GetIntersectionWithSphere(ref BoundingSphereD) Return true if object intersects specified sphere.

Inherited from IMyEntity
GetInventory() Simply get the MyInventoryBase component stored in this entity.

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

Inherited from IMyEntity
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
GetLargestDistanceBetweenCameraAndBoundingSphere() Largest distance from camera to bounding sphere of this phys object. Result is always positive, even if camera is inside the sphere. It's actually distance between camera and opposite side of the sphere

Inherited from IMyEntity
GetObjectBuilder(bool) Returns object builder - object representing block state, and allows restore it. Used in game save, or syncing over network.

Inherited from IMyEntity
GetObjectBuilderCubeBlock(bool) Returns block object builder which can be serialized or added to grid

Inherited from IMyCubeBlock
GetOwnerFactionTag() Tag of faction owning block

Inherited from IMyCubeBlock
GetPosition() Gets position in world coordinates

Inherited from IMyEntity
GetProperties(List, Func<ITerminalProperty, bool>) Get all terminal actions available for block.

Inherited from IMyTerminalBlock
GetProperty(string) Finds terminal property with provided id

Inherited from IMyTerminalBlock
GetSmallestDistanceBetweenCameraAndBoundingSphere() Smallest distance between camera and bounding sphere of this phys object. Result is always positive, even if camera is inside the sphere.

Inherited from IMyEntity
GetSubpart(string) Gets subpart by subpart name

Inherited from IMyEntity
GetTopMostParent(Type) Gets top most Parent of specified type. Top most is entity that doesn't have parent (of specified type)

Inherited from IMyEntity
GetTrianglesIntersectingSphere(ref BoundingSphere, Vector3?, float?, List<MyTriangle_Vertex_Normals>, int) Return list of triangles intersecting specified sphere. Angle between every triangleVertexes normal vector and 'referenceNormalVector' is calculated, and if more than 'maxAngle', we ignore such triangleVertexes. Triangles are returned in 'retTriangles', and this list must be preallocated! IMPORTANT: Sphere must be in model space, so don't transform it!

Inherited from IMyEntity
GetUserRelationToOwner(long, MyRelationsBetweenPlayerAndBlock) Gets relation to owner of block

Inherited from IMyCubeBlock
GetViewMatrix() Get normalized, inverted world matrix. Same as GetWorldMatrixNormalizedInv() , WorldMatrixNormalizedInv

Inherited from IMyEntity
GetWorldMatrixNormalizedInv() Get normalized, inverted world matrix. Same as GetViewMatrix() , WorldMatrixNormalizedInv

Inherited from IMyEntity
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

Inherited from IMyTerminalBlock
HasNobodyPlayerAccessToBlock() Returns if Nobody has access to block.

Inherited from IMyTerminalBlock
HasPlayerAccess(long, MyRelationsBetweenPlayerAndBlock) Returns if local player can use block. It is also checking for admin access.

Inherited from IMyTerminalBlock
HasPlayerAccessWithNobodyCheck(long, bool) Returns if player can use block. If playerId is 0 (Nobody), calls HasNobodyPlayerAccessToBlock instead It is also checking for admin access.

Inherited from IMyTerminalBlock
Init() Reloads block model and interactive objects (doors, terminals, etc...)

Inherited from IMyCubeBlock
Init(MyObjectBuilder_CubeBlock, IMyCubeGrid) Initializes block state from object builder

Inherited from IMyCubeBlock
IsSameConstructAs(IMyTerminalBlock) Determines whether this block is 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.

Inherited from IMyTerminalBlock
IsVisible() Gets or result of function IsVisible() . Function inside check for IsVisible(IMyEntity)

Inherited from IMyEntity
OnAddedToScene(object) Adds entity to scene: init updates, render physics

Inherited from IMyEntity
OnBuildSuccess(long) Method called when a block has been built (after adding to the grid). This is called right after placing the block and it doesn't matter whether it is fully built (creative mode) or is only construction site. Note that it is not called for blocks which do not create FatBlock at that moment.

Inherited from IMyCubeBlock
OnBuildSuccess(long, bool) Method called when a block has been built (after adding to the grid). This is called right after placing the block and it doesn't matter whether it is fully built (creative mode) or is only construction site. Note that it is not called for blocks which do not create FatBlock at that moment.

Inherited from IMyCubeBlock
OnDestroy() Called when block is destroyed before being removed from grid

Inherited from IMyCubeBlock
OnModelChange() Called when the model referred by the block is changed

Inherited from IMyCubeBlock
OnRegisteredToGridSystems() Called at the end of registration from grid systems (after block has been registered).

Inherited from IMyCubeBlock
OnRemovedByCubeBuilder() Method called when user removes a cube block from grid. Useful when block has to remove some other attached block (like motors).

Inherited from IMyCubeBlock
OnRemovedFromScene(object) Remove entity and it's children from scene: stops updates and render, deactivates physics. Usually called when entity deleted

Inherited from IMyEntity
OnUnregisteredFromGridSystems() Called at the end of unregistration from grid systems (after block has been unregistered).

Inherited from IMyCubeBlock
RaycastDetectors(Vector3D, Vector3D) Gets the name of interactive object intersected by defined line

Inherited from IMyCubeBlock
ReloadDetectors(bool) Reloads detectors (interactive objects) in model

Inherited from IMyCubeBlock
RemoveEffect(string, int) Removes active effect set with SetEffect

Inherited from IMyCubeBlock
SearchActionsOfName(string, List, Func<ITerminalAction, bool>) Get all terminal actions available for block. NOTE: First called <br /><br /> and then <br /><br /> check

Inherited from IMyTerminalBlock
SetColorMaskForSubparts(Vector3) Sets subparts custom col

Inherited from IMyEntity
SetDamageEffect(bool) Start or stop damage effect on cube block

Inherited from IMyCubeBlock
SetEffect(string, bool) Activate block effect listed in definition

Inherited from IMyCubeBlock
SetEffect(string, float, bool, bool, bool) Activate block effect with parameters listed in definition See: Sandbox.Definitions.CubeBlockEffectBase

Inherited from IMyCubeBlock
SetEmissiveParts(string, Color, float) Sets the emissive value of a specific emissive material on entity.

Inherited from IMyEntity
SetEmissivePartsForSubparts(string, Color, float) Sets the emissive value of a specific emissive material on all entity subparts.

Inherited from IMyEntity
SetLocalMatrix(Matrix, object) Sets local matrix. When entity, has parent, it's world coordinates are calculated from localMatrix and parent world matrix

Inherited from IMyEntity
SetPosition(Vector3D) Set WorldMatrix's Translation . Moves entity.

Inherited from IMyEntity
SetTextureChangesForSubparts(Dictionary<MyStringId, MyTextureChange>) Sets subparts custom skinning. Copy values from TextureChanges , then change needed keys. You can retrieve values for exact skin with following code:csharp<br />MyDefinitionManager.Static.GetAssetModifierDefinitionForRender(skinId);<br /><br />

Inherited from IMyEntity
SetWorldMatrix(MatrixD, object) Sets world matrix of entity.

Inherited from IMyEntity
Teleport(MatrixD, object, bool) When moving entity over large distances or when entity has children, using this method preferred over SetPosition(Vector3D)

Inherited from IMyEntity
TryGetSubpart(string, out MyEntitySubpart) Gets subpart by subpart name

Inherited from IMyEntity
UpdateGamePruningStructure() Update position of entity in MyGamePruningStructure. Calls:csharp<br />MyGamePruningStructure.Move(this)<br /><br />

Inherited from IMyEntity
AddToGamePruningStructure() Obsolete: Only used during Sandbox removal.

Inherited from IMyEntity
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
RemoveFromGamePruningStructure() Obsolete: Only used during Sandbox removal.

Inherited from IMyEntity
SetCustomName(string) Obsolete: Use the setter of Customname

Obsolete

Inherited from IMyTerminalBlock
SetCustomName(StringBuilder) Obsolete: Use the setter of Customname

Obsolete

Inherited from IMyTerminalBlock
SetTextureChangesForSubparts(Dictionary<string, MyTextureChange>) Obsolete

This calling is obsolete, use another version.

Inherited from IMyEntity
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: