Sandbox.ModAPI.Ingame.IMyTerminalBlock
Contents
Sandbox.ModAPI.Ingame.IMyTerminalBlock
This is a base class for all blocks that show up in the terminal.
Namespace
Assembly
Sandbox.Common (Sandbox.Common.dll)
Syntax
public interface IMyTerminalBlock : IMyCubeBlock, IMyEntity
Methods
GetActions
void GetActions(List<ITerminalAction> resultList, Func<ITerminalAction, bool> collect = null)
This returns an ITerminalAction list containing a list of all valid actions for the block.
GetActionWithName
ITerminalAction GetActionWithName(string name)
This searches the block for an associated action corresponding to the specified name.
HasLocalPlayerAccess
bool HasLocalPlayerAccess()
HasPlayerAccess
bool HasPlayerAccess(long playerId)
RequestShowOnHUD
void RequestShowOnHUD(bool enable)
Enables or disables the ShowOnHUD option. If an antenna is present, the block will transmit its name and location to users in range of the antenna.
SearchActionsOfName
void SearchActionsOfName(string name, List<ITerminalAction> resultList, Func<ITerminalAction, bool> collect = null)
Search for all actions that start with the specified name. For instance, if you search for OnOff, you will get a list of actions returned including "OnOff_On" and "OnOff_Off"
SetCustomName
void SetCustomName(string text)
void SetCustomName(StringBuilder text)
This sets the name of the block. This is the same as changing the block's name in the terminal.
Properties
CustomName
string CustomName {get;}
The name of the block as shown in the terminal list.
CustomNameWithFaction
string CustomNameWithFaction {get;}
DetailedInfo
string DetailedInfo {get;}
ShowOnHUD
Bool ShowOnHUD {get;}
Returns whether or not ShowOnHUD is active.