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

Classes

class  CanvasWrapper
 

Public Member Functions

bool AddCanvas (UICanvasPrefab canvasPrefab, bool removeOnSceneSwitch=true)
 
bool AddCanvas (Canvas parentCanvas, UICanvasPrefab canvasPrefab, bool removeOnSceneSwitch=true)
 
bool AddCanvas (Canvas canvasPrefab, bool removeOnSceneSwitch=true)
 
bool CanSpawnCanvasPrefab (UICanvasPrefab canvasPrefab)
 
void DespawnTooltip (ITooltipController tooltipController)
 
void DestroyCurrentTooltip ()
 
float GetMaxSuggestedUIScale ()
 
void HideUI ()
 
void PinTooltip (IPinnableTooltipController tooltipController)
 
void RegisterModalDialog (CanvasGroup d)
 
void RegisterNonModalDialog (CanvasGroup d)
 
bool RemoveCanvas (string name)
 
bool RemoveCanvas (UICanvasPrefab controller)
 
bool RemoveCanvas (Canvas canvasPrefab)
 
void SetAppScale (float appScale)
 
void SetScale (float uiScale)
 
void ShowUI ()
 
void SpawnTooltip (ITooltipController tooltipController)
 
void UnpinTooltip (IPinnableTooltipController tooltipController)
 
void UnregisterModalDialog (CanvasGroup d)
 
void UnregisterNonModalDialog (CanvasGroup d)
 

Static Public Member Functions

static bool AnyCornerOffScreen (RectTransform rect)
 
static void ClampToScreen (RectTransform panelRectTransform, Vector2 screenEdgeOffset)
 
static void ClampToScreen (RectTransform panelRectTransform, float topEdgeOffset, float bottomEdgeOffset, float leftEdgeOffset, float rightEdgeOffset)
 
static void ClampToWindow (RectTransform parentRectTransform, RectTransform panelRectTransform, Vector2 screenEdgeOffset)
 
static void ClampToWindow (RectTransform parentRectTransform, RectTransform panelRectTransform, float topEdgeOffset, float bottomEdgeOffset, float leftEdgeOffset, float rightEdgeOffset)
 
static void CutToScreen (RectTransform panelRectTransform)
 
static void CutToScreen (RectTransform panelRectTransform, bool cutTop, bool cutBottom, bool cutLeft, bool cutRight)
 
static void CutToWindow (RectTransform parentRectTransform, RectTransform panelRectTransform)
 
static void CutToWindow (RectTransform parentRectTransform, RectTransform panelRectTransform, bool cutTop, bool cutBottom, bool cutLeft, bool cutRight)
 
static void DragTooltip (RectTransform rect, Vector2 mouseDelta, Vector2 cursorStandoff)
 
static void RepositionTooltip (RectTransform rect, Vector2 cursorStandoff, float cursorBottomRightLength=8f)
 
static void SetupNavigationMode (GameObject obj)
 
static Vector3 WorldToMainCanvas (Vector3 worldPosition, Camera cam)
 

Public Attributes

Canvas actionCanvas
 
Canvas appCanvas
 
Canvas debugCanvas
 
Canvas dialogCanvas
 
Canvas dragDropCanvas
 Canvas for UI objects being dragged. Controlled by UIDragAndDropController. More...
 
bool forceNavigationMode = true
 
Canvas mainCanvas
 
Navigation.Mode navigationMode = Navigation.Mode.None
 
Canvas screenMessageCanvas
 
Canvas tooltipCanvas
 
Canvas tweeningCanvas
 Canvas for UI objects being tweened (animated by updating transform position) More...
 
Camera uiCamera
 
float uiScale = 1f
 
Camera vectorCamera
 

Properties

bool CameraMode [get]
 Bool flag indicating that the UI is hidden when the game is paused during flight and player can move the camera around, usually for taking screenshots. More...
 
ITooltipController CurrentTooltip [get]
 
static UIMasterController Instance [get, set]
 
bool IsUIShowing [get]
 Bool flag indicating when the UI is showing based on onShowUI events More...
 

Member Function Documentation

