Sandbox.ModAPI.Ingame.IMyProgrammableBlock Interface Reference

Inheritance diagram for Sandbox.ModAPI.Ingame.IMyProgrammableBlock:

Public Member Functions
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 running block.ApplyAction("Run", argumentsList); More...
Public Member Functions inherited from Sandbox.ModAPI.Ingame.IMyFunctionalBlock
void	RequestEnable (bool enable)
void	RequestEnable (bool enable)
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 ()

Properties
bool	IsRunning [get]
	This programmable block is currently running its program. More...
string	TerminalRunArgument [get]
	Contains the value of the default terminal argument. More...
Properties inherited from Sandbox.ModAPI.Ingame.IMyFunctionalBlock
bool	Enabled [get]
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]

Additional Inherited Members
Events inherited from Sandbox.ModAPI.Ingame.IMyFunctionalBlock
Action< IMyTerminalBlock >	EnabledChanged
Events inherited from Sandbox.ModAPI.Ingame.IMyTerminalBlock
Action< IMyTerminalBlock >	CustomNameChanged
Action< IMyTerminalBlock >	OwnershipChanged
Action< IMyTerminalBlock >	PropertiesChanged
Action< IMyTerminalBlock >	ShowOnHUDChanged
Action< IMyTerminalBlock >	VisibilityChanged
Events inherited from Sandbox.ModAPI.Ingame.IMyCubeBlock
Action< IMyCubeBlock >	IsWorkingChanged

Detailed Description

Definition at line 8 of file IMyProgrammableBlock.cs.

Member Function Documentation

bool Sandbox.ModAPI.Ingame.IMyProgrammableBlock.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 running block.ApplyAction("Run", argumentsList);

Parameters

argument

Returns

true if the action was applied, false otherwise

Property Documentation

bool Sandbox.ModAPI.Ingame.IMyProgrammableBlock.IsRunning

get

This programmable block is currently running its program.

Definition at line 13 of file IMyProgrammableBlock.cs.

string Sandbox.ModAPI.Ingame.IMyProgrammableBlock.TerminalRunArgument

get

Contains the value of the default terminal argument.

Definition at line 18 of file IMyProgrammableBlock.cs.

---

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

• Sources/Sandbox.Common/ModAPI/Ingame/IMyProgrammableBlock.cs