Kerbal Space Program  1.12.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Protected Attributes | Properties | List of all members
Expansions.Missions.Editor.MEActionPane Class Reference
Inheritance diagram for Expansions.Missions.Editor.MEActionPane:

Public Member Functions

MEGUIParameterGroup AddParameterBlock (string headerName, string displayName, BaseAPFieldList fields, Transform parent, List< string > invalidGroups=null, string currentGroup="", bool parametersSelectable=true, int offset=0, int depth=0)
 Adds a block of parameter instances to the SAP pane in the MissionEditor. More...
 
void CheckDeletedNodeFromGap (MENode node)
 check if GAP needs to be cleared and unlocked after the node has been deleted. More...
 
void Clean ()
 Clean the action pane SAP/GAP More...
 
void ClearCache ()
 Clears the parameter cache, destroying all the cached parameters prefabs More...
 
void CurrentLockdeNode (MENode node)
 Store current node when the locked parameter is active More...
 
MEGUIParameterGroup DisplayModuleHeader (string name, string displayName, BaseAPFieldList fields, Transform parent)
 Displays a module section header in the SAP, this is used as a separator More...
 
GAPInitialize< T > ()
 Initialize or gets the reference to a GAP display More...
 
TMPro.TMP_InputField GetNextInputTabStop (bool direction)
 We check the next or previus field we want to tab to More...
 
MEGUIParameter GetParameterFromFieldID (string fieldID)
 Gets a parameter from the provided field id More...
 
void InitializeGapMinHeight ()
 Called when MissionBuilder starts and when the cache is cleaned. More...
 
void RemoveParameterGroup (string group)
 Removes parameters from the currently selected Node More...
 
void SAPDisplayConnectorParameters (MEGUIConnector connector)
 Displays the node connector parameters in the SAP More...
 
void SAPDisplayMultipleSelectedItemsMessage (int nodesSelected, string itemName)
 
void SAPDisplayNodeParameters (MEGUINode node)
 Displays the node parameters in the SAP More...
 
void SAPRefreshNodeParameters ()
 Refreshes the node parameters displayed in the SAP More...
 
void SavePreferedGapSize ()
 This method checks that the gap cannot be minimized less than it's minimum height size More...
 
void ScrollBar (float value)
 
void ScrollPanel (float height)
 
void UpdateSAPScroll (UnityEngine.EventSystems.PointerEventData pointerData)
 A pass through method to scroll the SAP window from other sources More...
 

Public Attributes

MEGUIFooterAdditionalButton FooterAdditionalButtonPrefab
 
IconLoader gapIconLoader
 
Toggle gapLockToggle
 GAP lock toggle control More...
 
MEGUIPanel GAPPanel
 
MEGUIParameterGroup ParameterGroupPrefab
 
MEGUIPanel SAPPanel
 

Static Public Attributes

static MEActionPane fetch
 

Protected Member Functions

void DisplayModuleFooter (string name, BaseAPFieldList fields)
 Displays a footer parameter in the SAP, this connects to the IMENodeDisplay interface to get the list of available parameters More...
 
void DisplayNodeModuleSection (IMENodeDisplay module)
 Display the fields/properties of the IMENodeDisplay module in the SAP More...
 
void DisplayNodeSettingsSection (MENode node)
 Display the basic nodes settings in the SAP More...
 
MEGUIParameter DisplayParameter (BaseAPField field, Transform parent, bool isSelectable)
 Displays a basefield in the SAP More...
 
void OnGAPLockValueChange (bool value)
 The actions that occur when the GAP Lock UI is toggled More...
 

Protected Attributes

Transform cacheTmpLocation
 
Dictionary< string,
MEGUIParameter
currentParameterCache
 
GameObject gapIconLoaderPrefab
 
Dictionary< MonoBehaviour,
Dictionary< string,
MEGUIParameter > > 
parameterCache
 

Properties

ActionPaneDisplay CurrentGapDisplay [get, set]
 Current active GAP display More...
 
bool IsGAPLocked [get, set]
 Returns if the GAP display is locked Note. this does not affect the parameter focus/selection behaviour More...
 
MEGUIParameter SelectedSAPParameter [get, set]
 Currently selected parameter in the SAP, this parameter controls the GAP display More...
 

Member Function Documentation

MEGUIParameterGroup Expansions.Missions.Editor.MEActionPane.AddParameterBlock ( string  headerName,
string  displayName,
BaseAPFieldList  fields,
Transform  parent,
List< string >  invalidGroups = null,
string  currentGroup = "",
bool  parametersSelectable = true,
int  offset = 0,
int  depth = 0 
)
inline

Adds a block of parameter instances to the SAP pane in the MissionEditor.

Parameters
headerNameThe name that will be displayed at the top of this block
displayNameDisplay name on the Block as a Header
fieldsThe fields to take the information for the paramter instances to be generated
parentThe container of this parameter block (For nested blocks)
invalidGroupsThe parameter groups to be skipped in this block.
currentGroupThe current block to be displayed, if it doesnt match it will skip them. By default its empty.
parametersSelectableAre the paramters in this block selectable? (For nested blocks)
offsetThe offset of this block in the SAP pane
Returns
void Expansions.Missions.Editor.MEActionPane.CheckDeletedNodeFromGap ( MENode  node)
inline

check if GAP needs to be cleared and unlocked after the node has been deleted.

void Expansions.Missions.Editor.MEActionPane.Clean ( )
inline

Clean the action pane SAP/GAP

void Expansions.Missions.Editor.MEActionPane.ClearCache ( )
inline

Clears the parameter cache, destroying all the cached parameters prefabs

