Class KSP2UIWindow

Namespace

KSP.UI

Assembly

Assembly-CSharp.dll

[PrefabName("KSP2UIWindow.prefab")]
public class KSP2UIWindow : UIModule

Inheritance

object

KerbalMonoBehaviour

UIModule

KSP2UIWindow

Derived

KSP2MessageBox

TutorialFullScreenVideo

TutorialMessageBox

Inherited Members

UIModule.Pool()

UIModule.Created()

UIModule.Initialized()

UIModule.Pooled()

UIModule.Manager

KerbalMonoBehaviour.Game

KerbalMonoBehaviour.Assets

KerbalMonoBehaviour.Messages

KerbalMonoBehaviour.CFXSystem

KerbalMonoBehaviour.IsGameShuttingDown

Extension Methods

ObjectExtensions.Apply<T>(T, Action<T>)

ObjectExtensions.Let<T, R>(T, Func<T, R>)

ObjectExtensions.Use<T>(T, Action<T>)

TypeConverters.CopyPropertiesFromFields(object, object, bool)

TypeConverters.CopyPropertiesFromProperties(object, object, bool)

Constructors

KSP2UIWindow()

public KSP2UIWindow()

Fields

BottomBorder

public float BottomBorder

Field Value

float

InvertBottomBorder

public bool InvertBottomBorder

Field Value

bool

InvertLeftBorder

public bool InvertLeftBorder

Field Value

bool

InvertRightBorder

public bool InvertRightBorder

Field Value

bool

InvertTopBorder

public bool InvertTopBorder

Field Value

bool

LeftBorder

public float LeftBorder

Field Value

float

MaxSize

public Vector2 MaxSize

Field Value

Vector2

MaxSizeIsScreen

public bool MaxSizeIsScreen

Field Value

bool

MinSize

public Vector2 MinSize

Field Value

Vector2

OnUIWindowCloseAnim

protected DOTweenAnimation OnUIWindowCloseAnim

Field Value

DOTweenAnimation

OnUIWindowIdleLoopAnim

protected DOTweenAnimation OnUIWindowIdleLoopAnim

Field Value

DOTweenAnimation

OnUIWindowOpenAnim

protected DOTweenAnimation OnUIWindowOpenAnim

Field Value

DOTweenAnimation

OnWindowMove

public Callback<RectTransform> OnWindowMove

Field Value

Callback<RectTransform>

OnWindowResize

public Callback<RectTransform> OnWindowResize

Field Value

Callback<RectTransform>

RightBorder

public float RightBorder

Field Value

float

TopBorder

public float TopBorder

Field Value

float

_bodyPanel

protected RectTransform _bodyPanel

Field Value

RectTransform

_footerPanel

protected RectTransform _footerPanel

Field Value

RectTransform

_headerPanel

protected RectTransform _headerPanel

Field Value

RectTransform

_windowParent

protected RectTransform _windowParent

Field Value

RectTransform

bindRoot

protected ContextBindRoot bindRoot

Field Value

ContextBindRoot

dataContext

protected DataContext dataContext

Field Value

DataContext

Properties

IsInitialized

protected bool IsInitialized { get; }

Property Value

bool

IsOnFocusQueuedForInit

protected bool IsOnFocusQueuedForInit { get; }

Property Value

bool

IsOnOpenQueuedForInit

protected bool IsOnOpenQueuedForInit { get; }

Property Value

bool

WindowCanvas

public Canvas WindowCanvas { get; }

Property Value

Canvas

WindowRectTransform

public RectTransform WindowRectTransform { get; }

Property Value

RectTransform

Methods

Awake()

public virtual void Awake()

CheckIfLocKey(ref string)

public void CheckIfLocKey(ref string messageKey)

Parameters

messageKey string

ClampToParentRect(RectTransform, RectTransform, float, float, float, float)

public static void ClampToParentRect(RectTransform parentRectTransform, RectTransform panelRectTransform, float topEdgeOffset, float bottomEdgeOffset, float leftEdgeOffset, float rightEdgeOffset)

Parameters

parentRectTransform RectTransform

panelRectTransform RectTransform

topEdgeOffset float

bottomEdgeOffset float

leftEdgeOffset float

rightEdgeOffset float

ClampToScreen()

public void ClampToScreen()

CutToParentRect(RectTransform, RectTransform, bool, bool, bool, bool, float, float, float, float)

public static void CutToParentRect(RectTransform parentRectTransform, RectTransform panelRectTransform, bool cutTop, bool cutBottom, bool cutLeft, bool cutRight, float topEdgeOffset, float bottomEdgeOffset, float leftEdgeOffset, float rightEdgeOffset)

Parameters

parentRectTransform RectTransform

panelRectTransform RectTransform

cutTop bool

cutBottom bool

cutLeft bool

cutRight bool

topEdgeOffset float

bottomEdgeOffset float

leftEdgeOffset float

rightEdgeOffset float

CutToScreen(ResizeHeightOptions, ResizeWidthOptions)

public void CutToScreen(KSP2UIWindow.ResizeHeightOptions resizeHeight, KSP2UIWindow.ResizeWidthOptions resizeWidth)

Parameters

resizeHeight KSP2UIWindow.ResizeHeightOptions

resizeWidth KSP2UIWindow.ResizeWidthOptions

FireEvent(Type)

public void FireEvent(Type eventType)

Parameters

eventType Type

OnClose()

public virtual void OnClose()

OnCloseUIAnimationComplete()

public virtual void OnCloseUIAnimationComplete()

OnEnable()

public virtual void OnEnable()

OnFocus()

public virtual void OnFocus()

OnOpen()

public virtual void OnOpen()

OnOpenUIAnimationComplete()

public virtual void OnOpenUIAnimationComplete()

PauseAnimations(bool)

public void PauseAnimations(bool paused)

Parameters

paused bool

PlayUICloseSounds()

public void PlayUICloseSounds()

PlayUIOpenSounds()

public void PlayUIOpenSounds()

ResizeWindowByDelta(Vector2, ResizeHeightOptions, ResizeWidthOptions)

public void ResizeWindowByDelta(Vector2 delta, KSP2UIWindow.ResizeHeightOptions resizeHeight, KSP2UIWindow.ResizeWidthOptions resizeWidth)

Parameters

delta Vector2

resizeHeight KSP2UIWindow.ResizeHeightOptions

resizeWidth KSP2UIWindow.ResizeWidthOptions

ResizeWindowByOffset(Vector2, Vector2, Vector2, ResizeHeightOptions, ResizeWidthOptions)

public void ResizeWindowByOffset(Vector2 offsetMin, Vector2 offsetMax, Vector2 delta, KSP2UIWindow.ResizeHeightOptions resizeHeight, KSP2UIWindow.ResizeWidthOptions resizeWidth)

Parameters

offsetMin Vector2

offsetMax Vector2

delta Vector2

resizeHeight KSP2UIWindow.ResizeHeightOptions

resizeWidth KSP2UIWindow.ResizeWidthOptions

ResyncWindowCanvas()

public void ResyncWindowCanvas()

SetFocus()

public void SetFocus()

UpdateLocalPosition(Vector2)

public void UpdateLocalPosition(Vector2 localPosition)

Parameters

localPosition Vector2