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 | Static Public Attributes | Properties | List of all members
KSP.UI.Screens.ApplicationLauncher Class Reference
Inheritance diagram for KSP.UI.Screens.ApplicationLauncher:

Public Types

enum  AppScenes {
  AppScenes.NEVER = 0, AppScenes.ALWAYS = ~NEVER, AppScenes.SPACECENTER = 1 << 0, AppScenes.FLIGHT = 1 << 1,
  AppScenes.MAPVIEW = 1 << 2, AppScenes.VAB = 1 << 3, AppScenes.SPH = 1 << 4, AppScenes.TRACKSTATION = 1 << 5,
  AppScenes.MAINMENU = 1 << 6
}
 

Public Member Functions

ApplicationLauncherButton AddApplication (Callback onTrue, Callback onFalse, Callback onHover, Callback onHoverOut, Callback onEnable, Callback onDisable, Texture texture)
 
ApplicationLauncherButton AddApplication (Callback onTrue, Callback onFalse, Callback onHover, Callback onHoverOut, Callback onEnable, Callback onDisable, Animator sprite)
 
ApplicationLauncherButton AddModApplication (Callback onTrue, Callback onFalse, Callback onHover, Callback onHoverOut, Callback onEnable, Callback onDisable, ApplicationLauncher.AppScenes visibleInScenes, Texture texture)
 Add a MOD(3rd party) application to the Application Launcher. Use ApplicationLauncherButton.VisibleInScenes to set where the button should be displayed. More...
 
ApplicationLauncherButton AddModApplication (Callback onTrue, Callback onFalse, Callback onHover, Callback onHoverOut, Callback onEnable, Callback onDisable, ApplicationLauncher.AppScenes visibleInScenes, Animator sprite)
 Add a MOD(3rd party) application to the Application Launcher. Use ApplicationLauncherButton.VisibleInScenes to set where the button should be displayed. More...
 
void AddOnHideCallback (OnHide del)
 
void AddOnRepositionCallback (OnReposition del)
 
void AddOnShowCallback (OnShow del)
 
bool Contains (ApplicationLauncherButton button, out bool hidden)
 Is this button added to the Application Launcher? More...
 
bool DetermineVisibility (ApplicationLauncherButton button)
 Determine if an app should be shown/hidden and then show/hide it's button More...
 
void DisableMutuallyExclusive (ApplicationLauncherButton launcherButton)
 
void EnableMutuallyExclusive (ApplicationLauncherButton launcherButton)
 
UIList GetKnowledgeBaseList ()
 
void Hide ()
 
delegate void OnHide ()
 
delegate void OnReposition ()
 
delegate void OnShow ()
 
void RemoveApplication (ApplicationLauncherButton button)
 
void RemoveModApplication (ApplicationLauncherButton button)
 
void RemoveOnHideCallback (OnHide del)
 
void RemoveOnRepositionCallback (OnReposition del)
 
void RemoveOnShowCallback (OnShow del)
 
bool ShouldBeVisible (ApplicationLauncherButton button)
 Should this app button be visible? More...
 
void Show ()
 

Public Attributes

RectTransform appSpace
 
RectTransform launcherSpace
 
ApplicationLauncherButton listItemPrefab
 
SimpleLayout prefab_horizontalRightLeft
 
SimpleLayout prefab_verticalTopDown
 
RectTransform tmpButtonStorage
 
RectTransform tmpModButtonStorage
 

Static Public Attributes

static bool Ready
 

Properties

ApplauncherLayout CurrentLayout [get]
 
static ApplicationLauncher Instance [get, set]
 
bool IsPositionedAtTop [get, set]
 

Member Enumeration Documentation

enum KSP.UI.Screens.ApplicationLauncher.AppScenes
Enumerator
NEVER 
ALWAYS 
SPACECENTER 
FLIGHT 
MAPVIEW 
VAB 
SPH 
TRACKSTATION 
MAINMENU 

Member Function Documentation

ApplicationLauncherButton KSP.UI.Screens.ApplicationLauncher.AddApplication ( Callback  onTrue,
Callback  onFalse,
Callback  onHover,
Callback  onHoverOut,
Callback  onEnable,
Callback  onDisable,
Texture  texture 
)
inline
ApplicationLauncherButton KSP.UI.Screens.ApplicationLauncher.AddApplication ( Callback  onTrue,
Callback  onFalse,
Callback  onHover,
Callback  onHoverOut,
Callback  onEnable,
Callback  onDisable,
Animator  sprite 
)
inline
ApplicationLauncherButton KSP.UI.Screens.ApplicationLauncher.AddModApplication ( Callback  onTrue,
Callback  onFalse,
Callback  onHover,
Callback  onHoverOut,
Callback  onEnable,
Callback  onDisable,
ApplicationLauncher.AppScenes  visibleInScenes,
Texture  texture 
)
inline

Add a MOD(3rd party) application to the Application Launcher. Use ApplicationLauncherButton.VisibleInScenes to set where the button should be displayed.

