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.LED Class Reference
Inheritance diagram for KSP.UI.Screens.LED:

Public Types

enum  colorIndices {
  colorIndices.off, colorIndices.red, colorIndices.yellow, colorIndices.green,
  colorIndices.blue, colorIndices.purple
}
 

Public Member Functions

void Blink (float interval)
 Makes the LED blink. (uses last defined color or defaults to red) More...
 
void SetColor (colorIndices color)
 Sets the LED's color. (will only take effect when the LED is on) More...
 
void setOff ()
 Sets the LED to off. More...
 
void SetOn ()
 Sets the LED to on (will use the color defined by the last setColor call, or will default to red if color wasn't set) More...
 
void SetOn (bool on)
 turns the LED on or off depending on the parameter boolean value More...
 

Public Attributes

colorIndices currentColor
 
Image image
 
UnityEngine.Sprite[] ledColors
 

Properties

colorIndices color [get]
 
bool IsBlinking [get]
 
bool IsOn [get]
 Indicates whether or not the LED is on (read-only) More...
 

Member Enumeration Documentation

enum KSP.UI.Screens.LED.colorIndices
Enumerator
off 
red 
yellow 
green 
blue 
purple 

Member Function Documentation

void KSP.UI.Screens.LED.Blink ( float  interval)
inline

Makes the LED blink. (uses last defined color or defaults to red)

Parameters
intervalblink interval in seconds

< Don't start another coroutine if one is already running

void KSP.UI.Screens.LED.SetColor ( colorIndices  color)
inline

Sets the LED's color. (will only take effect when the LED is on)

Parameters
colorIndex for the new color. Use the LED.colorIndices enum to get color indices
void KSP.UI.Screens.LED.setOff ( )
inline

Sets the LED to off.

void KSP.UI.Screens.LED.SetOn ( )
inline

Sets the LED to on (will use the color defined by the last setColor call, or will default to red if color wasn't set)

void KSP.UI.Screens.LED.SetOn ( bool  on)
inline

turns the LED on or off depending on the parameter boolean value

Parameters
onset to on?

Member Data Documentation

colorIndices KSP.UI.Screens.LED.currentColor
Image KSP.UI.Screens.LED.image
UnityEngine.Sprite [] KSP.UI.Screens.LED.ledColors

Property Documentation

colorIndices KSP.UI.Screens.LED.color
get
bool KSP.UI.Screens.LED.IsBlinking
get
bool KSP.UI.Screens.LED.IsOn
get

Indicates whether or not the LED is on (read-only)


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