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

Public Member Functions

void CreateFlowStartNodes (MENode startNode, Transform parent, int colorIndex=-1)
 
void CreateFlowUIBlock (IMEFlowBlock start, Transform parent, int colorIndex=-1)
 
void CreateMissionFlowUI_Button (Mission mission, MEFlowUINode.ButtonAction buttonAction=MEFlowUINode.ButtonAction.None, Callback< PointerEventData > buttonCallback=null, bool showEvents=false, bool showNonObjectives=false, bool showStartNodes=false)
 
void CreateMissionFlowUI_Toggle (Mission mission, Callback< MEFlowUINode > toggleCallback, ToggleGroup toggleGroup, bool showEvents=false, bool showNonObjectives=false, bool showStartNodes=false)
 
void UpdateFlowUIItems ()
 Tell the parser to update the UI for its current mission ref More...
 
void UpdateFlowUIItems (IMEFlowBlock start)
 Tell the parser to update the UI for the passed block More...
 

Static Public Member Functions

static MEFlowParser Create (Transform parent, Transform flowObjectsParent, TMP_Text emptyObjectivesMessage)
 Instantiates an Instance of MEFlowParser and sets it's parent Transform More...
 
static MEFlowParser Create (Transform parent, Transform flowObjectsParent, TMP_Text emptyObjectivesMessage, Color[] groupColors)
 Instantiates an Instance of MEFlowParser and sets it's parent Transform More...
 
static MEFlowBlock ParseMission (Mission mission)
 Convert a Mission object into an MEFLowBlock which can then be used for rendering visuals More...
 

Public Attributes

Color[] GroupColors
 
bool showEvents = false
 True to show event objectives or things behind them More...
 
bool showNonObjectives = false
 Should the parser show all nodes regardless of objective flags, etc More...
 

Member Function Documentation

static MEFlowParser Expansions.Missions.Flow.MEFlowParser.Create ( Transform  parent,
Transform  flowObjectsParent,
TMP_Text  emptyObjectivesMessage 
)
inlinestatic

Instantiates an Instance of MEFlowParser and sets it's parent Transform

Parameters
parentThe parent transform to attach the instance to
flowObjectsParentThe transform to attach MEFLow Objects to
emptyObjectivesMessageThe object to display if there are no objectives in the flow - pass Null to not use this
Returns
The MEFlowParser instance
static MEFlowParser Expansions.Missions.Flow.MEFlowParser.Create ( Transform  parent,
Transform  flowObjectsParent,
TMP_Text  emptyObjectivesMessage,
Color[]  groupColors 
)
inlinestatic

Instantiates an Instance of MEFlowParser and sets it's parent Transform

Parameters
parentThe parent transform to attach the instance to
flowObjectsParentThe transform to attach MEFLow Objects to
emptyObjectivesMessageThe object to display if there are no objectives in teh flow
groupColorsOptional list of colors for the groups (if null uses presets)
Returns
The MEFlowParser instance
void Expansions.Missions.Flow.MEFlowParser.CreateFlowStartNodes ( MENode  startNode,
Transform  parent,
int  colorIndex = -1 
)
inline

Parameters
startNode
parent
colorIndex
buttonAction
buttonCallback
void Expansions.Missions.Flow.MEFlowParser.CreateFlowUIBlock ( IMEFlowBlock  start,
Transform  parent,
int  colorIndex = -1 
)
inline
void Expansions.Missions.Flow.MEFlowParser.CreateMissionFlowUI_Button ( Mission  mission,
MEFlowUINode.ButtonAction  buttonAction = MEFlowUINode.ButtonAction.None,
Callback< PointerEventData >  buttonCallback = null,
bool  showEvents = false,
bool  showNonObjectives = false,
bool  showStartNodes = false 
)
inline
void Expansions.Missions.Flow.MEFlowParser.CreateMissionFlowUI_Toggle ( Mission  mission,
Callback< MEFlowUINode toggleCallback,
ToggleGroup  toggleGroup,
bool  showEvents = false,
bool  showNonObjectives = false,
bool  showStartNodes = false 
)
inline
static MEFlowBlock Expansions.Missions.Flow.MEFlowParser.ParseMission ( Mission  mission)
inlinestatic

Convert a Mission object into an MEFLowBlock which can then be used for rendering visuals

Parameters
missionThe mission to parse
Returns
MEFlowBlock representation of the mission
void Expansions.Missions.Flow.MEFlowParser.UpdateFlowUIItems ( )
inline

Tell the parser to update the UI for its current mission ref

void Expansions.Missions.Flow.MEFlowParser.UpdateFlowUIItems ( IMEFlowBlock  start)
inline

Tell the parser to update the UI for the passed block

Parameters
startThe block to update the elements in

Member Data Documentation

Color [] Expansions.Missions.Flow.MEFlowParser.GroupColors
bool Expansions.Missions.Flow.MEFlowParser.showEvents = false

True to show event objectives or things behind them

bool Expansions.Missions.Flow.MEFlowParser.showNonObjectives = false

Should the parser show all nodes regardless of objective flags, etc


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