Kerbal Space Program  1.12.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Attributes | Protected Member Functions | Properties | List of all members
KSP.UI.Screens.AppUIMemberInput Class Reference

An Input field for string data More...

Inheritance diagram for KSP.UI.Screens.AppUIMemberInput:
KSP.UI.Screens.AppUIMember KSP.UI.Screens.AppUIMemberInputFloat

Public Attributes

TMP_InputField input
 
bool showSuffix = false
 Whether to show a suffix label after the input field More...
 
TextMeshProUGUI suffixLabel
 
float suffixPadding = 4f
 Padding in pixels between the input and the suffix label More...
 
float suffixWidth = 20f
 Width in pixels of the suffix label More...
 
- Public Attributes inherited from KSP.UI.Screens.AppUIMember
AppUI_Control.HorizontalAlignment guiNameHorizAlignment = AppUI_Control.HorizontalAlignment.Left
 The horizontal alignment for the guiName text. More...
 
TextMeshProUGUI guiNameLabel
 
AppUI_Control.VerticalAlignment guiNameVertAlignment = AppUI_Control.VerticalAlignment.Midline
 The vertical alignment for the guiName text. More...
 
bool hideOnError
 If set true will hide this control in error states. More...
 
int order
 Sort order index for this parameter in the panel More...
 
bool showGuiName = true
 

Protected Member Functions

override void OnInitialized ()
 Overridable Method called after a member is correctly set up More...
 
override void OnRefreshUI ()
 Method called in subclasses when refreshUI is called More...
 
override void OnStart ()
 Overridable Method called at end of Unity Start More...
 
virtual void RefreshUIInput ()
 
- Protected Member Functions inherited from KSP.UI.Screens.AppUIMember
object GetValue ()
 Get the value of the underlying member More...
 
GetValue< T > ()
 
virtual void OnAwake ()
 Overridable Method called at end of Unity Awake More...
 
virtual void OnUpdate ()
 Overridable Method called at end of Unity Update More...
 
bool SetValue (object newValue)
 Set the value of the underlying member More...
 

Properties

string suffixText [get, set]
 The text for the suffix label More...
 
- Properties inherited from KSP.UI.Screens.AppUIMember
string guiName [get, set]
 The field's gui name More...
 
string HoverText [get, set]
 WHat to change the panels textTargetForHover to when mouse is over this More...
 
bool IsInitialized [get, set]
 Did the reflected member get all set up correctly More...
 
string Name [get]
 The Member Name More...
 

Additional Inherited Members

- Public Member Functions inherited from KSP.UI.Screens.AppUIMember
void RefreshUI ()
 Method called for refreshing the UI More...
 
void SetHoverTextTarget (TextMeshProUGUI textTargetForHover)
 
virtual void Setup (AppUI_Data host, MemberInfo member, AppUI_Control attribs, AppUIInputPanel parentPanel)
 Setup the UI element from the host, member and attributes More...
 
- Static Public Member Functions inherited from KSP.UI.Screens.AppUIMember
static int SortByOrder (AppUIMember m1, AppUIMember m2)
 Sort AppUIMembers by ascending order More...
 
- Protected Attributes inherited from KSP.UI.Screens.AppUIMember
AppUI_Control _attribs
 
FieldInfo _field
 
AppUI_Data _host
 
MemberInfo _member
 
PropertyInfo _property
 
RectTransform guiNameLabelRectTransform = null
 
List< UIHoverTexthoverTextList
 List of hover text elemants that should have their help text set by this component More...
 
bool isEnum
 
VerticalLayoutGroup parentLayoutGroup = null
 The layout group of the parent More...
 
AppUIInputPanel parentPanel = null
 The panel that is holding this member More...
 
RectTransform valueHolderRectTransform = null
 
Vector2 valueRectOffsetMin
 
Type valueType
 

Detailed Description

An Input field for string data

Member Function Documentation

override void KSP.UI.Screens.AppUIMemberInput.OnInitialized ( )
inlineprotectedvirtual

Overridable Method called after a member is correctly set up

Reimplemented from KSP.UI.Screens.AppUIMember.

Reimplemented in KSP.UI.Screens.AppUIMemberInputFloat.

override void KSP.UI.Screens.AppUIMemberInput.OnRefreshUI ( )
inlineprotectedvirtual

Method called in subclasses when refreshUI is called

Implements KSP.UI.Screens.AppUIMember.

override void KSP.UI.Screens.AppUIMemberInput.OnStart ( )
inlineprotectedvirtual

Overridable Method called at end of Unity Start

Reimplemented from KSP.UI.Screens.AppUIMember.

virtual void KSP.UI.Screens.AppUIMemberInput.RefreshUIInput ( )
inlineprotectedvirtual

Member Data Documentation

TMP_InputField KSP.UI.Screens.AppUIMemberInput.input
bool KSP.UI.Screens.AppUIMemberInput.showSuffix = false

Whether to show a suffix label after the input field

TextMeshProUGUI KSP.UI.Screens.AppUIMemberInput.suffixLabel
float KSP.UI.Screens.AppUIMemberInput.suffixPadding = 4f

Padding in pixels between the input and the suffix label

float KSP.UI.Screens.AppUIMemberInput.suffixWidth = 20f

Width in pixels of the suffix label

Property Documentation

string KSP.UI.Screens.AppUIMemberInput.suffixText
getset

The text for the suffix label


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