Sandbox.ModAPI.Interfaces.Terminal
IMyTerminalAction
Assembly: Sandbox.Common.dll
public interface IMyTerminalAction: ITerminalAction
This is an interface wrapper for terminal actions that appear on a toolbar. An instance of this interface is created via MyAPIGateway.TerminalControls.CreateAction. Once created, you may modify various fields to control how the action behaves.
Properties
| Member | Description |
|---|---|
| Action | This is the action taken when an action is performed. |
| Enabled | Allows you to set if this action is enabled or disabled |
| Icon | Allows you to set the Icon of this action. It's a link to an icon texture. |
| InvalidToolbarTypes | Allows you to set which toolbar type this action is invalid for. Adding to this means this action may not be added to that toolbar type. |
| Name | Allows you to set the name of the Action |
| ValidForGroups | Allows you to set if this action is valid in groups |
| Writer | This allows you to set the "Icon Text" of an action (the text that appears under the icon in the toolbar) |
| Icon | Gets the icon of the action Inherited from ITerminalAction |
| Id | Gets the id of the action Inherited from ITerminalAction |
| Name | Gets the name of the action Inherited from ITerminalAction |
Methods
| Member | Description |
|---|---|
| Apply(IMyCubeBlock) | Applies action on the block Inherited from ITerminalAction |
| Apply(IMyCubeBlock, ListReader |
Applies action on the block with specific action parameters Inherited from ITerminalAction |
| IsEnabled(IMyCubeBlock) | Checks if action is enabled for specific block Inherited from ITerminalAction |
| WriteValue(IMyCubeBlock, StringBuilder) | Writes value for the action Inherited from ITerminalAction |
Implements: