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

Public Types

enum  AnimatedIconType { AnimatedIconType.NOTIFICATION = 1 }
 Type of animation you can play on an icon (supposed to be extendable) More...
 

Public Member Functions

void Disable (bool makeCall=true)
 
void Enable (bool makeCall=true)
 
Vector3 GetAnchor ()
 Only applicable to KSP vanilla apps. when applauncher is on top: returns lover left else returns upper right More...
 
Vector3 GetAnchorLocal ()
 Like GetAnchor, but uses the container's local position instead of the world position. More...
 
Vector3 GetAnchorTopRight ()
 Note: this method is made for the anchoring of GenericAppFrame, implement the other cases if you need. More...
 
Vector3 GetAnchorUL ()
 
Vector3 GetAnchorUR ()
 
void PlayAnim (AnimatedIconType animationType, float duration)
 
void PlayAnim (AnimatedIconType animationType)
 
void SetFalse (bool makeCall=true)
 
void SetSprite (Animator sprite)
 
void SetTexture (Texture texture)
 
void SetTrue (bool makeCall=true)
 
void Setup (Texture texture)
 This method does not instantiate a button. Use ApplicationLauncher.Instance.AddModApplication instead. More...
 
void Setup (Callback onButtonTrue, Callback onButtonFalse, Texture texture)
 This method does not instantiate a button. Use ApplicationLauncher.Instance.AddModApplication instead. More...
 
void Setup (Callback onButtonTrue, Callback onButtonFalse, Callback onButtonHover, Callback onButtonHoverOut, Texture texture)
 This method does not instantiate a button. Use ApplicationLauncher.Instance.AddModApplication instead. More...
 
void Setup (Callback onButtonTrue, Callback onButtonFalse, Callback onButtonHover, Callback onButtonHoverOut, Callback onButtonEnable, Callback onButtonDisable, Texture texture)
 This method does not instantiate a button. Use ApplicationLauncher.Instance.AddModApplication instead. More...
 
void Setup (Callback onButtonTrue, Callback onButtonFalse, Callback onButtonHover, Callback onButtonHoverOut, Callback onButtonEnable, Callback onButtonDisable, ApplicationLauncher.AppScenes visibleInScenes, Texture texture)
 This method does not instantiate a button. Use ApplicationLauncher.Instance.AddModApplication instead. More...
 
void Setup (Animator sprite)
 This method does not instantiate a button. Use ApplicationLauncher.Instance.AddModApplication instead. More...
 
void Setup (Callback onButtonTrue, Callback onButtonFalse, Animator sprite)
 This method does not instantiate a button. Use ApplicationLauncher.Instance.AddModApplication instead. More...
 
void Setup (Callback onButtonTrue, Callback onButtonFalse, Callback onButtonHover, Callback onButtonHoverOut, Animator sprite)
 This method does not instantiate a button. Use ApplicationLauncher.Instance.AddModApplication instead. More...
 
void Setup (Callback onButtonTrue, Callback onButtonFalse, Callback onButtonHover, Callback onButtonHoverOut, Callback onButtonEnable, Callback onButtonDisable, Animator sprite)
 This method does not instantiate a button. Use ApplicationLauncher.Instance.AddModApplication instead. More...
 
void Setup (Callback onButtonTrue, Callback onButtonFalse, Callback onButtonHover, Callback onButtonHoverOut, Callback onButtonEnable, Callback onButtonDisable, ApplicationLauncher.AppScenes visibleInScenes, Animator sprite)
 This method does not instantiate a button. Use ApplicationLauncher.Instance.AddModApplication instead. More...
 
void StopAnim ()
 
void StopAnim (GameScenes scene)
 

Public Attributes

UIListItem container
 
PointerEnterExitHandler hoverController
 
Callback onDisable = delegate { }
 
Callback onEnable = delegate { }
 
Callback onFalse = delegate { }
 
Callback onHover = delegate { }
 
Callback< UIRadioButtononHoverBtn = delegate { }
 
Callback< UIRadioButtononHoverBtnActive = delegate { }
 
Callback onHoverOut = delegate { }
 
Callback< UIRadioButtononHoverOutBtn = delegate { }
 
Callback onLeftClick = delegate { }
 
Callback< UIRadioButtononLeftClickBtn = delegate { }
 
Callback onRightClick = delegate { }
 
Callback onTrue = delegate { }
 
RawImage sprite
 
Animator spriteAnim
 
UIRadioButton toggleButton
 

Properties

bool IsEnabled [get, set]
 
bool IsHovering [get, set]
 