void Expansions.Missions.Editor.MEActionPane.CurrentLockdeNode ( MENode  node)
inline

Store current node when the locked parameter is active

Parameters
node
void Expansions.Missions.Editor.MEActionPane.DisplayModuleFooter ( string  name,
BaseAPFieldList  fields 
)
inlineprotected

Displays a footer parameter in the SAP, this connects to the IMENodeDisplay interface to get the list of available parameters

Parameters
name
fields
MEGUIParameterGroup Expansions.Missions.Editor.MEActionPane.DisplayModuleHeader ( string  name,
string  displayName,
BaseAPFieldList  fields,
Transform  parent 
)
inline

Displays a module section header in the SAP, this is used as a separator

Parameters
name
fields
void Expansions.Missions.Editor.MEActionPane.DisplayNodeModuleSection ( IMENodeDisplay  module)
inlineprotected

Display the fields/properties of the IMENodeDisplay module in the SAP

Parameters
module
void Expansions.Missions.Editor.MEActionPane.DisplayNodeSettingsSection ( MENode  node)
inlineprotected

Display the basic nodes settings in the SAP

Parameters
node
MEGUIParameter Expansions.Missions.Editor.MEActionPane.DisplayParameter ( BaseAPField  field,
Transform  parent,
bool  isSelectable 
)
inlineprotected

Displays a basefield in the SAP

Parameters
fieldField or property to be displayed
T Expansions.Missions.Editor.MEActionPane.GAPInitialize< T > ( )
inline

Initialize or gets the reference to a GAP display

Template Parameters
T
Returns
Type Constraints
T :ActionPaneDisplay 
TMPro.TMP_InputField Expansions.Missions.Editor.MEActionPane.GetNextInputTabStop ( bool  direction)
inline

We check the next or previus field we want to tab to

Parameters
direction
Returns
MEGUIParameter Expansions.Missions.Editor.MEActionPane.GetParameterFromFieldID ( string  fieldID)
inline

Gets a parameter from the provided field id

Parameters
fieldID
Returns
void Expansions.Missions.Editor.MEActionPane.InitializeGapMinHeight ( )
inline

Called when MissionBuilder starts and when the cache is cleaned.

void Expansions.Missions.Editor.MEActionPane.OnGAPLockValueChange ( bool  value)
inlineprotected

The actions that occur when the GAP Lock UI is toggled

Parameters
value
void Expansions.Missions.Editor.MEActionPane.RemoveParameterGroup ( string  group)
inline

Removes parameters from the currently selected Node

Parameters
groupUsed to look up for the Group parameters in any MEGUIParameter
void Expansions.Missions.Editor.MEActionPane.SAPDisplayConnectorParameters ( MEGUIConnector  connector)
inline

Displays the node connector parameters in the SAP

Parameters
connector
void Expansions.Missions.Editor.MEActionPane.SAPDisplayMultipleSelectedItemsMessage ( int  nodesSelected,
string  itemName 
)
inline
void Expansions.Missions.Editor.MEActionPane.SAPDisplayNodeParameters ( MEGUINode  node)
inline

Displays the node parameters in the SAP

Parameters
nodeNode to be displayed
void Expansions.Missions.Editor.MEActionPane.SAPRefreshNodeParameters ( )
inline

Refreshes the node parameters displayed in the SAP

void Expansions.Missions.Editor.MEActionPane.SavePreferedGapSize ( )
inline

This method checks that the gap cannot be minimized less than it's minimum height size

void Expansions.Missions.Editor.MEActionPane.ScrollBar ( float  value)
inline
void Expansions.Missions.Editor.MEActionPane.ScrollPanel ( float  height)
inline
void Expansions.Missions.Editor.MEActionPane.UpdateSAPScroll ( UnityEngine.EventSystems.PointerEventData  pointerData)
inline

A pass through method to scroll the SAP window from other sources

Parameters
pointerDataThe mouse data using the scroll focus

Member Data Documentation

Transform Expansions.Missions.Editor.MEActionPane.cacheTmpLocation
protected
Dictionary<string, MEGUIParameter> Expansions.Missions.Editor.MEActionPane.currentParameterCache
protected
MEActionPane Expansions.Missions.Editor.MEActionPane.fetch
static
MEGUIFooterAdditionalButton Expansions.Missions.Editor.MEActionPane.FooterAdditionalButtonPrefab
IconLoader Expansions.Missions.Editor.MEActionPane.gapIconLoader
GameObject Expansions.Missions.Editor.MEActionPane.gapIconLoaderPrefab
protected
Toggle Expansions.Missions.Editor.MEActionPane.gapLockToggle

GAP lock toggle control

MEGUIPanel Expansions.Missions.Editor.MEActionPane.GAPPanel
Dictionary<MonoBehaviour, Dictionary<string, MEGUIParameter> > Expansions.Missions.Editor.MEActionPane.parameterCache
protected
MEGUIParameterGroup Expansions.Missions.Editor.MEActionPane.ParameterGroupPrefab
MEGUIPanel Expansions.Missions.Editor.MEActionPane.SAPPanel

Property Documentation

ActionPaneDisplay Expansions.Missions.Editor.MEActionPane.CurrentGapDisplay
getset

Current active GAP display

bool Expansions.Missions.Editor.MEActionPane.IsGAPLocked
getset

Returns if the GAP display is locked Note. this does not affect the parameter focus/selection behaviour

MEGUIParameter Expansions.Missions.Editor.MEActionPane.SelectedSAPParameter
getset

Currently selected parameter in the SAP, this parameter controls the GAP display


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