Space Engineers
Public Member Functions | Events | List of all members
Sandbox.ModAPI.IMyTerminalBlock Interface Reference
Inheritance diagram for Sandbox.ModAPI.IMyTerminalBlock:
VRage.Game.ModAPI.IMyCubeBlock Sandbox.ModAPI.Ingame.IMyTerminalBlock VRage.Game.ModAPI.Ingame.IMyCubeBlock VRage.ModAPI.IMyEntity Sandbox.ModAPI.Ingame.IMyCubeBlock Sandbox.ModAPI.Ingame.IMyCubeBlock VRage.Game.ModAPI.Ingame.IMyEntity VRage.Game.ModAPI.Ingame.IMyEntity Sandbox.Game.Entities.Cube.MyTerminalBlock Sandbox.ModAPI.IMyCargoContainer Sandbox.ModAPI.IMyFunctionalBlock Sandbox.ModAPI.IMyShipController Sandbox.ModAPI.IMyWarhead SpaceEngineers.Game.ModAPI.IMyButtonPanel SpaceEngineers.Game.ModAPI.IMyControlPanel SpaceEngineers.Game.ModAPI.IMyOxygenFarm SpaceEngineers.Game.ModAPI.IMySolarPanel

Public Member Functions

void RefreshCustomInfo ()
 Raises AppendingCustomInfo so every subscriber can append custom info. More...
 
- Public Member Functions inherited from VRage.Game.ModAPI.IMyCubeBlock
void CalcLocalMatrix (out VRageMath.Matrix localMatrix, out string currModel)
 
string CalculateCurrentModel (out VRageMath.Matrix orientation)
 Calculates model currently used by block depending on its build progress and other factors More...
 
bool DebugDraw ()
 Debug only method. Effects may wary through time. More...
 
MyObjectBuilder_CubeBlock GetObjectBuilderCubeBlock (bool copy=false)
 Returns block object builder which can be serialized or added to grid More...
 
string GetOwnerFactionTag ()
 
VRage.Game.MyRelationsBetweenPlayerAndBlock GetPlayerRelationToOwner ()
 
VRage.Game.MyRelationsBetweenPlayerAndBlock GetUserRelationToOwner (long playerId)
 
void Init ()
 Reloads block model and interactive objects (doors, terminals, etc...) More...
 
void Init (MyObjectBuilder_CubeBlock builder, IMyCubeGrid cubeGrid)
 Initializes block state from object builder More...
 
void OnBuildSuccess (long builtBy)
 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. More...
 
void OnDestroy ()
 Called when block is destroyed before being removed from grid More...
 
void OnModelChange ()
 Called when the model referred by the block is changed More...
 
void OnRegisteredToGridSystems ()
 Called at the end of registration from grid systems (after block has been registered). More...
 
void OnRemovedByCubeBuilder ()
 Method called when user removes a cube block from grid. Useful when block has to remove some other attached block (like motors). More...
 
void OnUnregisteredFromGridSystems ()
 Called at the end of unregistration from grid systems (after block has been unregistered). More...
 
string RaycastDetectors (VRageMath.Vector3 worldFrom, VRageMath.Vector3 worldTo)
 Gets the name of interactive object intersected by defined line More...
 
void ReloadDetectors (bool refreshNetworks=true)
 Reloads detectors (interactive objects) in model More...
 
void UpdateIsWorking ()
 Force refresh working state. Call if you change block state that could affect its working status. More...
 
void UpdateVisual ()
 Updates block visuals (ie. block emissivity) More...
 
void SetDamageEffect (bool start)
 Start or stop dammage effect on cube block More...
 
void AddUpgradeValue (string upgrade, float defaultValue)
 Preferred way of registering a block for upgrades Adding directly to the dictionary can have unintended consequences when multiple mods are involved. More...
 
- Public Member Functions inherited from VRage.Game.ModAPI.Ingame.IMyEntity
VRageMath.Vector3D GetPosition ()
 
- Public Member Functions inherited from VRage.ModAPI.IMyEntity
string GetFriendlyName ()
 
void Close ()
 
void Delete ()
 
MyObjectBuilder_EntityBase GetObjectBuilder (bool copy=false)
 
void BeforeSave ()
 
IMyEntity GetTopMostParent (Type type=null)
 
void SetLocalMatrix (VRageMath.Matrix localMatrix, object source=null)
 
void GetChildren (List< IMyEntity > children, Func< IMyEntity, bool > collect=null)
 
MyEntitySubpart GetSubpart (string name)
 