ApplicationLauncher.AppScenes VisibleInScenes [get, set]
 The "scenes" this button will be visible in. For example VisibleInScenes = ApplicationLauncher.AppScenes.FLIGHT | ApplicationLauncher.AppScenes.MAPVIEW; More...
 

Member Enumeration Documentation

enum KSP.UI.Screens.ApplicationLauncherButton.AnimatedIconType

Type of animation you can play on an icon (supposed to be extendable)

Enumerator
NOTIFICATION 

Member Function Documentation

void KSP.UI.Screens.ApplicationLauncherButton.Disable ( bool  makeCall = true)
inline
void KSP.UI.Screens.ApplicationLauncherButton.Enable ( bool  makeCall = true)
inline
Vector3 KSP.UI.Screens.ApplicationLauncherButton.GetAnchor ( )
inline

Only applicable to KSP vanilla apps. when applauncher is on top: returns lover left else returns upper right

Returns
Vector3 KSP.UI.Screens.ApplicationLauncherButton.GetAnchorLocal ( )
inline

Like GetAnchor, but uses the container's local position instead of the world position.

Vector3 KSP.UI.Screens.ApplicationLauncherButton.GetAnchorTopRight ( )
inline

Note: this method is made for the anchoring of GenericAppFrame, implement the other cases if you need.

Returns
Top right position in AppSpace as AnchoredPosition
Vector3 KSP.UI.Screens.ApplicationLauncherButton.GetAnchorUL ( )
inline

Returns
Upper Left corner of AppButton in worldspace
Vector3 KSP.UI.Screens.ApplicationLauncherButton.GetAnchorUR ( )
inline

Returns
Upper Right corner of AppButton in worldspace
void KSP.UI.Screens.ApplicationLauncherButton.PlayAnim ( AnimatedIconType  animationType,
float  duration 
)
inline
void KSP.UI.Screens.ApplicationLauncherButton.PlayAnim ( AnimatedIconType  animationType)
inline
void KSP.UI.Screens.ApplicationLauncherButton.SetFalse ( bool  makeCall = true)
inline
void KSP.UI.Screens.ApplicationLauncherButton.SetSprite ( Animator  sprite)
inline
void KSP.UI.Screens.ApplicationLauncherButton.SetTexture ( Texture  texture)
inline
void KSP.UI.Screens.ApplicationLauncherButton.SetTrue ( bool  makeCall = true)
inline
void KSP.UI.Screens.ApplicationLauncherButton.Setup ( Texture  texture)
inline

This method does not instantiate a button. Use ApplicationLauncher.Instance.AddModApplication instead.

Parameters
texture
void KSP.UI.Screens.ApplicationLauncherButton.Setup ( Callback  onButtonTrue,
Callback  onButtonFalse,
Texture  texture 
)
inline

This method does not instantiate a button. Use ApplicationLauncher.Instance.AddModApplication instead.

Parameters
onButtonTrue
onButtonFalse
texture
void KSP.UI.Screens.ApplicationLauncherButton.Setup ( Callback  onButtonTrue,
Callback  onButtonFalse,
Callback  onButtonHover,
Callback  onButtonHoverOut,
Texture  texture 
)
inline

This method does not instantiate a button. Use ApplicationLauncher.Instance.AddModApplication instead.

Parameters
onButtonTrue
onButtonFalse
onButtonHover
onButtonHoverOut
texture
void KSP.UI.Screens.ApplicationLauncherButton.Setup ( Callback  onButtonTrue,
Callback  onButtonFalse,
Callback  onButtonHover,
Callback  onButtonHoverOut,
Callback  onButtonEnable,
Callback  onButtonDisable,
Texture  texture 
)
inline

This method does not instantiate a button. Use ApplicationLauncher.Instance.AddModApplication instead.

Parameters
onButtonTrue
onButtonFalse
onButtonHover
onButtonHoverOut
onButtonEnable
onButtonDisable
texture
void KSP.UI.Screens.ApplicationLauncherButton.Setup ( Callback  onButtonTrue,
Callback  onButtonFalse,
Callback  onButtonHover,
Callback  onButtonHoverOut,
Callback  onButtonEnable,
Callback  onButtonDisable,
ApplicationLauncher.AppScenes  visibleInScenes,
Texture  texture 
)
inline

This method does not instantiate a button. Use ApplicationLauncher.Instance.AddModApplication instead.

Parameters
onButtonTrue
onButtonFalse
onButtonHover
onButtonHoverOut
onButtonEnable
onButtonDisable
visibleInScenes
texture
void KSP.UI.Screens.ApplicationLauncherButton.Setup ( Animator  sprite)
inline

