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

Classes

class  ClickEvent< PointerEventData, State, CallType >
 
class  StateChangeEvent2< UIRadioButton, CallType, PointerEventData >
 
class  StateChangeEvent< PointerEventData, CallType >
 

Public Types

enum  CallType { CallType.USER, CallType.APPLICATION, CallType.APPLICATIONSILENT }
 
enum  ClickType { ClickType.None, ClickType.ClickOnly, ClickType.ClickAndStateChange }
 
enum  State { State.True, State.False }
 
enum  StateSetWith { StateSetWith.LEFT = 0, StateSetWith.RIGHT = 1, StateSetWith.BOTH = 2 }
 

Public Member Functions

void OnDestroy ()
 
void SetGroup (int groupID, bool pop=true)
 Makes the radio button a part of the specified group and it will thenceforth be mutually exclusive to all other radio buttons in the same group. More...
 
void SetState (State state, CallType callType, PointerEventData data, bool popButtonsInGroup=true)
 

Public Attributes

object Data
 
ClickType leftClick
 
ClickEvent< PointerEventData,
State, CallType
onClick = new ClickEvent<PointerEventData, State, CallType>()
 
StateChangeEvent
< PointerEventData, CallType
onFalse = new StateChangeEvent<PointerEventData, CallType>()
 
StateChangeEvent2
< UIRadioButton, CallType,
PointerEventData > 
onFalseBtn = new StateChangeEvent2<UIRadioButton, CallType, PointerEventData>()
 
StateChangeEvent
< PointerEventData, CallType
onTrue = new StateChangeEvent<PointerEventData, CallType>()
 
StateChangeEvent2
< UIRadioButton, CallType,
PointerEventData > 
onTrueBtn = new StateChangeEvent2<UIRadioButton, CallType, PointerEventData>()
 
ClickType rightClick
 
ButtonState stateFalse
 
ButtonState stateTrue
 
TMPro.TextMeshProUGUI textLabel
 
bool unselectable = true
 

Protected Member Functions

void PopOtherButtonsInGroup ()
 

Protected Attributes

State currentState
 
RadioButtonGroup group
 Sets all other buttons in the group to false. More...
 

Properties

State CurrentState [get]
 
Image Image [get, set]
 
bool Interactable [get, set]
 
int RadioGroup [get, set]
 The numbered group to which this radio button belongs. Buttons that share a group will be mutually exclusive to one another. More...
 
State StartState [get]
 
virtual bool Value [get, set]
 Provides access to the boolean value of the button. More...
 
- Properties inherited from KSP.UI.IRadioButton
string name [get, set]
 
bool Value [get, set]
 

Member Enumeration Documentation

enum KSP.UI.UIRadioButton.CallType
Enumerator
USER 
APPLICATION 
APPLICATIONSILENT 
enum KSP.UI.UIRadioButton.ClickType
Enumerator
None 
ClickOnly 
ClickAndStateChange 
enum KSP.UI.UIRadioButton.State
Enumerator
True 
False 
enum KSP.UI.UIRadioButton.StateSetWith
Enumerator
LEFT 
RIGHT 
BOTH 

Member Function Documentation

void KSP.UI.UIRadioButton.OnDestroy ( )
inline

< Remove self from the group

void KSP.UI.UIRadioButton.PopOtherButtonsInGroup ( )
inlineprotected
void KSP.UI.UIRadioButton.SetGroup ( int  groupID,
bool  pop = true 
)
inline

Makes the radio button a part of the specified group and it will thenceforth be mutually exclusive to all other radio buttons in the same group.

Parameters
groupIDThe ID of the group to which this radio will be assigned.

< Add self to the button group:

void KSP.UI.UIRadioButton.SetState ( State  state,
CallType  callType,
PointerEventData  data,
bool  popButtonsInGroup = true 
)
inline

Member Data Documentation

State KSP.UI.UIRadioButton.currentState
protected
object KSP.UI.UIRadioButton.Data
RadioButtonGroup KSP.UI.UIRadioButton.group
protected

Sets all other buttons in the group to false.

ClickType KSP.UI.UIRadioButton.leftClick
ClickEvent<PointerEventData, State, CallType> KSP.UI.UIRadioButton.onClick = new ClickEvent<PointerEventData, State, CallType>()
StateChangeEvent<PointerEventData, CallType> KSP.UI.UIRadioButton.onFalse = new StateChangeEvent<PointerEventData, CallType>()
StateChangeEvent2<UIRadioButton, CallType, PointerEventData> KSP.UI.UIRadioButton.onFalseBtn = new StateChangeEvent2<UIRadioButton, CallType, PointerEventData>()
StateChangeEvent<PointerEventData, CallType> KSP.UI.UIRadioButton.onTrue = new StateChangeEvent<PointerEventData, CallType>()
StateChangeEvent2<UIRadioButton, CallType, PointerEventData> KSP.UI.UIRadioButton.onTrueBtn = new StateChangeEvent2<UIRadioButton, CallType, PointerEventData>()
ClickType KSP.UI.UIRadioButton.rightClick
ButtonState KSP.UI.UIRadioButton.stateFalse
ButtonState KSP.UI.UIRadioButton.stateTrue
TMPro.TextMeshProUGUI KSP.UI.UIRadioButton.textLabel
bool KSP.UI.UIRadioButton.unselectable = true

Property Documentation

State KSP.UI.UIRadioButton.CurrentState
get
Image KSP.UI.UIRadioButton.Image
getset
bool KSP.UI.UIRadioButton.Interactable
getset
int KSP.UI.UIRadioButton.RadioGroup
getset

The numbered group to which this radio button belongs. Buttons that share a group will be mutually exclusive to one another.

State KSP.UI.UIRadioButton.StartState
get
virtual bool KSP.UI.UIRadioButton.Value
getset

Provides access to the boolean value of the button.


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