Kerbal Space Program  1.12.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Public Attributes | Properties | List of all members
KSP.UI.Screens.EditorActionOverrideGroup Class Reference

header for each override group. looks after display and edit of the name, as well as group collapse button. More...

Inheritance diagram for KSP.UI.Screens.EditorActionOverrideGroup:
KSP.UI.UISelectableGridLayoutGroupItem

Public Member Functions

void CloseGroup ()
 Put the related objects into the correct state when collapsing the group More...
 
override void Deselect ()
 Ensure related objects are in the correct state when the group is deselected More...
 
void OnPointerClick (PointerEventData eventData)
 For IPointerClickHandler More...
 
void OnSubmit (BaseEventData eventData)
 The submit action checks first if the header is already highlighted by checking the status of the edit button, if it's turned on then the toggle would make the group to collapsed, if not it opens and selects as current. More...
 
override void Select ()
 Ensure related objects are in the correct state when the group is selected More...
 
void Setup (int groupOverride, string[]groupNames, bool isOpen)
 Set up the header with the group index, array of group names (which groupOverride indexes) and the expanded/collapsed state of the group More...
 
- Public Member Functions inherited from KSP.UI.UISelectableGridLayoutGroupItem
virtual void Setup (UISelectableGridLayoutGroup selectableGroup, int index)
 

Public Attributes

UIButtonToggle closeButton
 Button for collapsing the group More...
 
Button editButton
 Button for entering group name edit mode More...
 
TMPro.TMP_InputField inputField
 Input field for editing the group name More...
 
MenuNavigation menuNavigation
 The menu navigation reference under this class. More...
 
TMPro.TextMeshProUGUI text
 Title of the group More...
 
- Public Attributes inherited from KSP.UI.UISelectableGridLayoutGroupItem
Color colorDeselected = Color.gray
 
Color colorSelected = Color.green
 
bool groupAction
 Is this a group action item? More...
 
Transform itemParent
 Parent reference if this class is not at the top of the rpefab or item hierarchy. More...
 
int mySetIndex
 The index of the set this item belongs to. More...
 

Properties

int groupOverride [get, set]
 Which group this header manages More...
 
- Properties inherited from KSP.UI.UISelectableGridLayoutGroupItem
int Index [get]
 
Selectable SelectableComponent [get]
 Fetch the selectable READ ONLY More...
 

Detailed Description

header for each override group. looks after display and edit of the name, as well as group collapse button.

Member Function Documentation

void KSP.UI.Screens.EditorActionOverrideGroup.CloseGroup ( )
inline

Put the related objects into the correct state when collapsing the group

override void KSP.UI.Screens.EditorActionOverrideGroup.Deselect ( )
inlinevirtual

Ensure related objects are in the correct state when the group is deselected

Reimplemented from KSP.UI.UISelectableGridLayoutGroupItem.

void KSP.UI.Screens.EditorActionOverrideGroup.OnPointerClick ( PointerEventData  eventData)
inline

For IPointerClickHandler

void KSP.UI.Screens.EditorActionOverrideGroup.OnSubmit ( BaseEventData  eventData)
inline

The submit action checks first if the header is already highlighted by checking the status of the edit button, if it's turned on then the toggle would make the group to collapsed, if not it opens and selects as current.

Parameters
eventData
override void KSP.UI.Screens.EditorActionOverrideGroup.Select ( )
inlinevirtual

Ensure related objects are in the correct state when the group is selected

Reimplemented from KSP.UI.UISelectableGridLayoutGroupItem.

void KSP.UI.Screens.EditorActionOverrideGroup.Setup ( int  groupOverride,
string[]  groupNames,
bool  isOpen 
)
inline

Set up the header with the group index, array of group names (which groupOverride indexes) and the expanded/collapsed state of the group

Note that groupNames does NOT include the default group (index 0) so is effectively 1-based. Use the groupName property to access

Member Data Documentation

UIButtonToggle KSP.UI.Screens.EditorActionOverrideGroup.closeButton

Button for collapsing the group

Button KSP.UI.Screens.EditorActionOverrideGroup.editButton

Button for entering group name edit mode

TMPro.TMP_InputField KSP.UI.Screens.EditorActionOverrideGroup.inputField

Input field for editing the group name

MenuNavigation KSP.UI.Screens.EditorActionOverrideGroup.menuNavigation

The menu navigation reference under this class.

TMPro.TextMeshProUGUI KSP.UI.Screens.EditorActionOverrideGroup.text

Title of the group

Property Documentation

int KSP.UI.Screens.EditorActionOverrideGroup.groupOverride
getset

Which group this header manages


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