This method does not instantiate a button. Use ApplicationLauncher.Instance.AddModApplication instead.

Parameters
sprite
void KSP.UI.Screens.ApplicationLauncherButton.Setup ( Callback  onButtonTrue,
Callback  onButtonFalse,
Animator  sprite 
)
inline

This method does not instantiate a button. Use ApplicationLauncher.Instance.AddModApplication instead.

Parameters
onButtonTrue
onButtonFalse
sprite
void KSP.UI.Screens.ApplicationLauncherButton.Setup ( Callback  onButtonTrue,
Callback  onButtonFalse,
Callback  onButtonHover,
Callback  onButtonHoverOut,
Animator  sprite 
)
inline

This method does not instantiate a button. Use ApplicationLauncher.Instance.AddModApplication instead.

Parameters
onButtonTrue
onButtonFalse
onButtonHover
onButtonHoverOut
sprite
void KSP.UI.Screens.ApplicationLauncherButton.Setup ( Callback  onButtonTrue,
Callback  onButtonFalse,
Callback  onButtonHover,
Callback  onButtonHoverOut,
Callback  onButtonEnable,
Callback  onButtonDisable,
Animator  sprite 
)
inline

This method does not instantiate a button. Use ApplicationLauncher.Instance.AddModApplication instead.

Parameters
onButtonTrue
onButtonFalse
onButtonHover
onButtonHoverOut
onButtonEnable
onButtonDisable
sprite
void KSP.UI.Screens.ApplicationLauncherButton.Setup ( Callback  onButtonTrue,
Callback  onButtonFalse,
Callback  onButtonHover,
Callback  onButtonHoverOut,
Callback  onButtonEnable,
Callback  onButtonDisable,
ApplicationLauncher.AppScenes  visibleInScenes,
Animator  sprite 
)
inline

This method does not instantiate a button. Use ApplicationLauncher.Instance.AddModApplication instead.

Parameters
onButtonTrue
onButtonFalse
onButtonHover
onButtonHoverOut
onButtonEnable
onButtonDisable
visibleInScenes
sprite
void KSP.UI.Screens.ApplicationLauncherButton.StopAnim ( )
inline
void KSP.UI.Screens.ApplicationLauncherButton.StopAnim ( GameScenes  scene)
inline

Member Data Documentation

UIListItem KSP.UI.Screens.ApplicationLauncherButton.container
PointerEnterExitHandler KSP.UI.Screens.ApplicationLauncherButton.hoverController
Callback KSP.UI.Screens.ApplicationLauncherButton.onDisable = delegate { }
Callback KSP.UI.Screens.ApplicationLauncherButton.onEnable = delegate { }
Callback KSP.UI.Screens.ApplicationLauncherButton.onFalse = delegate { }
Callback KSP.UI.Screens.ApplicationLauncherButton.onHover = delegate { }
Callback<UIRadioButton> KSP.UI.Screens.ApplicationLauncherButton.onHoverBtn = delegate { }
Callback<UIRadioButton> KSP.UI.Screens.ApplicationLauncherButton.onHoverBtnActive = delegate { }
Callback KSP.UI.Screens.ApplicationLauncherButton.onHoverOut = delegate { }
Callback<UIRadioButton> KSP.UI.Screens.ApplicationLauncherButton.onHoverOutBtn = delegate { }
Callback KSP.UI.Screens.ApplicationLauncherButton.onLeftClick = delegate { }
Callback<UIRadioButton> KSP.UI.Screens.ApplicationLauncherButton.onLeftClickBtn = delegate { }
Callback KSP.UI.Screens.ApplicationLauncherButton.onRightClick = delegate { }
Callback KSP.UI.Screens.ApplicationLauncherButton.onTrue = delegate { }
RawImage KSP.UI.Screens.ApplicationLauncherButton.sprite
Animator KSP.UI.Screens.ApplicationLauncherButton.spriteAnim
UIRadioButton KSP.UI.Screens.ApplicationLauncherButton.toggleButton

Property Documentation

bool KSP.UI.Screens.ApplicationLauncherButton.IsEnabled
getset
bool KSP.UI.Screens.ApplicationLauncherButton.IsHovering
getset
ApplicationLauncher.AppScenes KSP.UI.Screens.ApplicationLauncherButton.VisibleInScenes
getset

The "scenes" this button will be visible in. For example VisibleInScenes = ApplicationLauncher.AppScenes.FLIGHT | ApplicationLauncher.AppScenes.MAPVIEW;


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