bool TryGetSubpart (string name, out MyEntitySubpart subpart)
 
VRageMath.Vector3 GetDiffuseColor ()
 
bool IsVisible ()
 
void DebugDrawInvalidTriangles ()
 
void EnableColorMaskForSubparts (bool enable)
 
void SetColorMaskForSubparts (VRageMath.Vector3 colorMaskHsv)
 
void SetEmissiveParts (string emissiveName, Color emissivePartColor, float emissivity)
 Sets the emissive value of a specific emissive material on entity. More...
 
void SetEmissivePartsForSubparts (string emissiveName, Color emissivePartColor, float emissivity)
 Sets the emissive value of a specific emissive material on all entity subparts. More...
 
float GetDistanceBetweenCameraAndBoundingSphere ()
 
float GetDistanceBetweenCameraAndPosition ()
 
float GetLargestDistanceBetweenCameraAndBoundingSphere ()
 
float GetSmallestDistanceBetweenCameraAndBoundingSphere ()
 
void OnRemovedFromScene (object source)
 
void OnAddedToScene (object source)
 
MatrixD GetViewMatrix ()
 
MatrixD GetWorldMatrixNormalizedInv ()
 
void SetWorldMatrix (VRageMath.MatrixD worldMatrix, object source=null)
 
void SetPosition (VRageMath.Vector3D pos)
 
bool GetIntersectionWithLine (ref LineD line, out VRage.Game.Models.MyIntersectionResultLineTriangleEx?tri, IntersectionFlags flags)
 
Vector3 GetIntersectionWithLineAndBoundingSphere (ref LineD line, float boundingSphereRadiusMultiplier)
 
bool GetIntersectionWithSphere (ref BoundingSphereD sphere)
 
void GetTrianglesIntersectingSphere (ref BoundingSphereD sphere, Vector3?referenceNormalVector, float?maxAngle, System.Collections.Generic.List< MyTriangle_Vertex_Normals > retTriangles, int maxNeighbourTriangles)
 
bool DoOverlapSphereTest (float sphereRadius, Vector3D spherePos)
 
void AddToGamePruningStructure ()
 
void RemoveFromGamePruningStructure ()
 
void UpdateGamePruningStructure ()
 
- Public Member Functions inherited from Sandbox.ModAPI.Ingame.IMyTerminalBlock
bool HasLocalPlayerAccess ()
 
bool HasPlayerAccess (long playerId)
 
void SetCustomName (string text)
 
void SetCustomName (StringBuilder text)
 
void GetActions (List< Sandbox.ModAPI.Interfaces.ITerminalAction > resultList, Func< Sandbox.ModAPI.Interfaces.ITerminalAction, bool > collect=null)
 
void SearchActionsOfName (string name, List< Sandbox.ModAPI.Interfaces.ITerminalAction > resultList, Func< Sandbox.ModAPI.Interfaces.ITerminalAction, bool > collect=null)
 
Sandbox.ModAPI.Interfaces.ITerminalAction GetActionWithName (string name)
 
Sandbox.ModAPI.Interfaces.ITerminalProperty GetProperty (string id)
 
void GetProperties (List< Sandbox.ModAPI.Interfaces.ITerminalProperty > resultList, Func< Sandbox.ModAPI.Interfaces.ITerminalProperty, bool > collect=null)
 
bool HasLocalPlayerAccess ()
 
bool HasPlayerAccess (long playerId)
 
void RequestShowOnHUD (bool enable)
 
void SetCustomName (string text)
 
void SetCustomName (StringBuilder text)
 
void GetActions (List< Sandbox.ModAPI.Interfaces.ITerminalAction > resultList, Func< Sandbox.ModAPI.Interfaces.ITerminalAction, bool > collect=null)
 
- Public Member Functions inherited from Sandbox.ModAPI.Ingame.IMyCubeBlock
string GetOwnerFactionTag ()
 
Sandbox.Common.MyRelationsBetweenPlayerAndBlock GetPlayerRelationToOwner ()
 
Sandbox.Common.MyRelationsBetweenPlayerAndBlock GetUserRelationToOwner (long playerId)
 
void UpdateIsWorking ()
 
void UpdateVisual ()
 

Events

Action< IMyTerminalBlockCustomNameChanged
 
Action< IMyTerminalBlockOwnershipChanged
 
Action< IMyTerminalBlockPropertiesChanged
 
Action< IMyTerminalBlockShowOnHUDChanged
 
Action< IMyTerminalBlockVisibilityChanged
 
