Interface IMyBlockGroup
Describes terminal block group (PB scripting interface)
Namespace: Sandbox.ModAPI.Ingame
Assembly: Sandbox.Common.dll
Syntax
public interface IMyBlockGroupProperties
Name
Gets name of terminal blocks group
Declaration
string Name { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Methods
GetBlocks(List<IMyTerminalBlock>, Func<IMyTerminalBlock, Boolean>)
Get terminal blocks which assigned to this group
Declaration
void GetBlocks(List<IMyTerminalBlock> blocks, Func<IMyTerminalBlock, bool> collect = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.List<IMyTerminalBlock> | blocks | buffer array |
| System.Func<IMyTerminalBlock, System.Boolean> | collect | if function returns true, block would be added to |
GetBlocksOfType<T>(List<T>, Func<T, Boolean>)
Get terminal blocks which assigned to this group, and matching type
Declaration
void GetBlocksOfType<T>(List<T> blocks, Func<T, bool> collect = null)
where T : classParameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.List<T> | blocks | Buffer array that would receive results. It is cleared before call. Can be null |
| System.Func<T, System.Boolean> | collect | if function returns true, block would be added to |
Type Parameters
| Name | Description |
|---|---|
| T | Block must be assignable from T |
Exceptions
| Type | Condition |
|---|---|
| System.NullReferenceException | If function |
GetBlocksOfType<T>(List<IMyTerminalBlock>, Func<IMyTerminalBlock, Boolean>)
Get terminal blocks which assigned to this group, and matching type
Declaration
void GetBlocksOfType<T>(List<IMyTerminalBlock> blocks, Func<IMyTerminalBlock, bool> collect = null)
where T : classParameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.List<IMyTerminalBlock> | blocks | buffer array |
| System.Func<IMyTerminalBlock, System.Boolean> | collect | if function returns true, block would be added to |
Type Parameters
| Name | Description |
|---|---|
| T | Block must be assignable from T |
Exceptions
| Type | Condition |
|---|---|
| System.NullReferenceException | If function |