Space Engineers
Public Types | Public Member Functions | Properties | List of all members
Sandbox.Game.Screens.Helpers.MyToolbarItem Class Referenceabstract
Inheritance diagram for Sandbox.Game.Screens.Helpers.MyToolbarItem:
Sandbox.Game.Screens.Helpers.MyToolbarItemActions Sandbox.Game.Screens.Helpers.MyToolbarItemDefinition Sandbox.Game.Screens.Helpers.MyToolbarItemEmpty Sandbox.Game.Screens.Helpers.MyToolbarItemTerminalBlock Sandbox.Game.Screens.Helpers.MyToolbarItemTerminalGroup Sandbox.Game.Screens.Helpers.MyToolbarItemAiCommand Sandbox.Game.Screens.Helpers.MyToolbarItemAnimation Sandbox.Game.Screens.Helpers.MyToolbarItemAreaMarker Sandbox.Game.Screens.Helpers.MyToolbarItemBot Sandbox.Game.Screens.Helpers.MyToolbarItemConsumable Sandbox.Game.Screens.Helpers.MyToolbarItemCreateGrid Sandbox.Game.Screens.Helpers.MyToolbarItemCubeBlock Sandbox.Game.Screens.Helpers.MyToolbarItemPrefabThrower Sandbox.Game.Screens.Helpers.MyToolbarItemUsable Sandbox.Game.Screens.Helpers.MyToolbarItemVoxelHand Sandbox.Game.Screens.Helpers.MyToolbarItemWeapon

Public Types

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

Public Member Functions

 MyToolbarItem ()
 
virtual void OnRemovedFromToolbar (MyToolbar toolbar)
 
virtual void OnAddedToToolbar (MyToolbar toolbar)
 
abstract bool Activate ()
 
abstract bool Init (MyObjectBuilder_ToolbarItem data)
 
abstract MyObjectBuilder_ToolbarItem GetObjectBuilder ()
 
abstract bool AllowedInToolbarType (MyToolbarType type)
 
abstract ChangeInfo Update (MyEntity owner, long playerID=0)
 Return value should contain information about the stuff that changed during the update More...
 
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

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]
 

Detailed Description

Definition at line 10 of file MyToolbarItem.cs.

Member Enumeration Documentation

Tells which data of MyToolbarItem changed during an update

Enumerator
None 
Enabled 
Icon 
SubIcon 
IconText 
DisplayName 
All 

Definition at line 16 of file MyToolbarItem.cs.

Constructor & Destructor Documentation

Sandbox.Game.Screens.Helpers.MyToolbarItem.MyToolbarItem ( )
inline

Definition at line 38 of file MyToolbarItem.cs.

Member Function Documentation

abstract bool Sandbox.Game.Screens.Helpers.MyToolbarItem.Activate ( )
pure virtual
abstract bool Sandbox.Game.Screens.Helpers.MyToolbarItem.AllowedInToolbarType ( MyToolbarType  type)
pure virtual
ChangeInfo Sandbox.Game.Screens.Helpers.MyToolbarItem.ClearIconText ( )
inline

Definition at line 89 of file MyToolbarItem.cs.

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

Definition at line 114 of file MyToolbarItem.cs.

virtual void Sandbox.Game.Screens.Helpers.MyToolbarItem.FillGridItem ( MyGuiControlGrid.Item  gridItem)
inlinevirtual
override int Sandbox.Game.Screens.Helpers.MyToolbarItem.GetHashCode ( )
inline

Definition at line 119 of file MyToolbarItem.cs.

abstract MyObjectBuilder_ToolbarItem Sandbox.Game.Screens.Helpers.MyToolbarItem.GetObjectBuilder ( )
pure virtual
abstract bool Sandbox.Game.Screens.Helpers.MyToolbarItem.Init ( MyObjectBuilder_ToolbarItem  data)
pure virtual
virtual void Sandbox.Game.Screens.Helpers.MyToolbarItem.OnAddedToToolbar ( MyToolbar  toolbar)
inlinevirtual

Definition at line 46 of file MyToolbarItem.cs.

virtual void Sandbox.Game.Screens.Helpers.MyToolbarItem.OnRemovedFromToolbar ( MyToolbar  toolbar)
inlinevirtual

Reimplemented in Sandbox.Game.Screens.Helpers.MyToolbarItemTerminalBlock.

Definition at line 45 of file MyToolbarItem.cs.

ChangeInfo Sandbox.Game.Screens.Helpers.MyToolbarItem.SetDisplayName ( String  newDisplayName)
inline

Definition at line 96 of file MyToolbarItem.cs.

ChangeInfo Sandbox.Game.Screens.Helpers.MyToolbarItem.SetEnabled ( bool  newEnabled)
inline

Definition at line 59 of file MyToolbarItem.cs.

ChangeInfo Sandbox.Game.Screens.Helpers.MyToolbarItem.SetIcons ( string[]  newIcons)
inline

Definition at line 66 of file MyToolbarItem.cs.

ChangeInfo Sandbox.Game.Screens.Helpers.MyToolbarItem.SetIconText ( StringBuilder  newIconText)
inline

Definition at line 80 of file MyToolbarItem.cs.

ChangeInfo Sandbox.Game.Screens.Helpers.MyToolbarItem.SetSubIcon ( string  newSubIcon)
inline

Definition at line 73 of file MyToolbarItem.cs.

abstract ChangeInfo Sandbox.Game.Screens.Helpers.MyToolbarItem.Update ( MyEntity  owner,
long  playerID = 0 
)
pure virtual

Property Documentation

bool Sandbox.Game.Screens.Helpers.MyToolbarItem.ActivateOnClick
getprotected set

Definition at line 36 of file MyToolbarItem.cs.

StringBuilder Sandbox.Game.Screens.Helpers.MyToolbarItem.DisplayName
get

Definition at line 31 of file MyToolbarItem.cs.

bool Sandbox.Game.Screens.Helpers.MyToolbarItem.Enabled
get

Definition at line 27 of file MyToolbarItem.cs.

string [] Sandbox.Game.Screens.Helpers.MyToolbarItem.Icons
get

Definition at line 28 of file MyToolbarItem.cs.

StringBuilder Sandbox.Game.Screens.Helpers.MyToolbarItem.IconText
get

Definition at line 30 of file MyToolbarItem.cs.

string Sandbox.Game.Screens.Helpers.MyToolbarItem.SubIcon
get

Definition at line 29 of file MyToolbarItem.cs.

bool Sandbox.Game.Screens.Helpers.MyToolbarItem.WantsToBeActivated
getprotected set

Definition at line 34 of file MyToolbarItem.cs.

bool Sandbox.Game.Screens.Helpers.MyToolbarItem.WantsToBeSelected
getprotected set

Definition at line 35 of file MyToolbarItem.cs.


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