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

Public Member Functions

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

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]
 

Events

Action< IMyTerminalBlockCustomNameChanged
 
Action< IMyTerminalBlockOwnershipChanged
 
Action< IMyTerminalBlockPropertiesChanged
 
Action< IMyTerminalBlockShowOnHUDChanged
 
Action< IMyTerminalBlockVisibilityChanged
 
- Events inherited from Sandbox.ModAPI.Ingame.IMyCubeBlock
Action< IMyCubeBlockIsWorkingChanged
 

Detailed Description

Definition at line 11 of file IMyTerminalBlock.cs.

Member Function Documentation

void Sandbox.ModAPI.Ingame.IMyTerminalBlock.GetActions ( List< Sandbox.ModAPI.Interfaces.ITerminalAction resultList,
Func< Sandbox.ModAPI.Interfaces.ITerminalAction, bool >  collect = null 
)
void Sandbox.ModAPI.Ingame.IMyTerminalBlock.GetActions ( List< Sandbox.ModAPI.Interfaces.ITerminalAction resultList,
Func< Sandbox.ModAPI.Interfaces.ITerminalAction, bool >  collect = null 
)
Sandbox.ModAPI.Interfaces.ITerminalAction Sandbox.ModAPI.Ingame.IMyTerminalBlock.GetActionWithName ( string  name)
void Sandbox.ModAPI.Ingame.IMyTerminalBlock.GetProperties ( List< Sandbox.ModAPI.Interfaces.ITerminalProperty resultList,
Func< Sandbox.ModAPI.Interfaces.ITerminalProperty, bool >  collect = null 
)
Sandbox.ModAPI.Interfaces.ITerminalProperty Sandbox.ModAPI.Ingame.IMyTerminalBlock.GetProperty ( string  id)
bool Sandbox.ModAPI.Ingame.IMyTerminalBlock.HasLocalPlayerAccess ( )
bool Sandbox.ModAPI.Ingame.IMyTerminalBlock.HasLocalPlayerAccess ( )
bool Sandbox.ModAPI.Ingame.IMyTerminalBlock.HasPlayerAccess ( long  playerId)
bool Sandbox.ModAPI.Ingame.IMyTerminalBlock.HasPlayerAccess ( long  playerId)
void Sandbox.ModAPI.Ingame.IMyTerminalBlock.RequestShowOnHUD ( bool  enable)
void Sandbox.ModAPI.Ingame.IMyTerminalBlock.SearchActionsOfName ( string  name,
List< Sandbox.ModAPI.Interfaces.ITerminalAction resultList,
Func< Sandbox.ModAPI.Interfaces.ITerminalAction, bool >  collect = null 
)
void Sandbox.ModAPI.Ingame.IMyTerminalBlock.SetCustomName ( string  text)
void Sandbox.ModAPI.Ingame.IMyTerminalBlock.SetCustomName ( StringBuilder  text)
void Sandbox.ModAPI.Ingame.IMyTerminalBlock.SetCustomName ( string  text)
void Sandbox.ModAPI.Ingame.IMyTerminalBlock.SetCustomName ( StringBuilder  text)

Property Documentation

string Sandbox.ModAPI.Ingame.IMyTerminalBlock.CustomData
getset

Gets or sets the Custom Data string. NOTE: Only use this for user input. For storing large mod configs, create your own MyModStorageComponent

Definition at line 21 of file IMyTerminalBlock.cs.

string Sandbox.ModAPI.Ingame.IMyTerminalBlock.CustomInfo
get

Definition at line 16 of file IMyTerminalBlock.cs.

string Sandbox.ModAPI.Ingame.IMyTerminalBlock.CustomName
get

Definition at line 13 of file IMyTerminalBlock.cs.

string Sandbox.ModAPI.Ingame.IMyTerminalBlock.CustomNameWithFaction
get

Definition at line 14 of file IMyTerminalBlock.cs.

string Sandbox.ModAPI.Ingame.IMyTerminalBlock.DetailedInfo
get

Definition at line 15 of file IMyTerminalBlock.cs.

bool Sandbox.ModAPI.Ingame.IMyTerminalBlock.ShowOnHUD
get

Definition at line 26 of file IMyTerminalBlock.cs.

Event Documentation

Action<IMyTerminalBlock> Sandbox.ModAPI.Ingame.IMyTerminalBlock.CustomNameChanged

Definition at line 19 of file IMyTerminalBlock.cs.

Action<IMyTerminalBlock> Sandbox.ModAPI.Ingame.IMyTerminalBlock.OwnershipChanged

Definition at line 20 of file IMyTerminalBlock.cs.

Action<IMyTerminalBlock> Sandbox.ModAPI.Ingame.IMyTerminalBlock.PropertiesChanged

Definition at line 21 of file IMyTerminalBlock.cs.

Action<IMyTerminalBlock> Sandbox.ModAPI.Ingame.IMyTerminalBlock.ShowOnHUDChanged

Definition at line 22 of file IMyTerminalBlock.cs.

Action<IMyTerminalBlock> Sandbox.ModAPI.Ingame.IMyTerminalBlock.VisibilityChanged

Definition at line 23 of file IMyTerminalBlock.cs.


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