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
Expansions.Missions.Editor.MEGUI_Control Class Reference

Attribute applied to fields to make available to the action pane parameter UI. More...

Inheritance diagram for Expansions.Missions.Editor.MEGUI_Control:
FieldAttribute Expansions.Missions.Editor.MEGUI_Asteroid Expansions.Missions.Editor.MEGUI_AsteroidSelect Expansions.Missions.Editor.MEGUI_Button Expansions.Missions.Editor.MEGUI_Category Expansions.Missions.Editor.MEGUI_CelestialBody Expansions.Missions.Editor.MEGUI_CelestialBody_Biomes Expansions.Missions.Editor.MEGUI_CelestialBody_Orbit Expansions.Missions.Editor.MEGUI_Checkbox Expansions.Missions.Editor.MEGUI_ColorPicker Expansions.Missions.Editor.MEGUI_Comet Expansions.Missions.Editor.MEGUI_CometSelect Expansions.Missions.Editor.MEGUI_CrewList Expansions.Missions.Editor.MEGUI_Dropdown Expansions.Missions.Editor.MEGUI_DynamicModule Expansions.Missions.Editor.MEGUI_DynamicModuleList Expansions.Missions.Editor.MEGUI_FlagSelect Expansions.Missions.Editor.MEGUI_GameParameters Expansions.Missions.Editor.MEGUI_InputField Expansions.Missions.Editor.MEGUI_Label Expansions.Missions.Editor.MEGUI_LaunchSiteSituation Expansions.Missions.Editor.MEGUI_ListOrder Expansions.Missions.Editor.MEGUI_MissionInstructor Expansions.Missions.Editor.MEGUI_MissionKerbal Expansions.Missions.Editor.MEGUI_NodeLabelNodeSelect Expansions.Missions.Editor.MEGUI_NodeSelect Expansions.Missions.Editor.MEGUI_NumberRange Expansions.Missions.Editor.MEGUI_ParameterSwitchCompound Expansions.Missions.Editor.MEGUI_PartPicker Expansions.Missions.Editor.MEGUI_Quaternion Expansions.Missions.Editor.MEGUI_ScoreRangeList Expansions.Missions.Editor.MEGUI_ScrollViewSelector Expansions.Missions.Editor.MEGUI_SurfaceArea Expansions.Missions.Editor.MEGUI_SurfaceVolume Expansions.Missions.Editor.MEGUI_TextArea Expansions.Missions.Editor.MEGUI_Time Expansions.Missions.Editor.MEGUI_VesselGroundLocation Expansions.Missions.Editor.MEGUI_VesselLocation Expansions.Missions.Editor.MEGUI_VesselPartSelect Expansions.Missions.Editor.MEGUI_VesselSelect Expansions.Missions.Editor.MEGUI_VesselSituation

Public Types

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

 MEGUI_Control ()
 
- Public Member Functions inherited from FieldAttribute
 FieldAttribute ()
 

Public Attributes

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
 

Properties

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

Attribute applied to fields to make available to the action pane parameter UI.

Member Enumeration Documentation

// Setting the content type acts as a shortcut for setting a combination of InputType, CharacterValidation, LineType, and TouchScreenKeyboardType

Enumerator
Standard 
Autocorrected 
IntegerNumber 
DecimalNumber 
Alphanumeric 
Name 
EmailAddress 
Password 
Pin 
Custom 
Percentage 

Constructor & Destructor Documentation

Expansions.Missions.Editor.MEGUI_Control.MEGUI_Control ( )
inline

Member Data Documentation

bool Expansions.Missions.Editor.MEGUI_Control.canBePinned

Whether the parameter can be pinned for the node body

bool Expansions.Missions.Editor.MEGUI_Control.canBeReset

Whether the parameter can be reset

CheckpointValidationType Expansions.Missions.Editor.MEGUI_Control.checkpointValidation

Flag that set if this field should be skiped in the checkpoint validation process

string Expansions.Missions.Editor.MEGUI_Control.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

Method signature is: private bool compareValuesForCheckpoint(object checkpointValue)

bool Expansions.Missions.Editor.MEGUI_Control.gapDisplay

Specify if this control have a GAP display

string Expansions.Missions.Editor.MEGUI_Control.group

Used for fields that are meant to be grouped or related

string Expansions.Missions.Editor.MEGUI_Control.groupDisplayName

bool Expansions.Missions.Editor.MEGUI_Control.groupStartCollapsed

When true the group that this is part of will start collapsed

bool Expansions.Missions.Editor.MEGUI_Control.hideOnSetup

Set to true to hide this field's control during setup so it can be toggled on/off by other controls.

bool Expansions.Missions.Editor.MEGUI_Control.hideWhenDocked

Set to true to hide this field's control when it is docked to another node.

bool Expansions.Missions.Editor.MEGUI_Control.hideWhenInputConnected

Set to true to hide this field's control when the input of the node is connected to another node.

bool Expansions.Missions.Editor.MEGUI_Control.hideWhenNoActionModules

Set to true to hide this field's control when the the node has no action modules.

bool Expansions.Missions.Editor.MEGUI_Control.hideWhenNoTestModules

Set to true to hide this field's control when the the node has no test modules.

bool Expansions.Missions.Editor.MEGUI_Control.hideWhenOutputConnected

Set to true to hide this field's control when the output of the node is connected to another node.

bool Expansions.Missions.Editor.MEGUI_Control.hideWhenSiblingsExist

Set to true to hide this field's control when its inside a compound param and there are other controls alongside it

bool Expansions.Missions.Editor.MEGUI_Control.hideWhenStartNode

Set to true to hide this field's control when it's the Start Node or docked to the Start Node.

string Expansions.Missions.Editor.MEGUI_Control.onControlCreated

Name of the method to be triggered on control creation

Method signature is: private void OnControlCreated(MEGUIParameter control)

obvs use the specific control your after

string Expansions.Missions.Editor.MEGUI_Control.onControlSetupComplete

Name of the method to be triggered after control creation and setup is completed

Method signature is: private void OnControlCreated(MEGUIParameter control)

obvs use the specific control your after

string Expansions.Missions.Editor.MEGUI_Control.onValueChange

Name of the method to be triggered on value change

Method signature is: private void OnValueChanged(object newValue)

int Expansions.Missions.Editor.MEGUI_Control.order

Sort order index for this parameter in the SAP

string Expansions.Missions.Editor.MEGUI_Control.resetValue

Key to pass the ResetValue method when the reset button is pressed

bool Expansions.Missions.Editor.MEGUI_Control.tabStop

Property Documentation

string Expansions.Missions.Editor.MEGUI_Control.Tooltip
getset

The text to be dislayed in the tooltip for this field


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