Parameters
onTrueCallback for when the button is toggeled on
onFalseCallback for when the button is toggeled off
onHoverCallback for when the mouse is hovering over the button
onHoverOutCallback for when the mouse hoveris off the button
onEnableCallback for when the button is shown or enabled by the application launcher
onDisableCallback for when the button is hidden or disabled by the application launcher
visibleInScenesThe "scenes" this button will be visible in. For example VisibleInScenes = ApplicationLauncher.AppScenes.FLIGHT | ApplicationLauncher.AppScenes.MAPVIEW;
textureThe 38x38 Texture to use for the button icon.
Returns
ApplicationLauncherButton KSP.UI.Screens.ApplicationLauncher.AddModApplication ( Callback  onTrue,
Callback  onFalse,
Callback  onHover,
Callback  onHoverOut,
Callback  onEnable,
Callback  onDisable,
ApplicationLauncher.AppScenes  visibleInScenes,
Animator  sprite 
)
inline

Add a MOD(3rd party) application to the Application Launcher. Use ApplicationLauncherButton.VisibleInScenes to set where the button should be displayed.

Parameters
onTrueCallback for when the button is toggeled on
onFalseCallback for when the button is toggeled off
onHoverCallback for when the mouse is hovering over the button
onHoverOutCallback for when the mouse hoveris off the button
onEnableCallback for when the button is shown or enabled by the application launcher
onDisableCallback for when the button is hidden or disabled by the application launcher
visibleInScenesThe "scenes" this button will be visible in. For example VisibleInScenes = ApplicationLauncher.AppScenes.FLIGHT | ApplicationLauncher.AppScenes.MAPVIEW;
spriteThe 38x38 'Animator' animation to use for the button icon. Use ApplicationLauncherButton.PlayAnim() to play the animation.
Returns
void KSP.UI.Screens.ApplicationLauncher.AddOnHideCallback ( OnHide  del)
inline
void KSP.UI.Screens.ApplicationLauncher.AddOnRepositionCallback ( OnReposition  del)
inline
void KSP.UI.Screens.ApplicationLauncher.AddOnShowCallback ( OnShow  del)
inline
bool KSP.UI.Screens.ApplicationLauncher.Contains ( ApplicationLauncherButton  button,
out bool  hidden 
)
inline

Is this button added to the Application Launcher?

Parameters
buttonThe button checked for.
hiddenTrue if the button is currently hidden.
Returns
True if the button is added to the Application Launcher.
bool KSP.UI.Screens.ApplicationLauncher.DetermineVisibility ( ApplicationLauncherButton  button)
inline

Determine if an app should be shown/hidden and then show/hide it's button

Parameters
buttonThe application button to show/hide
void KSP.UI.Screens.ApplicationLauncher.DisableMutuallyExclusive ( ApplicationLauncherButton  launcherButton)
inline
void KSP.UI.Screens.ApplicationLauncher.EnableMutuallyExclusive ( ApplicationLauncherButton  launcherButton)
inline
UIList KSP.UI.Screens.ApplicationLauncher.GetKnowledgeBaseList ( )
inline
void KSP.UI.Screens.ApplicationLauncher.Hide ( )
inline
delegate void KSP.UI.Screens.ApplicationLauncher.OnHide ( )
delegate void KSP.UI.Screens.ApplicationLauncher.OnReposition ( )
delegate void KSP.UI.Screens.ApplicationLauncher.OnShow ( )
void KSP.UI.Screens.ApplicationLauncher.RemoveApplication ( ApplicationLauncherButton  button)
inline
void KSP.UI.Screens.ApplicationLauncher.RemoveModApplication ( ApplicationLauncherButton  button)
inline
void KSP.UI.Screens.ApplicationLauncher.RemoveOnHideCallback ( OnHide  del)
inline
void KSP.UI.Screens.ApplicationLauncher.RemoveOnRepositionCallback ( OnReposition  del)
inline
void KSP.UI.Screens.ApplicationLauncher.RemoveOnShowCallback ( OnShow  del)
inline
bool KSP.UI.Screens.ApplicationLauncher.ShouldBeVisible ( ApplicationLauncherButton  button)
inline

Should this app button be visible?

Parameters
buttonThe application button to determine visibility for.
Returns
True if the application button should be visible.
void KSP.UI.Screens.ApplicationLauncher.Show ( )
inline

Member Data Documentation

RectTransform KSP.UI.Screens.ApplicationLauncher.appSpace
RectTransform KSP.UI.Screens.ApplicationLauncher.launcherSpace
ApplicationLauncherButton KSP.UI.Screens.ApplicationLauncher.listItemPrefab
SimpleLayout KSP.UI.Screens.ApplicationLauncher.prefab_horizontalRightLeft
SimpleLayout KSP.UI.Screens.ApplicationLauncher.prefab_verticalTopDown
bool KSP.UI.Screens.ApplicationLauncher.Ready
static
RectTransform KSP.UI.Screens.ApplicationLauncher.tmpButtonStorage
RectTransform KSP.UI.Screens.ApplicationLauncher.tmpModButtonStorage

Property Documentation

ApplauncherLayout KSP.UI.Screens.ApplicationLauncher.CurrentLayout
get
ApplicationLauncher KSP.UI.Screens.ApplicationLauncher.Instance
staticgetset
bool KSP.UI.Screens.ApplicationLauncher.IsPositionedAtTop
getset

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