Inheritance diagram for Sandbox.Game.Gui.MyTerminalControls:

Public Member Functions
	MyTerminalControls ()

List< ITerminalControl >	GetControls (IMyTerminalBlock block)

void	GetControls< TBlock > (out List< IMyTerminalControl > items)
	Gets the controls associated with a block. More...

void	AddControl< TBlock > (IMyTerminalControl item)
	Adds a terminal control to a block. More...

void	RemoveControl< TBlock > (IMyTerminalControl item)
	Removes a terminal control from a block. More...

TControl	CreateControl< TControl, TBlock > (string id)
	This will create a control to be added to the terminal screen. This only really applies to ModAPI, as MyTerminalControlFactory class isn't whitelist More...

IMyTerminalControlProperty< TValue >	CreateProperty< TValue, TBlock > (string id)
	This creates a property that can be added to a block. A property is not visible on the terminal screen but can hold a value that can be used in programmable blocks. More...

List< ITerminalAction >	GetActions (IMyTerminalBlock block)

void	GetActions< TBlock > (out List< IMyTerminalAction > items)
	This allows you to get all actions associated with this block. More...

void	AddAction< TBlock > (IMyTerminalAction action)
	This allows you to add an action to an assocated block More...

void	RemoveAction< TBlock > (IMyTerminalAction action)
	This allows you to remove an action from a block More...

IMyTerminalAction	CreateAction< TBlock > (string id)
	This allows you to create an action to associate with a block More...

Public Member Functions inherited from VRage.Game.Components.MySessionComponentBase
virtual bool	UpdatedBeforeInit ()

	MySessionComponentBase ()

void	SetUpdateOrder (MyUpdateOrder order)

virtual void	InitFromDefinition (MySessionComponentDefinition definition)

virtual void	Init (MyObjectBuilder_SessionComponent sessionComponent)

virtual MyObjectBuilder_SessionComponent	GetObjectBuilder ()

void	AfterLoadData ()

void	UnloadDataConditional ()

virtual void	LoadData ()

virtual void	SaveData ()

virtual void	BeforeStart ()

virtual void	UpdateBeforeSimulation ()

virtual void	Simulate ()

virtual void	UpdateAfterSimulation ()

virtual void	UpdatingStopped ()

virtual void	Draw ()

virtual void	HandleInput ()

override string	ToString ()

Protected Member Functions
override void	UnloadData ()

Properties
static MyTerminalControls	Static `[get]`

CustomControlGetDelegate	CustomControlGetter

CustomActionGetDelegate	CustomActionGetter

Properties inherited from VRage.Game.Components.MySessionComponentBase
MyUpdateOrder	UpdateOrder `[get]`

MyObjectBuilderType	ObjectBuilderType `[get]`

bool	Loaded `[get]`

bool	Initialized `[get]`

MyDefinitionId	Definition `[get, set]`

virtual Type[]	Dependencies `[get]`

virtual bool	IsRequiredByGame `[get]`
	Indicates whether a session component should be used in current configuration. Example: MyDestructionData component returns true only when game uses Havok Destruction More...

Additional Inherited Members
Public Attributes inherited from VRage.Game.Components.MySessionComponentBase
readonly string	DebugName

readonly int	Priority

readonly Type	ComponentType

IMySession	Session

Events inherited from Sandbox.ModAPI.IMyTerminalControls
CustomControlGetDelegate	CustomControlGetter
	This event allows you to modify the list of controls that the game displays when a user selects a block. Each time terminal controls are enumerated for a block, this delegate is called, which allows you to modify the control list directly, and remove/add as you see fit before the controls are dispalyed. This is to allow fine grain control of the controls being displayed, so you can display only controls you want to in specific situations (like blocks with different subtypes, or even on specific blocks by entityId) More...

CustomActionGetDelegate	CustomActionGetter
	This event allows you to modify the list of actions available when a user wants to select an action for a block in the toolbar. Modifying the list in this event modifies the list displayed to the user so that you can customize it in specific situations (like blocks with different subtypes, or even on specific blocks by entityId) More...

Detailed Description

Definition at line 19 of file MyTerminalControls.cs.

Constructor & Destructor Documentation

Sandbox.Game.Gui.MyTerminalControls.MyTerminalControls ( )

inline

Definition at line 31 of file MyTerminalControls.cs.

Member Function Documentation

void Sandbox.Game.Gui.MyTerminalControls.AddAction< TBlock > ( IMyTerminalAction action )

inline

This allows you to add an action to an assocated block

Template Parameters

TBlock The ModAPI interface of the associated block

Parameters

action An IMyTerminalAction object returned from CreateAction

Implements Sandbox.ModAPI.IMyTerminalControls.

Definition at line 289 of file MyTerminalControls.cs.

void Sandbox.Game.Gui.MyTerminalControls.AddControl< TBlock > ( IMyTerminalControl item )

