Space Engineers
Public Member Functions | Static Public Member Functions | Properties | List of all members
Sandbox.Game.Screens.Helpers.MyToolbarItemTerminalGroup Class Reference
Inheritance diagram for Sandbox.Game.Screens.Helpers.MyToolbarItemTerminalGroup:
Sandbox.Game.Screens.Helpers.MyToolbarItemActions Sandbox.Game.Screens.Helpers.IMyToolbarItemEntity Sandbox.Game.Screens.Helpers.MyToolbarItem

Public Member Functions

override ListReader< ITerminalActionPossibleActions (MyToolbarType toolbarType)
 
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 objBuilder)
 
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 OnRemovedFromToolbar (MyToolbar toolbar)
 
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 ()
 

Static Public Member Functions

static Type FindBaseClass (Type[] types, Type baseKnownCommonType)
 Searching for common base class. Used to return more specific group actions than only basic actions of functional blocks (if the blocks are of common origin) More...
 

Properties

override ListReader< ITerminalActionAllActions [get]
 
- Properties inherited from Sandbox.Game.Screens.Helpers.MyToolbarItemActions
bool ActionChanged [get, set]
 
string ActionId [get, set]
 
abstract ListReader< ITerminalActionAllActions [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 MyToolbarItemTerminalGroup.cs.

Member Function Documentation

override bool Sandbox.Game.Screens.Helpers.MyToolbarItemTerminalGroup.Activate ( )
inlinevirtual
override bool Sandbox.Game.Screens.Helpers.MyToolbarItemTerminalGroup.AllowedInToolbarType ( MyToolbarType  type)
inlinevirtual
bool Sandbox.Game.Screens.Helpers.MyToolbarItemTerminalGroup.CompareEntityIds ( long  entityId)
inline

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

Parameters
entityIdAn 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 251 of file MyToolbarItemTerminalGroup.cs.

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

Definition at line 256 of file MyToolbarItemTerminalGroup.cs.

static Type Sandbox.Game.Screens.Helpers.MyToolbarItemTerminalGroup.FindBaseClass ( Type[]  types,
Type  baseKnownCommonType 
)
inlinestatic

Searching for common base class. Used to return more specific group actions than only basic actions of functional blocks (if the blocks are of common origin)

Parameters
types
baseKnownCommonType
Returns

Definition at line 89 of file MyToolbarItemTerminalGroup.cs.

override int Sandbox.Game.Screens.Helpers.MyToolbarItemTerminalGroup.GetHashCode ( )
inline

Definition at line 265 of file MyToolbarItemTerminalGroup.cs.

override MyObjectBuilder_ToolbarItem Sandbox.Game.Screens.Helpers.MyToolbarItemTerminalGroup.GetObjectBuilder ( )
inlinevirtual
override bool Sandbox.Game.Screens.Helpers.MyToolbarItemTerminalGroup.Init ( MyObjectBuilder_ToolbarItem  objBuilder)
inlinevirtual
override ListReader<ITerminalAction> Sandbox.Game.Screens.Helpers.MyToolbarItemTerminalGroup.PossibleActions ( MyToolbarType  toolbarType)
inlinevirtual
override ChangeInfo Sandbox.Game.Screens.Helpers.MyToolbarItemTerminalGroup.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 210 of file MyToolbarItemTerminalGroup.cs.

Property Documentation

override ListReader<ITerminalAction> Sandbox.Game.Screens.Helpers.MyToolbarItemTerminalGroup.AllActions
get

Definition at line 164 of file MyToolbarItemTerminalGroup.cs.


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