Click or drag to resize
IMyProgrammableBlock Interface
v01.180.0 (Beta)

[This is preliminary documentation and is subject to change.]

Namespace: Sandbox.ModAPI.Ingame
Assembly: Sandbox.Common (in Sandbox.Common.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
public interface IMyProgrammableBlock : IMyFunctionalBlock, 
	IMyTerminalBlock, IMyCubeBlock, IMyEntity

The IMyProgrammableBlock type exposes the following members.

Methods
  NameDescription
Public methodGetActions (Inherited from IMyTerminalBlock.)
Public methodGetActionWithName (Inherited from IMyTerminalBlock.)
Public methodGetInventory (Inherited from IMyEntity.)
Public methodGetInventory(Int32) (Inherited from IMyEntity.)
Public methodGetOwnerFactionTag (Inherited from IMyCubeBlock.)
Public methodGetPlayerRelationToOwner Obsolete. (Inherited from IMyCubeBlock.)
Public methodGetPosition (Inherited from IMyEntity.)
Public methodGetProperties (Inherited from IMyTerminalBlock.)
Public methodGetProperty (Inherited from IMyTerminalBlock.)
Public methodGetUserRelationToOwner (Inherited from IMyCubeBlock.)
Public methodHasLocalPlayerAccess (Inherited from IMyTerminalBlock.)
Public methodHasPlayerAccess (Inherited from IMyTerminalBlock.)
Public methodRequestEnable Obsolete. (Inherited from IMyFunctionalBlock.)
Public methodSearchActionsOfName (Inherited from IMyTerminalBlock.)
Public methodSetCustomName(String) Obsolete. (Inherited from IMyTerminalBlock.)
Public methodSetCustomName(StringBuilder) Obsolete. (Inherited from IMyTerminalBlock.)
Public methodTryRun
Attempts to run this programmable block using the given argument. An already running programmable block cannot be run again. This is equivalent to running block.ApplyAction("Run", argumentsList); This should be called from an ingame script. Do not use in mods.
Public methodUpdateIsWorking Obsolete. (Inherited from IMyCubeBlock.)
Public methodUpdateVisual Obsolete. (Inherited from IMyCubeBlock.)
Top
Extension Methods
  NameDescription
Public Extension MethodApplyAction(String)Overloaded. (Defined by TerminalBlockExtentions.)
Public Extension MethodApplyAction(String, ListTerminalActionParameter)Overloaded. (Defined by TerminalBlockExtentions.)
Public Extension MethodGetDefaultValueT
Returns default value of specified property as TypeName
(Defined by TerminalPropertyExtensions.)
Public Extension MethodGetId (Defined by TerminalBlockExtentions.)
Public Extension MethodGetInventoryCount (Defined by TerminalBlockExtentions.)
Public Extension MethodGetMaximumT
Returns maximum value of specified property as TypeName
(Defined by TerminalPropertyExtensions.)
Public Extension MethodGetMinimumT
Returns minimum value of specified property as TypeName
(Defined by TerminalPropertyExtensions.)
Public Extension MethodGetMininumT (Defined by TerminalPropertyExtensions.)
Public Extension MethodGetUseConveyorSystem (Defined by TerminalBlockExtentions.)
Public Extension MethodGetValueT
Returns value of specified property as TypeName
(Defined by TerminalPropertyExtensions.)
Public Extension MethodGetValueBool
Returns value of specified property
(Defined by TerminalPropertyExtensions.)
Public Extension MethodGetValueColor
Returns value of specified property
(Defined by TerminalPropertyExtensions.)
Public Extension MethodGetValueFloat
Returns value of specified property
(Defined by TerminalPropertyExtensions.)
Public Extension MethodHasAction (Defined by TerminalBlockExtentions.)
Public Extension MethodHasInventory (Defined by TerminalBlockExtentions.)
Public Extension MethodSetUseConveyorSystem (Defined by TerminalBlockExtentions.)
Public Extension MethodSetValueT
Set value of property with type of TypeName
(Defined by TerminalPropertyExtensions.)
Public Extension MethodSetValueBool
Set bool value of property
(Defined by TerminalPropertyExtensions.)
Public Extension MethodSetValueColor
Set bool value of property
(Defined by TerminalPropertyExtensions.)
Public Extension MethodSetValueFloat
Set float value of property
(Defined by TerminalPropertyExtensions.)
Top
Properties
  NameDescription
Public propertyBlockDefinition (Inherited from IMyCubeBlock.)
Public propertyCheckConnectionAllowed (Inherited from IMyCubeBlock.)
Public propertyComponents (Inherited from IMyEntity.)
Public propertyCubeGrid (Inherited from IMyCubeBlock.)
Public propertyCustomData
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.)
Public propertyCustomInfo (Inherited from IMyTerminalBlock.)
Public propertyCustomName (Inherited from IMyTerminalBlock.)
Public propertyCustomNameWithFaction (Inherited from IMyTerminalBlock.)
Public propertyDefinitionDisplayNameText (Inherited from IMyCubeBlock.)
Public propertyDetailedInfo (Inherited from IMyTerminalBlock.)
Public propertyDisassembleRatio (Inherited from IMyCubeBlock.)
Public propertyDisplayName (Inherited from IMyEntity.)
Public propertyDisplayNameText (Inherited from IMyCubeBlock.)
Public propertyEnabled (Inherited from IMyFunctionalBlock.)
Public propertyEntityId (Inherited from IMyEntity.)
Public propertyHasInventory (Inherited from IMyEntity.)
Public propertyInventoryCount (Inherited from IMyEntity.)
Public propertyIsBeingHacked (Inherited from IMyCubeBlock.)
Public propertyIsFunctional (Inherited from IMyCubeBlock.)
Public propertyIsRunning
This programmable block is currently running its program.
Public propertyIsWorking (Inherited from IMyCubeBlock.)
Public propertyMass (Inherited from IMyCubeBlock.)
Public propertyMax (Inherited from IMyCubeBlock.)
Public propertyMin (Inherited from IMyCubeBlock.)
Public propertyName (Inherited from IMyEntity.)
Public propertyNumberInGrid (Inherited from IMyCubeBlock.)
Public propertyOrientation (Inherited from IMyCubeBlock.)
Public propertyOwnerId (Inherited from IMyCubeBlock.)
Public propertyPosition (Inherited from IMyCubeBlock.)
Public propertyShowInTerminal (Inherited from IMyTerminalBlock.)
Public propertyShowInToolbarConfig (Inherited from IMyTerminalBlock.)
Public propertyShowOnHUD (Inherited from IMyTerminalBlock.)
Public propertyTerminalRunArgument
Contains the value of the default terminal argument.
Public propertyWorldAABB (Inherited from IMyEntity.)
Public propertyWorldAABBHr (Inherited from IMyEntity.)
Public propertyWorldMatrix (Inherited from IMyEntity.)
Public propertyWorldVolume (Inherited from IMyEntity.)
Public propertyWorldVolumeHr (Inherited from IMyEntity.)
Top
See Also