inline

Adds a terminal control to a block.

Template Parameters

TBlock This is the ModAPI interface of the associated block you want to add a terminal control to

Parameters

item	This is the control you're adding, created with CreateControl or CreateProperty

Implements Sandbox.ModAPI.IMyTerminalControls.

Definition at line 101 of file MyTerminalControls.cs.

IMyTerminalAction Sandbox.Game.Gui.MyTerminalControls.CreateAction< TBlock > ( string id )

inline

This allows you to create an action to associate with a block

Template Parameters

TBlock The ModAPI interface of the associated block

Parameters

id	A unique identifier for this action

Returns: An IMyTerminalAction object

Implements Sandbox.ModAPI.IMyTerminalControls.

Definition at line 315 of file MyTerminalControls.cs.

TControl Sandbox.Game.Gui.MyTerminalControls.CreateControl< TControl, TBlock > ( string id )

inline

This will create a control to be added to the terminal screen. This only really applies to ModAPI, as MyTerminalControlFactory class isn't whitelist

Template Parameters

TControl Interface of control type

Parameters

blockType	Block type to add this control to
id	Identifier of this control

Returns: Interface of created control

Implements Sandbox.ModAPI.IMyTerminalControls.

Definition at line 133 of file MyTerminalControls.cs.

IMyTerminalControlProperty<TValue> Sandbox.Game.Gui.MyTerminalControls.CreateProperty< TValue, TBlock > ( string id )

inline

This creates a property that can be added to a block. A property is not visible on the terminal screen but can hold a value that can be used in programmable blocks.

Template Parameters

TValue	The type of property you're creating
TBlock	The ModAPI interface of the associated block

Parameters

id	A unique identifier for this property

Returns: Returns an IMyTerminalControlProperty that can be added to a block via AddControl

Implements Sandbox.ModAPI.IMyTerminalControls.

Definition at line 186 of file MyTerminalControls.cs.

List<ITerminalAction> Sandbox.Game.Gui.MyTerminalControls.GetActions ( IMyTerminalBlock block )

inline

Definition at line 257 of file MyTerminalControls.cs.

void Sandbox.Game.Gui.MyTerminalControls.GetActions< TBlock > ( out List< IMyTerminalAction > items )

inline

This allows you to get all actions associated with this block.

Template Parameters

TBlock The ModAPI interface of the associated block

Parameters

items The list that contains the actions associated with this block

Implements Sandbox.ModAPI.IMyTerminalControls.

Definition at line 272 of file MyTerminalControls.cs.

List<ITerminalControl> Sandbox.Game.Gui.MyTerminalControls.GetControls ( IMyTerminalBlock block )

inline

Definition at line 69 of file MyTerminalControls.cs.

void Sandbox.Game.Gui.MyTerminalControls.GetControls< TBlock > ( out List< IMyTerminalControl > items )

inline

Gets the controls associated with a block.

Template Parameters

TBlock This is the object builder type of the associated block you want to get terminal controls for

Parameters

items The list that contains the terminal controls for this block

Implements Sandbox.ModAPI.IMyTerminalControls.

Definition at line 84 of file MyTerminalControls.cs.

void Sandbox.Game.Gui.MyTerminalControls.RemoveAction< TBlock > ( IMyTerminalAction action )

inline

This allows you to remove an action from a block

Template Parameters

TBlock The ModAPI interface of the associated block

Parameters

action An IMyTerminalAction object

Implements Sandbox.ModAPI.IMyTerminalControls.

Definition at line 302 of file MyTerminalControls.cs.

void Sandbox.Game.Gui.MyTerminalControls.RemoveControl< TBlock > ( IMyTerminalControl item )

inline

Removes a terminal control from a block.

Template Parameters

TBlock This is the ModAPI interface of the associated block you want to remove a terminal control from

Parameters

item	This is the control you're removing. Use GetControls to get the item itself.

Implements Sandbox.ModAPI.IMyTerminalControls.

Definition at line 114 of file MyTerminalControls.cs.

override void Sandbox.Game.Gui.MyTerminalControls.UnloadData ( )

inlineprotectedvirtual

Reimplemented from VRage.Game.Components.MySessionComponentBase.

Definition at line 36 of file MyTerminalControls.cs.

Property Documentation

CustomActionGetDelegate Sandbox.Game.Gui.MyTerminalControls.CustomActionGetter

addremove

Definition at line 57 of file MyTerminalControls.cs.

CustomControlGetDelegate Sandbox.Game.Gui.MyTerminalControls.CustomControlGetter

addremove

Definition at line 43 of file MyTerminalControls.cs.

MyTerminalControls Sandbox.Game.Gui.MyTerminalControls.Static

staticget

Definition at line 24 of file MyTerminalControls.cs.

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

Sources/Sandbox.Game/Game/Screens/Terminal/Controls/MyTerminalControls.cs

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation