Sandbox.Game.Screens.Helpers.MyToolbarItemTerminalBlock Class Reference

Inheritance diagram for Sandbox.Game.Screens.Helpers.MyToolbarItemTerminalBlock:

Public Member Functions
override ListReader< ITerminalAction >	PossibleActions (MyToolbarType type)
override bool	Activate ()
override bool	AllowedInToolbarType (MyToolbarType type)
override ChangeInfo	Update (MyEntity owner, long playerID=0)
	Return value should contain information about the stuff that changed during the update More...
bool	CompareEntityIds (long id)
	Returns true if the toolbar item is referring to the specified entity id. More...
override bool	Equals (object obj)
override int	GetHashCode ()
override bool	Init (MyObjectBuilder_ToolbarItem objectBuilder)
override void	OnRemovedFromToolbar (MyToolbar toolbar)
override MyObjectBuilder_ToolbarItem	GetObjectBuilder ()
Public Member Functions inherited from Sandbox.Game.Screens.Helpers.MyToolbarItemActions
ITerminalAction	GetCurrentAction ()
ITerminalAction	GetActionOrNull (string id)
Public Member Functions inherited from Sandbox.Game.Screens.Helpers.MyToolbarItem
	MyToolbarItem ()
virtual void	OnAddedToToolbar (MyToolbar toolbar)
ChangeInfo	SetEnabled (bool newEnabled)
ChangeInfo	SetIcons (string[] newIcons)
ChangeInfo	SetSubIcon (string newSubIcon)
ChangeInfo	SetIconText (StringBuilder newIconText)
ChangeInfo	ClearIconText ()
ChangeInfo	SetDisplayName (String newDisplayName)
virtual void	FillGridItem (MyGuiControlGrid.Item gridItem)
override bool	Equals (object obj)
override int	GetHashCode ()

Properties
override ListReader< ITerminalAction >	AllActions [get]
List< TerminalActionParameter >	Parameters [get]
Properties inherited from Sandbox.Game.Screens.Helpers.MyToolbarItemActions
bool	ActionChanged [get, set]
string	ActionId [get, set]
abstract ListReader< ITerminalAction >	AllActions [get]
Properties inherited from Sandbox.Game.Screens.Helpers.MyToolbarItem
bool	Enabled [get]
string[]	Icons [get]
string	SubIcon [get]
StringBuilder	IconText [get]
StringBuilder	DisplayName [get]
bool	WantsToBeActivated [get, protected set]
bool	WantsToBeSelected [get, protected set]
bool	ActivateOnClick [get, protected set]

Additional Inherited Members
Public Types inherited from Sandbox.Game.Screens.Helpers.MyToolbarItem
enum	ChangeInfo {   ChangeInfo.None = 0x0, ChangeInfo.Enabled = 1 << 0, ChangeInfo.Icon = 1 << 1, ChangeInfo.SubIcon = 1 << 2,   ChangeInfo.IconText = 1 << 3, ChangeInfo.DisplayName = 1 << 4, ChangeInfo.All = Enabled | Icon | SubIcon | IconText | DisplayName }
	Tells which data of MyToolbarItem changed during an update More...
Protected Member Functions inherited from Sandbox.Game.Screens.Helpers.MyToolbarItemActions
void	SetAction (string action)

Detailed Description

Definition at line 21 of file MyToolbarItemTerminalBlock.cs.

Member Function Documentation

override bool Sandbox.Game.Screens.Helpers.MyToolbarItemTerminalBlock.Activate ( )

inlinevirtual

Implements Sandbox.Game.Screens.Helpers.MyToolbarItem.

Definition at line 81 of file MyToolbarItemTerminalBlock.cs.

override bool Sandbox.Game.Screens.Helpers.MyToolbarItemTerminalBlock.AllowedInToolbarType ( MyToolbarType  type )

inlinevirtual

Implements Sandbox.Game.Screens.Helpers.MyToolbarItem.

Definition at line 93 of file MyToolbarItemTerminalBlock.cs.

bool Sandbox.Game.Screens.Helpers.MyToolbarItemTerminalBlock.CompareEntityIds ( long  entityId )

inline

Returns true if the toolbar item is referring to the specified entity id.

Parameters

entityId

An entity id to compare this toolbar item with.

Returns

True if the toolbar item refers to the specified entity id, false otherwise.

Implements Sandbox.Game.Screens.Helpers.IMyToolbarItemEntity.

Definition at line 155 of file MyToolbarItemTerminalBlock.cs.

override bool Sandbox.Game.Screens.Helpers.MyToolbarItemTerminalBlock.Equals ( object  obj )

inline

Definition at line 160 of file MyToolbarItemTerminalBlock.cs.

override int Sandbox.Game.Screens.Helpers.MyToolbarItemTerminalBlock.GetHashCode ( )

inline

Definition at line 184 of file MyToolbarItemTerminalBlock.cs.

override MyObjectBuilder_ToolbarItem Sandbox.Game.Screens.Helpers.MyToolbarItemTerminalBlock.GetObjectBuilder ( )

inlinevirtual

Implements Sandbox.Game.Screens.Helpers.MyToolbarItem.

Definition at line 257 of file MyToolbarItemTerminalBlock.cs.

override bool Sandbox.Game.Screens.Helpers.MyToolbarItemTerminalBlock.Init ( MyObjectBuilder_ToolbarItem  objectBuilder )

inlinevirtual

Implements Sandbox.Game.Screens.Helpers.MyToolbarItem.

Definition at line 194 of file MyToolbarItemTerminalBlock.cs.

override void Sandbox.Game.Screens.Helpers.MyToolbarItemTerminalBlock.OnRemovedFromToolbar ( MyToolbar  toolbar )

inlinevirtual

Reimplemented from Sandbox.Game.Screens.Helpers.MyToolbarItem.

Definition at line 250 of file MyToolbarItemTerminalBlock.cs.

override ListReader<ITerminalAction> Sandbox.Game.Screens.Helpers.MyToolbarItemTerminalBlock.PossibleActions ( MyToolbarType  type )

inlinevirtual

Implements Sandbox.Game.Screens.Helpers.MyToolbarItemActions.

Definition at line 57 of file MyToolbarItemTerminalBlock.cs.

override ChangeInfo Sandbox.Game.Screens.Helpers.MyToolbarItemTerminalBlock.Update ( MyEntity  owner, long  playerID = 0  )

inlinevirtual

Return value should contain information about the stuff that changed during the update

Reimplemented from Sandbox.Game.Screens.Helpers.MyToolbarItemActions.

Definition at line 98 of file MyToolbarItemTerminalBlock.cs.

Property Documentation

override ListReader<ITerminalAction> Sandbox.Game.Screens.Helpers.MyToolbarItemTerminalBlock.AllActions

get

Definition at line 45 of file MyToolbarItemTerminalBlock.cs.

List<TerminalActionParameter> Sandbox.Game.Screens.Helpers.MyToolbarItemTerminalBlock.Parameters

get

Definition at line 53 of file MyToolbarItemTerminalBlock.cs.

---

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

• Sources/Sandbox.Game/Game/Screens/Helpers/MyToolbarItemTerminalBlock.cs