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

Public Member Functions

void AddIcon (StageIcon icon, bool setParent=true)
 
void AddIconAt (StageIcon icon, int index, int forcedSiblingIndex, bool setParent=true)
 
void AddIcons (StageIcon[] iconsToAdd)
 
void AddStageAfter ()
 for the gui + button More...
 
void DisableDeltaVHeading ()
 Disable the Delta-v Heading in the stage group More...
 
void DisableInfoPanel ()
 Disable the Info Panel in the stage group More...
 
void DisableStockInfoPanelDisplays ()
 Disable the Stock standardized info line displays More...
 
void EnableDeltaVHeading ()
 Enable the Delta-v Heading in the stage group More...
 
void EnableDeltaVHeading (bool enable)
 Set the Enabled state of the Delta-v Heading in the stage group More...
 
void EnableInfoPanel ()
 Enable the Info Panel in the stage group More...
 
void EnableInfoPanel (bool enable)
 Set the Enabled state of the Info Panel in the stage group More...
 
void EnableStockInfoPanelDisplays ()
 Enable the Stock standardized info line displays More...
 
void EnableStockInfoPanelDisplays (bool enable)
 Set the Enabled state of Stock standardized info line displays for this stage group More...
 
StageIcon FindSymmetryGroupleader (StageIcon icon)
 
void FixGroupUIState ()
 Sets the state of the icons in a group to what the GUI expects. NOTE: needed until the backend can populate the groups correctly More...
 
int GetStageGroupIndex (PointerEventData eventData, out StageIcon stageIcon, out int modifiedSiblingIndex)
 
void MoveAllIconsInto (StageGroup moveInto)
 
void MoveIconsInto (StageGroup oldStageGroup, StageIcon selectedLeader, List< StageIcon > selectedIcons, StageIcon unSelectedLeader, List< StageIcon > unSelectedIcons, int insertAt, int modifiedSiblingIndex)
 Moves icons from one stagegroup to another. More...
 
void OnPointerClick (PointerEventData eventData)
 
void RemoveIcon (StageIcon icon, bool changeParents=true)
 
void Reset ()
 For the reset button in the StageManager GUI Backend: Resets Part.inverseStage to Part.DefaultInverseStage and all values to default Visually: Moves parts in the staging gui to where they would have been had the sequence not been modified in any way More...
 
bool ResetAvailable ()
 
virtual void SetDeltaVHeading_OnDeltaVCalcsCompleted ()
 The code thats called when DeltaVCalcsCompleted Fires to update the text/display of the DVHeading More...
 
virtual void SetDeltaVHeading_OnUpdate ()
 The code thats called during Update to set the text/display of the DVHeading More...
 
void SetInverseStageIndex (int index)
 
void SetManualStageOffset ()
 set the star on icons More...
 
void SetPartIndices (bool seqOverride=true)
 
void SetSiblingIndexes ()
 Set proper sibling indexes of all icons belonging to group For easy resetting More...
 
void SetUiStageIndex (int index)
 
void ToggleInfoPanel ()
 Toggle the display state of the InfoPanel More...
 
void ToggleInfoPanel (bool showPanel)
 Slide the InfoPanel in/out More...
 
void UpdateInStageIndexes ()
 

Public Attributes

int defaultStage = -1
 
int inverseStageIndex = 0
 
bool manualOverride = false
 

Protected Attributes

Button addButton
 
Button deleteButton
 
Color DeltaVHeadingColor
 
LayoutElement DeltaVHeadingObject
 
TextMeshProUGUI DeltaVHeadingText
 
UIDragPanel dragHandler
 
LayoutElement FooterLayout
 
RectTransform iconsUiList
 
StageGroupInfoItem infoItemPrefab
 
LayoutElement InfoPanelLayout
 

Properties

bool DeltaVHeadingEnabled [get]
 Is the Delta-v headings enabled More...
 
List< StageIcon > Icons [get]
 
RectTransform IconsUIList [get]
 
bool InfoPanelEnabled [get]
 Is the Info Panel enabled - ie the slidein/out panel More...
 
bool InfoPanelStockDisplayEnabled [get]
 Is the Info Panel enabled - ie the slidein/out panel More...
 
bool IsBeingDragged [get, set]
 
RectTransform RectTransform [get]
 

Member Function Documentation

void KSP.UI.Screens.StageGroup.AddIcon ( StageIcon  icon,
bool  setParent = true 
)
inline
void KSP.UI.Screens.StageGroup.AddIconAt ( StageIcon  icon,
int  index,
int  forcedSiblingIndex,
bool  setParent = true 
)
inline
void KSP.UI.Screens.StageGroup.AddIcons ( StageIcon[]  iconsToAdd)
inline
void KSP.UI.Screens.StageGroup.AddStageAfter ( )
inline

for the gui + button

void KSP.UI.Screens.StageGroup.DisableDeltaVHeading ( )
inline

Disable the Delta-v Heading in the stage group

void KSP.UI.Screens.StageGroup.DisableInfoPanel ( )
inline

Disable the Info Panel in the stage group

void KSP.UI.Screens.StageGroup.DisableStockInfoPanelDisplays ( )
inline

Disable the Stock standardized info line displays

Do this if you are going to replace teh stock lines with other content

void KSP.UI.Screens.StageGroup.EnableDeltaVHeading ( )
inline

Enable the Delta-v Heading in the stage group

void KSP.UI.Screens.StageGroup.EnableDeltaVHeading ( bool  enable)
inline

Set the Enabled state of the Delta-v Heading in the stage group

Parameters
enableSet true to enable
void KSP.UI.Screens.StageGroup.EnableInfoPanel ( )
inline

Enable the Info Panel in the stage group

void KSP.UI.Screens.StageGroup.EnableInfoPanel ( bool  enable)
inline

