Kerbal Space Program  1.12.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Attributes | List of all members
Expansions.Missions.Editor.MEGUI_NumberRange Class Reference

System attribute to specify a number slider - can be used on int, float and double More...

Inheritance diagram for Expansions.Missions.Editor.MEGUI_NumberRange:
Expansions.Missions.Editor.MEGUI_Control FieldAttribute

Public Attributes

bool clampTextInput = false
 clamp any text entry to be within the min/max of the slider More...
 
string displayFormat = "F0"
 Format string for the number More...
 
float displayMultiply = 1f
 A multiplier for the display value - eg say you wanna display kM then set this to 1000 More...
 
string displayUnits = ""
 suffix to add on end of number More...
 
float maxValue = 1f
 What the max end of the slider equals More...
 
float minValue = 0f
 What the min end of the slider equals More...
 
int roundToPlaces = -1
 round the value to this many places (-1 = no rounding) More...
 
- Public Attributes inherited from Expansions.Missions.Editor.MEGUI_Control
bool canBePinned
 Whether the parameter can be pinned for the node body More...
 
bool canBeReset
 Whether the parameter can be reset More...
 
CheckpointValidationType checkpointValidation
 Flag that set if this field should be skiped in the checkpoint validation process More...
 
string compareValuesForCheckpoint
 [If checkpointValidation is set to CustomMethod] Name of the method to be triggered to validate if this field is dirty on a target checkpoint Usage if checkpointValue != fieldValue then the validation fails and a false return is expected, to set the checkpoint as dirty More...
 
bool gapDisplay
 Specify if this control have a GAP display More...
 
string group
 Used for fields that are meant to be grouped or related More...
 
string groupDisplayName
 
bool groupStartCollapsed
 When true the group that this is part of will start collapsed More...
 
bool hideOnSetup
 Set to true to hide this field's control during setup so it can be toggled on/off by other controls. More...
 
bool hideWhenDocked
 Set to true to hide this field's control when it is docked to another node. More...
 
bool hideWhenInputConnected
 Set to true to hide this field's control when the input of the node is connected to another node. More...
 
bool hideWhenNoActionModules
 Set to true to hide this field's control when the the node has no action modules. More...
 
bool hideWhenNoTestModules
 Set to true to hide this field's control when the the node has no test modules. More...
 
bool hideWhenOutputConnected
 Set to true to hide this field's control when the output of the node is connected to another node. More...
 
bool hideWhenSiblingsExist
 Set to true to hide this field's control when its inside a compound param and there are other controls alongside it More...
 
bool hideWhenStartNode
 Set to true to hide this field's control when it's the Start Node or docked to the Start Node. More...
 
string onControlCreated
 Name of the method to be triggered on control creation More...
 
string onControlSetupComplete
 Name of the method to be triggered after control creation and setup is completed More...
 
string onValueChange
 Name of the method to be triggered on value change More...
 
int order
 Sort order index for this parameter in the SAP More...
 
string resetValue
 Key to pass the ResetValue method when the reset button is pressed More...
 
bool tabStop
 

Additional Inherited Members

- Public Types inherited from Expansions.Missions.Editor.MEGUI_Control
enum  InputContentType {
  InputContentType.Standard, InputContentType.Autocorrected, InputContentType.IntegerNumber, InputContentType.DecimalNumber,
  InputContentType.Alphanumeric, InputContentType.Name, InputContentType.EmailAddress, InputContentType.Password,
  InputContentType.Pin, InputContentType.Custom, InputContentType.Percentage
}
 // Setting the content type acts as a shortcut for setting a combination of InputType, CharacterValidation, LineType, and TouchScreenKeyboardType More...
 
- Public Member Functions inherited from Expansions.Missions.Editor.MEGUI_Control
 MEGUI_Control ()
 
- Public Member Functions inherited from FieldAttribute
 FieldAttribute ()
 
- Properties inherited from Expansions.Missions.Editor.MEGUI_Control
string Tooltip [get, set]
 The text to be dislayed in the tooltip for this field More...
 
- Properties inherited from FieldAttribute
string guiName [get, set]
 The field's gui name More...
 

Detailed Description

System attribute to specify a number slider - can be used on int, float and double

Member Data Documentation

bool Expansions.Missions.Editor.MEGUI_NumberRange.clampTextInput = false

clamp any text entry to be within the min/max of the slider

string Expansions.Missions.Editor.MEGUI_NumberRange.displayFormat = "F0"

Format string for the number

float Expansions.Missions.Editor.MEGUI_NumberRange.displayMultiply = 1f

A multiplier for the display value - eg say you wanna display kM then set this to 1000

string Expansions.Missions.Editor.MEGUI_NumberRange.displayUnits = ""

suffix to add on end of number

float Expansions.Missions.Editor.MEGUI_NumberRange.maxValue = 1f

What the max end of the slider equals

float Expansions.Missions.Editor.MEGUI_NumberRange.minValue = 0f

What the min end of the slider equals

int Expansions.Missions.Editor.MEGUI_NumberRange.roundToPlaces = -1

round the value to this many places (-1 = no rounding)


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