Action< IMyTerminalBlock, StringBuilder > AppendingCustomInfo
 Event to append custom info. More...
 
- Events inherited from VRage.Game.ModAPI.IMyCubeBlock
Action< IMyCubeBlockIsWorkingChanged
 
Action OnUpgradeValuesChanged
 Event called when upgrade values are changed Either upgrades were built or destroyed, or they become damaged or unpowered More...
 
- Events inherited from VRage.ModAPI.IMyEntity
Action< IMyEntityOnClose
 
Action< IMyEntityOnClosing
 
Action< IMyEntityOnMarkForClose
 
Action< IMyEntityOnPhysicsChanged
 
- Events inherited from Sandbox.ModAPI.Ingame.IMyTerminalBlock
Action< IMyTerminalBlockCustomNameChanged
 
Action< IMyTerminalBlockOwnershipChanged
 
Action< IMyTerminalBlockPropertiesChanged
 
Action< IMyTerminalBlockShowOnHUDChanged
 
Action< IMyTerminalBlockVisibilityChanged
 
- Events inherited from Sandbox.ModAPI.Ingame.IMyCubeBlock
Action< IMyCubeBlockIsWorkingChanged
 

Additional Inherited Members

- Properties inherited from VRage.Game.ModAPI.IMyCubeBlock
SerializableDefinitionId BlockDefinition [get]
 
bool CheckConnectionAllowed [get, set]
 Whether the grid should call the ConnectionAllowed method for this block (ConnectionAllowed checks mount points and other per-block requirements) More...
 
IMyCubeGrid CubeGrid [get]
 Grid in which the block is placed More...
 
String DefinitionDisplayNameText [get]
 Definition name More...
 
float DisassembleRatio [get]
 Is set in definition Ratio at which is the block disassembled (grinding) More...
 
String DisplayNameText [get]
 Translated block name More...
 
bool IsBeingHacked [get]
 
bool IsFunctional [get]
 True if integrity is above breaking threshold More...
 
bool IsWorking [get]
 True if block is able to do its work depening on block type (is functional, powered, enabled, etc...) More...
 
VRageMath.Vector3I Max [get]
 Maximum coordinates of grid cells occupied by this block More...
 
float Mass [get]
 Block mass More...
 
VRageMath.Vector3I Min [get]
 Minimum coordinates of grid cells occupied by this block More...
 
int NumberInGrid [get, set]
 Order in which were the blocks of same type added to grid Used in default display name More...
 
VRageMath.MyBlockOrientation Orientation [get]
 Returns block orientation in base 6 directions More...
 
long OwnerId [get]
 Id of player owning block (not steam Id) More...
 
VRageMath.Vector3I Position [get]
 Position in grid coordinates More...
 
Dictionary< string, float > UpgradeValues [get]
 Get all values changed by upgrade modules Should only be used as read-only More...
 
IMySlimBlock SlimBlock [get]
 Gets the SlimBlock associated with this block More...
 
- Properties inherited from VRage.Game.ModAPI.Ingame.IMyCubeBlock
SerializableDefinitionId BlockDefinition [get]
 
bool CheckConnectionAllowed [get]
 
IMyCubeGrid CubeGrid [get]
 
String DefinitionDisplayNameText [get]
 
float DisassembleRatio [get]
 
String DisplayNameText [get]
 
bool IsBeingHacked [get]
 
bool IsFunctional [get]
 
bool IsWorking [get]
 
VRageMath.Vector3I Max [get]
 
float Mass [get]
 Block mass More...
 
VRageMath.Vector3I Min [get]
 
int NumberInGrid [get]
 
VRageMath.MyBlockOrientation Orientation [get]
 
long OwnerId [get]
 
VRageMath.Vector3I Position [get]
 
- Properties inherited from VRage.Game.ModAPI.Ingame.IMyEntity
MyEntityComponentContainer Components [get]
 
long EntityId [get]
 
VRageMath.BoundingBoxD WorldAABB [get]
 
VRageMath.BoundingBoxD WorldAABBHr [get]
 
VRageMath.MatrixD WorldMatrix [get]
 
VRageMath.BoundingSphereD WorldVolume [get]
 
VRageMath.BoundingSphereD WorldVolumeHr [get]
 
- Properties inherited from VRage.ModAPI.IMyEntity
MyEntityComponentContainer Components [get]
 
MyPhysicsComponentBase Physics [get, set]
 
MyPositionComponentBase PositionComp [get, set]
 
MyRenderComponentBase Render [get, set]
 
MyEntityComponentBase GameLogic [get, set]
 