Set the Enabled state of the Info Panel in the stage group

Parameters
enableSet true to enable
void KSP.UI.Screens.StageGroup.EnableStockInfoPanelDisplays ( )
inline

Enable the Stock standardized info line displays

void KSP.UI.Screens.StageGroup.EnableStockInfoPanelDisplays ( bool  enable)
inline

Set the Enabled state of Stock standardized info line displays for this stage group

Disable this if you are going to replace teh stock lines with other content

Parameters
enableSet true to enable
StageIcon KSP.UI.Screens.StageGroup.FindSymmetryGroupleader ( StageIcon  icon)
inline
void KSP.UI.Screens.StageGroup.FixGroupUIState ( )
inline

Sets the state of the icons in a group to what the GUI expects. NOTE: needed until the backend can populate the groups correctly

int KSP.UI.Screens.StageGroup.GetStageGroupIndex ( PointerEventData  eventData,
out StageIcon  stageIcon,
out int  modifiedSiblingIndex 
)
inline
void KSP.UI.Screens.StageGroup.MoveAllIconsInto ( StageGroup  moveInto)
inline
void KSP.UI.Screens.StageGroup.MoveIconsInto ( StageGroup  oldStageGroup,
StageIcon  selectedLeader,
List< StageIcon >  selectedIcons,
StageIcon  unSelectedLeader,
List< StageIcon >  unSelectedIcons,
int  insertAt,
int  modifiedSiblingIndex 
)
inline

Moves icons from one stagegroup to another.

Parameters
selectedLeader
selectedIcons
insertAt
modifiedSiblingIndex
void KSP.UI.Screens.StageGroup.OnPointerClick ( PointerEventData  eventData)
inline
void KSP.UI.Screens.StageGroup.RemoveIcon ( StageIcon  icon,
bool  changeParents = true 
)
inline
void KSP.UI.Screens.StageGroup.Reset ( )
inline

For the reset button in the StageManager GUI Backend: Resets Part.inverseStage to Part.DefaultInverseStage and all values to default Visually: Moves parts in the staging gui to where they would have been had the sequence not been modified in any way

bool KSP.UI.Screens.StageGroup.ResetAvailable ( )
inline
virtual void KSP.UI.Screens.StageGroup.SetDeltaVHeading_OnDeltaVCalcsCompleted ( )
inlinevirtual

The code thats called when DeltaVCalcsCompleted Fires to update the text/display of the DVHeading

Its called in update when the is true

In stock code this is what updates the total Dv number on staging and building in the editor

virtual void KSP.UI.Screens.StageGroup.SetDeltaVHeading_OnUpdate ( )
inlinevirtual

The code thats called during Update to set the text/display of the DVHeading

Its called in update when the is true

In stock code this is what updates the Dv HEading in flight

void KSP.UI.Screens.StageGroup.SetInverseStageIndex ( int  index)
inline
void KSP.UI.Screens.StageGroup.SetManualStageOffset ( )
inline

set the star on icons

void KSP.UI.Screens.StageGroup.SetPartIndices ( bool  seqOverride = true)
inline
void KSP.UI.Screens.StageGroup.SetSiblingIndexes ( )
inline

Set proper sibling indexes of all icons belonging to group For easy resetting

void KSP.UI.Screens.StageGroup.SetUiStageIndex ( int  index)
inline
void KSP.UI.Screens.StageGroup.ToggleInfoPanel ( )
inline

Toggle the display state of the InfoPanel

void KSP.UI.Screens.StageGroup.ToggleInfoPanel ( bool  showPanel)
inline

Slide the InfoPanel in/out

Parameters
showPanelWhether it Shoudl end up shown or hidden
void KSP.UI.Screens.StageGroup.UpdateInStageIndexes ( )
inline

Member Data Documentation

Button KSP.UI.Screens.StageGroup.addButton
protected
int KSP.UI.Screens.StageGroup.defaultStage = -1
Button KSP.UI.Screens.StageGroup.deleteButton
protected
Color KSP.UI.Screens.StageGroup.DeltaVHeadingColor
protected
LayoutElement KSP.UI.Screens.StageGroup.DeltaVHeadingObject
protected
TextMeshProUGUI KSP.UI.Screens.StageGroup.DeltaVHeadingText
protected
UIDragPanel KSP.UI.Screens.StageGroup.dragHandler
protected
LayoutElement KSP.UI.Screens.StageGroup.FooterLayout
protected
RectTransform KSP.UI.Screens.StageGroup.iconsUiList
protected
StageGroupInfoItem KSP.UI.Screens.StageGroup.infoItemPrefab
protected
LayoutElement KSP.UI.Screens.StageGroup.InfoPanelLayout
protected
int KSP.UI.Screens.StageGroup.inverseStageIndex = 0
bool KSP.UI.Screens.StageGroup.manualOverride = false

Property Documentation

bool KSP.UI.Screens.StageGroup.DeltaVHeadingEnabled
get

Is the Delta-v headings enabled

List<StageIcon> KSP.UI.Screens.StageGroup.Icons
get
RectTransform KSP.UI.Screens.StageGroup.IconsUIList
get
bool KSP.UI.Screens.StageGroup.InfoPanelEnabled
get

Is the Info Panel enabled - ie the slidein/out panel

bool KSP.UI.Screens.StageGroup.InfoPanelStockDisplayEnabled
get

Is the Info Panel enabled - ie the slidein/out panel

bool KSP.UI.Screens.StageGroup.IsBeingDragged
getset
RectTransform KSP.UI.Screens.StageGroup.RectTransform
get
The documentation for this class was generated from the following file:
API Download: HTML | XML
Generated on Tue Nov 1 2022 18:36:37 for Kerbal Space Program by   doxygen 1.8.7