Skip to content
This repository was archived by the owner on Dec 13, 2025. It is now read-only.

Sandbox.ModAPI.Ingame.IMyProgrammableBlock

Jump to bottom
Malware edited this page Dec 21, 2018 · 62 revisions

← Index

IMyProgrammableBlock Interface

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

Properties

Member Description
bool IsRunning
string TerminalRunArgument
MyEntityComponentContainer Components Inherited from IMyEntity
long EntityId Inherited from IMyEntity
string Name Inherited from IMyEntity
string DisplayName Inherited from IMyEntity
bool HasInventory Inherited from IMyEntity
int InventoryCount Inherited from IMyEntity
BoundingBoxD WorldAABB Inherited from IMyEntity
BoundingBoxD WorldAABBHr Inherited from IMyEntity
MatrixD WorldMatrix Inherited from IMyEntity
BoundingSphereD WorldVolume Inherited from IMyEntity
BoundingSphereD WorldVolumeHr Inherited from IMyEntity
SerializableDefinitionId BlockDefinition Inherited from IMyCubeBlock
bool CheckConnectionAllowed Inherited from IMyCubeBlock
IMyCubeGrid CubeGrid Inherited from IMyCubeBlock
string DefinitionDisplayNameText Inherited from IMyCubeBlock
float DisassembleRatio Inherited from IMyCubeBlock
string DisplayNameText Inherited from IMyCubeBlock
bool IsBeingHacked Inherited from IMyCubeBlock
bool IsFunctional Inherited from IMyCubeBlock
bool IsWorking Inherited from IMyCubeBlock
Vector3I Max Inherited from IMyCubeBlock
float Mass Inherited from IMyCubeBlock
Vector3I Min Inherited from IMyCubeBlock
int NumberInGrid Inherited from IMyCubeBlock
MyBlockOrientation Orientation Inherited from IMyCubeBlock
long OwnerId Inherited from IMyCubeBlock
Vector3I Position Inherited from IMyCubeBlock
string CustomName Inherited from IMyTerminalBlock
string CustomNameWithFaction Inherited from IMyTerminalBlock
string DetailedInfo Inherited from IMyTerminalBlock
string CustomInfo Inherited from IMyTerminalBlock
string CustomData Inherited from IMyTerminalBlock
bool ShowOnHUD Inherited from IMyTerminalBlock
bool ShowInTerminal Inherited from IMyTerminalBlock
bool ShowInToolbarConfig Inherited from IMyTerminalBlock
bool ShowInInventory Inherited from IMyTerminalBlock
bool Enabled Inherited from IMyFunctionalBlock

Methods

Member Description
bool TryRun(string argument) Attempts to run this programmable block using the given argument. An already running programmable block cannot be run again. This is equivalent to runningblock.ApplyAction("Run", argumentsList);This should be called from an ingame script. Do not use in mods.
IMyInventory GetInventory() Inherited from IMyEntity
IMyInventory GetInventory(int index) Search for inventory component with maching index.

Inherited from IMyEntity
Vector3D GetPosition() Inherited from IMyEntity
string GetOwnerFactionTag() Inherited from IMyCubeBlock
MyRelationsBetweenPlayerAndBlock GetPlayerRelationToOwner() Inherited from IMyCubeBlock
MyRelationsBetweenPlayerAndBlock GetUserRelationToOwner(long playerId) Inherited from IMyCubeBlock
void UpdateIsWorking() Inherited from IMyCubeBlock
void UpdateVisual() Inherited from IMyCubeBlock
bool HasLocalPlayerAccess() Inherited from IMyTerminalBlock
bool HasPlayerAccess(long playerId) Inherited from IMyTerminalBlock
void SetCustomName(string text) Inherited from IMyTerminalBlock
void SetCustomName(StringBuilder text) Inherited from IMyTerminalBlock
void GetActions(List<ITerminalAction> resultList, Func<ITerminalAction, bool> collect) Inherited from IMyTerminalBlock
void SearchActionsOfName(string name, List<ITerminalAction> resultList, Func<ITerminalAction, bool> collect) Inherited from IMyTerminalBlock
ITerminalAction GetActionWithName(string name) Inherited from IMyTerminalBlock
ITerminalProperty GetProperty(string id) Inherited from IMyTerminalBlock
void GetProperties(List<ITerminalProperty> resultList, Func<ITerminalProperty, bool> collect) Inherited from IMyTerminalBlock
bool IsSameConstructAs(IMyTerminalBlock other) 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.

Inherited from IMyTerminalBlock
void RequestEnable(bool enable) Inherited from IMyFunctionalBlock

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