Space Engineers
Public Member Functions | Properties | List of all members
Sandbox.Game.Gui.ITerminalAction Interface Reference
Inheritance diagram for Sandbox.Game.Gui.ITerminalAction:
Sandbox.ModAPI.Interfaces.ITerminalAction Sandbox.Game.Gui.MyTerminalAction< TBlock >

Public Member Functions

void Apply (MyTerminalBlock block)
 
void WriteValue (MyTerminalBlock block, StringBuilder appendTo)
 
bool IsEnabled (MyTerminalBlock block)
 
bool IsValidForToolbarType (MyToolbarType toolbarType)
 
bool IsValidForGroups ()
 
ListReader< TerminalActionParameterGetParameterDefinitions ()
 This collection contains the names, types and default values of any available parameter for this action. More...
 
void RequestParameterCollection (IList< TerminalActionParameter > parameters, Action< bool > callback)
 If available, this method will show any dialogs required to retrieve user arguments for the given action. More...
 
void Apply (MyTerminalBlock block, ListReader< TerminalActionParameter > parameters)
 Applies the action with the given parameter list. More...
 
- 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)
 

Properties

new string Id [get]
 
new string Icon [get]
 
new StringBuilder Name [get]
 
- Properties inherited from Sandbox.ModAPI.Interfaces.ITerminalAction
string Id [get]
 
string Icon [get]
 
StringBuilder Name [get]
 

Detailed Description

Definition at line 14 of file ITerminalAction.cs.

Member Function Documentation

void Sandbox.Game.Gui.ITerminalAction.Apply ( MyTerminalBlock  block)
void Sandbox.Game.Gui.ITerminalAction.Apply ( MyTerminalBlock  block,
ListReader< TerminalActionParameter parameters 
)

Applies the action with the given parameter list.

Parameters
block
parameters

Implemented in Sandbox.Game.Gui.MyTerminalAction< TBlock >.

ListReader<TerminalActionParameter> Sandbox.Game.Gui.ITerminalAction.GetParameterDefinitions ( )

This collection contains the names, types and default values of any available parameter for this action.

bool Sandbox.Game.Gui.ITerminalAction.IsEnabled ( MyTerminalBlock  block)
bool Sandbox.Game.Gui.ITerminalAction.IsValidForGroups ( )
bool Sandbox.Game.Gui.ITerminalAction.IsValidForToolbarType ( MyToolbarType  toolbarType)
void Sandbox.Game.Gui.ITerminalAction.RequestParameterCollection ( IList< TerminalActionParameter parameters,
Action< bool >  callback 
)

If available, this method will show any dialogs required to retrieve user arguments for the given action.

Parameters
callbackThe callback to run when any dialog is complete
parametersThe parameters collection to be filled. This list will be cleared of any existing items.

Implemented in Sandbox.Game.Gui.MyTerminalAction< TBlock >.

void Sandbox.Game.Gui.ITerminalAction.WriteValue ( MyTerminalBlock  block,
StringBuilder  appendTo 
)

Property Documentation

new string Sandbox.Game.Gui.ITerminalAction.Icon
get

Definition at line 17 of file ITerminalAction.cs.

new string Sandbox.Game.Gui.ITerminalAction.Id
get

Definition at line 16 of file ITerminalAction.cs.

new StringBuilder Sandbox.Game.Gui.ITerminalAction.Name
get

Definition at line 18 of file ITerminalAction.cs.


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