bool KSP.UI.UIMasterController.AddCanvas ( UICanvasPrefab  canvasPrefab,
bool  removeOnSceneSwitch = true 
)
inline
bool KSP.UI.UIMasterController.AddCanvas ( Canvas  parentCanvas,
UICanvasPrefab  canvasPrefab,
bool  removeOnSceneSwitch = true 
)
inline
bool KSP.UI.UIMasterController.AddCanvas ( Canvas  canvasPrefab,
bool  removeOnSceneSwitch = true 
)
inline
static bool KSP.UI.UIMasterController.AnyCornerOffScreen ( RectTransform  rect)
inlinestatic
bool KSP.UI.UIMasterController.CanSpawnCanvasPrefab ( UICanvasPrefab  canvasPrefab)
inline
static void KSP.UI.UIMasterController.ClampToScreen ( RectTransform  panelRectTransform,
Vector2  screenEdgeOffset 
)
inlinestatic
static void KSP.UI.UIMasterController.ClampToScreen ( RectTransform  panelRectTransform,
float  topEdgeOffset,
float  bottomEdgeOffset,
float  leftEdgeOffset,
float  rightEdgeOffset 
)
inlinestatic
static void KSP.UI.UIMasterController.ClampToWindow ( RectTransform  parentRectTransform,
RectTransform  panelRectTransform,
Vector2  screenEdgeOffset 
)
inlinestatic
static void KSP.UI.UIMasterController.ClampToWindow ( RectTransform  parentRectTransform,
RectTransform  panelRectTransform,
float  topEdgeOffset,
float  bottomEdgeOffset,
float  leftEdgeOffset,
float  rightEdgeOffset 
)
inlinestatic
static void KSP.UI.UIMasterController.CutToScreen ( RectTransform  panelRectTransform)
inlinestatic
static void KSP.UI.UIMasterController.CutToScreen ( RectTransform  panelRectTransform,
bool  cutTop,
bool  cutBottom,
bool  cutLeft,
bool  cutRight 
)
inlinestatic
static void KSP.UI.UIMasterController.CutToWindow ( RectTransform  parentRectTransform,
RectTransform  panelRectTransform 
)
inlinestatic
static void KSP.UI.UIMasterController.CutToWindow ( RectTransform  parentRectTransform,
RectTransform  panelRectTransform,
bool  cutTop,
bool  cutBottom,
bool  cutLeft,
bool  cutRight 
)
inlinestatic
void KSP.UI.UIMasterController.DespawnTooltip ( ITooltipController  tooltipController)
inline
void KSP.UI.UIMasterController.DestroyCurrentTooltip ( )
inline
static void KSP.UI.UIMasterController.DragTooltip ( RectTransform  rect,
Vector2  mouseDelta,
Vector2  cursorStandoff 
)
inlinestatic
float KSP.UI.UIMasterController.GetMaxSuggestedUIScale ( )
inline
void KSP.UI.UIMasterController.HideUI ( )
inline
void KSP.UI.UIMasterController.PinTooltip ( IPinnableTooltipController  tooltipController)
inline
void KSP.UI.UIMasterController.RegisterModalDialog ( CanvasGroup  d)
inline
void KSP.UI.UIMasterController.RegisterNonModalDialog ( CanvasGroup  d)
inline
bool KSP.UI.UIMasterController.RemoveCanvas ( string  name)
inline
bool KSP.UI.UIMasterController.RemoveCanvas ( UICanvasPrefab  controller)
inline
bool KSP.UI.UIMasterController.RemoveCanvas ( Canvas  canvasPrefab)
inline
static void KSP.UI.UIMasterController.RepositionTooltip ( RectTransform  rect,
Vector2  cursorStandoff,
float  cursorBottomRightLength = 8f 
)
inlinestatic
void KSP.UI.UIMasterController.SetAppScale ( float  appScale)
inline
void KSP.UI.UIMasterController.SetScale ( float  uiScale)
inline
static void KSP.UI.UIMasterController.SetupNavigationMode ( GameObject  obj)
inlinestatic
void KSP.UI.UIMasterController.ShowUI ( )
inline
void KSP.UI.UIMasterController.SpawnTooltip ( ITooltipController  tooltipController)
inline
void KSP.UI.UIMasterController.UnpinTooltip ( IPinnableTooltipController  tooltipController)
inline
void KSP.UI.UIMasterController.UnregisterModalDialog ( CanvasGroup  d)
inline
void KSP.UI.UIMasterController.UnregisterNonModalDialog ( CanvasGroup  d)
inline
static Vector3 KSP.UI.UIMasterController.WorldToMainCanvas ( Vector3  worldPosition,
Camera  cam 
)
inlinestatic

Member Data Documentation

Canvas KSP.UI.UIMasterController.actionCanvas
Canvas KSP.UI.UIMasterController.appCanvas
Canvas KSP.UI.UIMasterController.debugCanvas
Canvas KSP.UI.UIMasterController.dialogCanvas
Canvas KSP.UI.UIMasterController.dragDropCanvas

Canvas for UI objects being dragged. Controlled by UIDragAndDropController.

bool KSP.UI.UIMasterController.forceNavigationMode = true
Canvas KSP.UI.UIMasterController.mainCanvas
Navigation.Mode KSP.UI.UIMasterController.navigationMode = Navigation.Mode.None
Canvas KSP.UI.UIMasterController.screenMessageCanvas
Canvas KSP.UI.UIMasterController.tooltipCanvas
Canvas KSP.UI.UIMasterController.tweeningCanvas

Canvas for UI objects being tweened (animated by updating transform position)

Camera KSP.UI.UIMasterController.uiCamera
float KSP.UI.UIMasterController.uiScale = 1f
Camera KSP.UI.UIMasterController.vectorCamera

Property Documentation

bool KSP.UI.UIMasterController.CameraMode
get

Bool flag indicating that the UI is hidden when the game is paused during flight and player can move the camera around, usually for taking screenshots.

ITooltipController KSP.UI.UIMasterController.CurrentTooltip
get
UIMasterController KSP.UI.UIMasterController.Instance
staticgetset
bool KSP.UI.UIMasterController.IsUIShowing
get

Bool flag indicating when the UI is showing based on onShowUI events

Helps give a definitive value for is the UI is hidden in flight


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