MyHierarchyComponentBase Hierarchy [get, set]
 
MySyncComponentBase SyncObject [get]
 
MyModStorageComponentBase Storage [get, set]
 Custom storage for mods. Shared with all mods. More...
 
EntityFlags Flags [get, set]
 
long EntityId [get, set]
 
string Name [get, set]
 
bool MarkedForClose [get]
 
bool Closed [get]
 
bool DebugAsyncLoading [get]
 
bool Save [get, set]
 
MyPersistentEntityFlags2 PersistentFlags [get, set]
 
MyEntityUpdateEnum NeedsUpdate [get, set]
 
IMyEntity Parent [get]
 
Matrix LocalMatrix [get, set]
 
bool NearFlag [get, set]
 
bool CastShadows [get, set]
 
bool FastCastShadowResolve [get, set]
 
bool NeedsResolveCastShadow [get, set]
 
float MaxGlassDistSq [get]
 
bool NeedsDraw [get, set]
 
bool NeedsDrawFromParent [get, set]
 
bool Transparent [get, set]
 
bool ShadowBoxLod [get, set]
 
bool SkipIfTooSmall [get, set]
 
bool Visible [get, set]
 
bool InScene [get, set]
 
bool InvalidateOnMove [get]
 
new VRageMath.MatrixD WorldMatrix [get, set]
 
VRageMath.MatrixD WorldMatrixInvScaled [get]
 
VRageMath.MatrixD WorldMatrixNormalizedInv [get]
 
bool IsVolumetric [get]
 
BoundingBox LocalAABB [get, set]
 
BoundingBox LocalAABBHr [get]
 
BoundingSphere LocalVolume [get, set]
 
Vector3 LocalVolumeOffset [get, set]
 
Vector3 LocationForHudMarker [get]
 
bool IsCCDForProjectiles [get]
 
string DisplayName [get, set]
 
- Properties inherited from Sandbox.ModAPI.Ingame.IMyTerminalBlock
string CustomName [get]
 
string CustomNameWithFaction [get]
 
string DetailedInfo [get]
 
string CustomInfo [get]
 
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 More...
 
bool ShowOnHUD [get]
 
- Properties inherited from Sandbox.ModAPI.Ingame.IMyCubeBlock
Sandbox.Common.ObjectBuilders.Definitions.SerializableDefinitionId BlockDefinition [get]
 
bool CheckConnectionAllowed [get]
 
IMyCubeGrid CubeGrid [get]
 
String DefinitionDisplayNameText [get]
 
float DisassembleRatio [get]
 
String DisplayNameText [get]
 
bool IsBeingHacked [get]
 
bool IsFunctional [get]
 
bool IsWorking [get]
 
VRageMath.Vector3I Max [get]
 
VRageMath.Vector3I Min [get]
 
int NumberInGrid [get]
 
VRageMath.MyBlockOrientation Orientation [get]
 
long OwnerId [get]
 
VRageMath.Vector3I Position [get]
 

Detailed Description

Definition at line 9 of file IMyTerminalBlock.cs.

Member Function Documentation

void Sandbox.ModAPI.IMyTerminalBlock.RefreshCustomInfo ( )

Raises AppendingCustomInfo so every subscriber can append custom info.

Implemented in Sandbox.Game.Entities.Cube.MyTerminalBlock.

Event Documentation

Action<IMyTerminalBlock, StringBuilder> Sandbox.ModAPI.IMyTerminalBlock.AppendingCustomInfo

Event to append custom info.

Definition at line 20 of file IMyTerminalBlock.cs.

Action<IMyTerminalBlock> Sandbox.ModAPI.IMyTerminalBlock.CustomNameChanged

Definition at line 11 of file IMyTerminalBlock.cs.

Action<IMyTerminalBlock> Sandbox.ModAPI.IMyTerminalBlock.OwnershipChanged

Definition at line 12 of file IMyTerminalBlock.cs.

Action<IMyTerminalBlock> Sandbox.ModAPI.IMyTerminalBlock.PropertiesChanged

Definition at line 13 of file IMyTerminalBlock.cs.

Action<IMyTerminalBlock> Sandbox.ModAPI.IMyTerminalBlock.ShowOnHUDChanged

Definition at line 14 of file IMyTerminalBlock.cs.

Action<IMyTerminalBlock> Sandbox.ModAPI.IMyTerminalBlock.VisibilityChanged

Definition at line 15 of file IMyTerminalBlock.cs.


The documentation for this interface was generated from the following file: