Space Engineers
Classes | Public Member Functions | Public Attributes | Properties | Events | List of all members
Sandbox.Game.Screens.Helpers.MyToolbar Class Reference

Classes

interface  IMyToolbarExtension
 
struct  IndexArgs
 
struct  PageChangeArgs
 
struct  SlotArgs
 

Public Member Functions

int SlotToIndex (int i)
 
int IndexToSlot (int i)
 
MyToolbarItem GetSlotItem (int slot)
 
MyToolbarItem GetItemAtIndex (int index)
 
MyToolbarItem GetItemAtSlot (int slot)
 
int GetItemIndex (MyToolbarItem item)
 
 MyToolbar (MyToolbarType type, int slotCount=DEF_SLOT_COUNT, int pageCount=DEF_PAGE_COUNT)
 
void Init (MyObjectBuilder_Toolbar builder, MyEntity owner, bool skipAssert=false)
 
MyObjectBuilder_Toolbar GetObjectBuilder ()
 
void PageUp ()
 
void PageDown ()
 
void SwitchToPage (int page)
 
void SetItemAtIndex (int i, MyDefinitionId defId, MyObjectBuilder_ToolbarItem data)
 
void SetItemAtSlot (int slot, MyToolbarItem item)
 
void SetItemAtIndex (int i, MyToolbarItem item)
 
void AddExtension (IMyToolbarExtension newExtension)
 
bool TryGetExtension< T > (out T extension)
 
void RemoveExtension (IMyToolbarExtension toRemove)
 
void CharacterInventory_OnContentsChanged (MyInventoryBase inventory)
 
void SetDefaults (bool sendEvent=true)
 
void Clear ()
 
void ActivateItemAtSlot (int slot, bool checkIfWantsToBeActivated=false, bool playActivationSound=true)
 
void SelectNextSlot ()
 
void SelectPreviousSlot ()
 
int GetNextValidSlot (int startSlot)
 
int GetPreviousValidSlot (int startSlot)
 
void ActivateStagedSelectedItem ()
 
bool ActivateItemAtIndex (int index, bool checkIfWantsToBeActivated=false)
 
void Unselect (bool unselectSound=true)
 
bool IsValidIndex (int idx)
 
bool IsValidSlot (int slot)
 
bool IsEnabled (int idx)
 
string[] GetItemIcons (int idx)
 
long GetControllerPlayerID ()
 
void Update ()
 
void UpdateItem (int index)
 
void SetItemAtSerializedCompat (int i, MyDefinitionId defId)
 

Public Attributes

const int DEF_SLOT_COUNT = 9
 
const int DEF_PAGE_COUNT = 9
 
int SlotCount
 
int PageCount
 
bool DrawNumbers = true
 
Func< int, Sandbox.Graphics.GUI.MyGuiControlGrid.ColoredIconGetSymbol = (x) => new Sandbox.Graphics.GUI.MyGuiControlGrid.ColoredIcon()
 

Properties

int ItemCount [get]
 
MyToolbarType ToolbarType [get]
 
MyEntity Owner [get]
 
bool ShowHolsterSlot [get]
 
int SelectedSlot [get]
 
int StagedSelectedSlot [get]
 
bool ShouldActivateSlot [get]
 
int CurrentPage [get]
 
MyToolbarItem SelectedItem [get]
 
MyToolbarItem this[int i] [get]
 
bool EnabledOverride [get]
 Override value for Enabled state of items. null means that per item state is reported, otherwise this value is reported. More...
 

Events

Action< MyToolbar, IndexArgsItemChanged
 
Action< MyToolbar, IndexArgs, MyToolbarItem.ChangeInfoItemUpdated
 
Action< MyToolbar, SlotArgsSelectedSlotChanged
 
Action< MyToolbar, SlotArgsSlotActivated
 
Action< MyToolbar, SlotArgsItemEnabledChanged
 
Action< MyToolbar, PageChangeArgsCurrentPageChanged
 
Action< MyToolbarUnselected
 

Detailed Description

Definition at line 22 of file MyToolbar.cs.

Constructor & Destructor Documentation

Sandbox.Game.Screens.Helpers.MyToolbar.MyToolbar ( MyToolbarType  type,
int  slotCount = DEF_SLOT_COUNT,
int  pageCount = DEF_PAGE_COUNT 
)
inline

Definition at line 221 of file MyToolbar.cs.

Member Function Documentation

bool Sandbox.Game.Screens.Helpers.MyToolbar.ActivateItemAtIndex ( int  index,
bool  checkIfWantsToBeActivated = false 
)
inline

Definition at line 608 of file MyToolbar.cs.

void Sandbox.Game.Screens.Helpers.MyToolbar.ActivateItemAtSlot ( int  slot,
bool  checkIfWantsToBeActivated = false,
bool  playActivationSound = true 
)
inline

Definition at line 520 of file MyToolbar.cs.

void Sandbox.Game.Screens.Helpers.MyToolbar.ActivateStagedSelectedItem ( )
inline

Definition at line 603 of file MyToolbar.cs.

void Sandbox.Game.Screens.Helpers.MyToolbar.AddExtension ( IMyToolbarExtension  newExtension)
inline

Definition at line 381 of file MyToolbar.cs.

void Sandbox.Game.Screens.Helpers.MyToolbar.CharacterInventory_OnContentsChanged ( MyInventoryBase  inventory)
inline

Definition at line 447 of file MyToolbar.cs.

void Sandbox.Game.Screens.Helpers.MyToolbar.Clear ( )
inline

Definition at line 514 of file MyToolbar.cs.

long Sandbox.Game.Screens.Helpers.MyToolbar.GetControllerPlayerID ( )
inline

Definition at line 686 of file MyToolbar.cs.

MyToolbarItem Sandbox.Game.Screens.Helpers.MyToolbar.GetItemAtIndex ( int  index)
inline

Definition at line 155 of file MyToolbar.cs.

MyToolbarItem Sandbox.Game.Screens.Helpers.MyToolbar.GetItemAtSlot ( int  slot)
inline

Definition at line 163 of file MyToolbar.cs.

string [] Sandbox.Game.Screens.Helpers.MyToolbar.GetItemIcons ( int  idx)
inline

Definition at line 675 of file MyToolbar.cs.

int Sandbox.Game.Screens.Helpers.MyToolbar.GetItemIndex ( MyToolbarItem  item)
inline

Definition at line 175 of file MyToolbar.cs.

int Sandbox.Game.Screens.Helpers.MyToolbar.GetNextValidSlot ( int  startSlot)
inline

Definition at line 585 of file MyToolbar.cs.

MyObjectBuilder_Toolbar Sandbox.Game.Screens.Helpers.MyToolbar.GetObjectBuilder ( )
inline

Definition at line 255 of file MyToolbar.cs.

int Sandbox.Game.Screens.Helpers.MyToolbar.GetPreviousValidSlot ( int  startSlot)
inline

Definition at line 594 of file MyToolbar.cs.

MyToolbarItem Sandbox.Game.Screens.Helpers.MyToolbar.GetSlotItem ( int  slot)
inline

Definition at line 146 of file MyToolbar.cs.

int Sandbox.Game.Screens.Helpers.MyToolbar.IndexToSlot ( int  i)
inline

Definition at line 122 of file MyToolbar.cs.

void Sandbox.Game.Screens.Helpers.MyToolbar.Init ( MyObjectBuilder_Toolbar  builder,
MyEntity  owner,
bool  skipAssert = false 
)
inline

Definition at line 232 of file MyToolbar.cs.

bool Sandbox.Game.Screens.Helpers.MyToolbar.IsEnabled ( int  idx)
inline

Definition at line 658 of file MyToolbar.cs.

bool Sandbox.Game.Screens.Helpers.MyToolbar.IsValidIndex ( int  idx)
inline

Definition at line 648 of file MyToolbar.cs.

bool Sandbox.Game.Screens.Helpers.MyToolbar.IsValidSlot ( int  slot)
inline

Definition at line 653 of file MyToolbar.cs.

void Sandbox.Game.Screens.Helpers.MyToolbar.PageDown ( )
inline

Definition at line 297 of file MyToolbar.cs.

void Sandbox.Game.Screens.Helpers.MyToolbar.PageUp ( )
inline

Definition at line 287 of file MyToolbar.cs.

void Sandbox.Game.Screens.Helpers.MyToolbar.RemoveExtension ( IMyToolbarExtension  toRemove)
inline

Definition at line 406 of file MyToolbar.cs.

void Sandbox.Game.Screens.Helpers.MyToolbar.SelectNextSlot ( )
inline

Definition at line 541 of file MyToolbar.cs.

void Sandbox.Game.Screens.Helpers.MyToolbar.SelectPreviousSlot ( )
inline

Definition at line 563 of file MyToolbar.cs.

void Sandbox.Game.Screens.Helpers.MyToolbar.SetDefaults ( bool  sendEvent = true)
inline

Definition at line 486 of file MyToolbar.cs.

void Sandbox.Game.Screens.Helpers.MyToolbar.SetItemAtIndex ( int  i,
MyDefinitionId  defId,
MyObjectBuilder_ToolbarItem  data 
)
inline

Definition at line 318 of file MyToolbar.cs.

void Sandbox.Game.Screens.Helpers.MyToolbar.SetItemAtIndex ( int  i,
MyToolbarItem  item 
)
inline

Definition at line 333 of file MyToolbar.cs.

void Sandbox.Game.Screens.Helpers.MyToolbar.SetItemAtSerializedCompat ( int  i,
MyDefinitionId  defId 
)
inline

Definition at line 813 of file MyToolbar.cs.

void Sandbox.Game.Screens.Helpers.MyToolbar.SetItemAtSlot ( int  slot,
MyToolbarItem  item 
)
inline

Definition at line 328 of file MyToolbar.cs.

int Sandbox.Game.Screens.Helpers.MyToolbar.SlotToIndex ( int  i)
inline

Definition at line 116 of file MyToolbar.cs.

void Sandbox.Game.Screens.Helpers.MyToolbar.SwitchToPage ( int  page)
inline

Definition at line 307 of file MyToolbar.cs.

bool Sandbox.Game.Screens.Helpers.MyToolbar.TryGetExtension< T > ( out T  extension)
inline
Type Constraints
T :class 
T :IMyToolbarExtension 

Definition at line 392 of file MyToolbar.cs.

void Sandbox.Game.Screens.Helpers.MyToolbar.Unselect ( bool  unselectSound = true)
inline

Definition at line 630 of file MyToolbar.cs.

void Sandbox.Game.Screens.Helpers.MyToolbar.Update ( )
inline

Definition at line 700 of file MyToolbar.cs.

void Sandbox.Game.Screens.Helpers.MyToolbar.UpdateItem ( int  index)
inline

Definition at line 773 of file MyToolbar.cs.

Member Data Documentation

const int Sandbox.Game.Screens.Helpers.MyToolbar.DEF_PAGE_COUNT = 9

Definition at line 46 of file MyToolbar.cs.

const int Sandbox.Game.Screens.Helpers.MyToolbar.DEF_SLOT_COUNT = 9

Definition at line 45 of file MyToolbar.cs.

bool Sandbox.Game.Screens.Helpers.MyToolbar.DrawNumbers = true

Definition at line 110 of file MyToolbar.cs.

Func<int, Sandbox.Graphics.GUI.MyGuiControlGrid.ColoredIcon> Sandbox.Game.Screens.Helpers.MyToolbar.GetSymbol = (x) => new Sandbox.Graphics.GUI.MyGuiControlGrid.ColoredIcon()

Definition at line 112 of file MyToolbar.cs.

int Sandbox.Game.Screens.Helpers.MyToolbar.PageCount

Definition at line 49 of file MyToolbar.cs.

int Sandbox.Game.Screens.Helpers.MyToolbar.SlotCount

Definition at line 48 of file MyToolbar.cs.

Property Documentation

int Sandbox.Game.Screens.Helpers.MyToolbar.CurrentPage
get

Definition at line 114 of file MyToolbar.cs.

bool Sandbox.Game.Screens.Helpers.MyToolbar.EnabledOverride
get

Override value for Enabled state of items. null means that per item state is reported, otherwise this value is reported.

Definition at line 191 of file MyToolbar.cs.

int Sandbox.Game.Screens.Helpers.MyToolbar.ItemCount
get

Definition at line 50 of file MyToolbar.cs.

MyEntity Sandbox.Game.Screens.Helpers.MyToolbar.Owner
get

Definition at line 65 of file MyToolbar.cs.

MyToolbarItem Sandbox.Game.Screens.Helpers.MyToolbar.SelectedItem
get

Definition at line 130 of file MyToolbar.cs.

int Sandbox.Game.Screens.Helpers.MyToolbar.SelectedSlot
get

Definition at line 84 of file MyToolbar.cs.

bool Sandbox.Game.Screens.Helpers.MyToolbar.ShouldActivateSlot
get

Definition at line 106 of file MyToolbar.cs.

bool Sandbox.Game.Screens.Helpers.MyToolbar.ShowHolsterSlot
get

Definition at line 79 of file MyToolbar.cs.

int Sandbox.Game.Screens.Helpers.MyToolbar.StagedSelectedSlot
get

Definition at line 96 of file MyToolbar.cs.

MyToolbarItem Sandbox.Game.Screens.Helpers.MyToolbar.this[int i]
get

Definition at line 139 of file MyToolbar.cs.

MyToolbarType Sandbox.Game.Screens.Helpers.MyToolbar.ToolbarType
get

Definition at line 58 of file MyToolbar.cs.

Event Documentation

Action<MyToolbar, PageChangeArgs> Sandbox.Game.Screens.Helpers.MyToolbar.CurrentPageChanged

Definition at line 214 of file MyToolbar.cs.

Action<MyToolbar, IndexArgs> Sandbox.Game.Screens.Helpers.MyToolbar.ItemChanged

Definition at line 209 of file MyToolbar.cs.

Action<MyToolbar, SlotArgs> Sandbox.Game.Screens.Helpers.MyToolbar.ItemEnabledChanged

Definition at line 213 of file MyToolbar.cs.

Action<MyToolbar, IndexArgs, MyToolbarItem.ChangeInfo> Sandbox.Game.Screens.Helpers.MyToolbar.ItemUpdated

Definition at line 210 of file MyToolbar.cs.

Action<MyToolbar, SlotArgs> Sandbox.Game.Screens.Helpers.MyToolbar.SelectedSlotChanged

Definition at line 211 of file MyToolbar.cs.

Action<MyToolbar, SlotArgs> Sandbox.Game.Screens.Helpers.MyToolbar.SlotActivated

Definition at line 212 of file MyToolbar.cs.

Action<MyToolbar> Sandbox.Game.Screens.Helpers.MyToolbar.Unselected

Definition at line 215 of file MyToolbar.cs.


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