Space Engineers
Properties | List of all members
Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalAction Interface Reference

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. More...

Inheritance diagram for Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalAction:
Sandbox.ModAPI.Interfaces.ITerminalAction

Properties

Func< IMyTerminalBlock, bool > Enabled [set]
 Allows you to set if this action is enabled or disabled More...
 
List< MyToolbarTypeInvalidToolbarTypes [get, set]
 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. More...
 
bool ValidForGroups [get, set]
 Allows you to set if this action is valid in groups More...
 
new StringBuilder Name [get, set]
 Allows you to set the name of the Action More...
 
new string Icon [get, set]
 Allows you to set the Icon of this action. It's a link to an icon texture. More...
 
Action< IMyTerminalBlockAction [get, set]
 This is the action taken when an action is performed. More...
 
Action< IMyTerminalBlock, StringBuilder > Writer [get, set]
 This allows you to set the "Icon Text" of an action (the text that appears under the icon in the toolbar) More...
 
- Properties inherited from Sandbox.ModAPI.Interfaces.ITerminalAction
string Id [get]
 
string Icon [get]
 
StringBuilder Name [get]
 

Additional Inherited Members

- Public Member Functions inherited from Sandbox.ModAPI.Interfaces.ITerminalAction
void Apply (VRage.Game.ModAPI.Ingame.IMyCubeBlock block)
 
void Apply (VRage.Game.ModAPI.Ingame.IMyCubeBlock block, ListReader< TerminalActionParameter > terminalActionParameters)
 
void WriteValue (VRage.Game.ModAPI.Ingame.IMyCubeBlock block, StringBuilder appendTo)
 
bool IsEnabled (VRage.Game.ModAPI.Ingame.IMyCubeBlock block)
 

Detailed Description

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.

Definition at line 12 of file IMyTerminalAction.cs.

Property Documentation

Action<IMyTerminalBlock> Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalAction.Action
getset

This is the action taken when an action is performed.

Definition at line 37 of file IMyTerminalAction.cs.

Func<IMyTerminalBlock, bool> Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalAction.Enabled
set

Allows you to set if this action is enabled or disabled

Definition at line 17 of file IMyTerminalAction.cs.

new string Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalAction.Icon
getset

Allows you to set the Icon of this action. It's a link to an icon texture.

Definition at line 33 of file IMyTerminalAction.cs.

List<MyToolbarType> Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalAction.InvalidToolbarTypes
getset

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.

Definition at line 21 of file IMyTerminalAction.cs.

new StringBuilder Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalAction.Name
getset

Allows you to set the name of the Action

Definition at line 29 of file IMyTerminalAction.cs.

bool Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalAction.ValidForGroups
getset

Allows you to set if this action is valid in groups

Definition at line 25 of file IMyTerminalAction.cs.

Action<IMyTerminalBlock, StringBuilder> Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalAction.Writer
getset

This allows you to set the "Icon Text" of an action (the text that appears under the icon in the toolbar)

Definition at line 41 of file IMyTerminalAction.cs.


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