View source for API:Sandbox.ModAPI.Ingame.MyGridTerminalSystem

=Sandbox.ModAPI.Ingame.MyGridTerminalSystem=
MyGridTerminal system is a special class provided by Keen for use in the [[Programmable Block|programmable block's]] scripting editor. It is used to interface with all blocks on the local grid and any connected grids. This class will be used at least once by all scripts.
==Namespace==
[[Sandbox.ModAPI.Ingame]]
==Assembly==
[[Sandbox.Common]] (Sandbox.Common.dll)
==Syntax==
<syntaxhighlight lang="csharp">
public MyGridTerminalSystem
</syntaxhighlight>
==Methods==
===GetBlocksOfType===
<syntaxhighlight lang="csharp">
void GetBlocksOfType<T>(List<IMyTerminalBlock> blocks, Func<IMyterminalBlock, bool> collect = null)
</syntaxhighlight>
===GetBlockWithName===
<syntaxhighlight lang="csharp">
IMyTerminalBlock GetBlockWithName(string name)
</syntaxhighlight>
===SearchBlocksOfName===
<syntaxhighlight lang="csharp">
void SearchBlocksOfName(string name, List<IMyTerminalBlock> blocks, Func<IMyTerminalBlock, bool> collect = null)
</syntaxhighlight>
==Properties==
===BlockGroups===
<syntaxhighlight lang="csharp">
List<IMyBlockGroup> BlockGroups {get;}
</syntaxhighlight>
===Blocks===
<syntaxhighlight lang="csharp">
List<IMyTerminalBlock> Blocks {get;}
</syntaxhighlight>

==Examples==
===Search For Single Block With Name===
<syntaxhighlight lang="csharp">
void Main()
{
     IMyBeacon beacon = GridTerminalSystem.GetBlockWithName("Beacon"); //beacon is initialized to the first block that is named "Beacon"
}
</syntaxhighlight>
===Search For All Blocks Of Type===
<syntaxhighlight lang="csharp">
void Main()
{
     List<IMyTerminalBlock> blocks = new List<IMyTerminalBlock>();
     GridTerminalSystem.GetBlocksOfType<IMyBeacon>(blocks); //search for all blocks of type "beacon" and put them into the "blocks" list.
}
</syntaxhighlight>
===Search For All Blocks With Part of a Name===
<syntaxhighlight lang="csharp">
void Main()
{
     List<IMyTerminalBlock> blocks = new List<IMyTerminalBlock>();
     GridTerminalSystem.SearchBlocksOfName("[Docking]", blocks); //retrieves all blocks with the string [Docking] in the name and puts them into the blocks list.
}
</syntaxhighlight>

[[Category:API]][[Category:Programmable Block]][[Category:Sandbox.ModAPI.Ingame]]