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

Public Member Functions

int CompareTo (MEGUINodeIcon other)
 
void OnBeginDrag (PointerEventData eventData)
 OnBeginDrag is called when the user starts a drag to drop an icon on the mission editor canvas. It creates the new node to be placed. More...
 
void OnDrag (PointerEventData eventData)
 OnDrag is called every frame the user continues to drag the new node. More...
 
void OnEndDrag (PointerEventData eventData)
 OnEndDrag is called when the user lets go of the mouse button when dragging a node to place on the mission editor canvas. It places the new node on the canvas More...
 
void OnPointerClick (PointerEventData eventData)
 Implements the IPointerClickHandler event. More...
 
void OnPointerEnter (PointerEventData eventData)
 
void OnPointerExit (PointerEventData eventData)
 
void ResetCanvasSetting ()
 Reset the flag for if this Node is on the cavas or not to false. More...
 
void SetHighlighterColor (Color newColor)
 Set the Highlighter color More...
 
void SetUp (MEBasicNode newBasicNode, Icon icon)
 Setup a new basic Node Icon More...
 
void SetUp (MEBasicNode newBasicNode, Icon icon, MEGUINode meguicanvasNode)
 Setup a new basic Node Icon More...
 
void ToggleHighlighter (bool state)
 Toggle the highlighter visibility to that passed in More...
 

Public Attributes

Image backgroundImage
 
MEBasicNode basicNode
 Basic node that will be used to create the node that gets dropped on the convas. More...
 
bool IsInteractable
 Change to Toggle the interactability of a node icon. More...
 
RawImage nodeImage
 Image displayed to represent the node. More...
 
TextMeshProUGUI nodeText
 Text displayed on the node icon. More...
 

Properties

MEGUINode CanvasMEGUINode [get]
 This is the MEGUINode on the canvas if there is one. More...
 
bool IsCanvasNode [get]
 True if this NodeIcon represents an instance of the Node on the Canvas More...
 

Member Function Documentation

int Expansions.Missions.Editor.MEGUINodeIcon.CompareTo ( MEGUINodeIcon  other)
inline
void Expansions.Missions.Editor.MEGUINodeIcon.OnBeginDrag ( PointerEventData  eventData)
inline

OnBeginDrag is called when the user starts a drag to drop an icon on the mission editor canvas. It creates the new node to be placed.

Parameters
eventData
void Expansions.Missions.Editor.MEGUINodeIcon.OnDrag ( PointerEventData  eventData)
inline

OnDrag is called every frame the user continues to drag the new node.

It is only called when the position of the drag changes

Parameters
eventData
void Expansions.Missions.Editor.MEGUINodeIcon.OnEndDrag ( PointerEventData  eventData)
inline

OnEndDrag is called when the user lets go of the mouse button when dragging a node to place on the mission editor canvas. It places the new node on the canvas

Parameters
eventData
void Expansions.Missions.Editor.MEGUINodeIcon.OnPointerClick ( PointerEventData  eventData)
inline

Implements the IPointerClickHandler event.

Parameters
eventData
void Expansions.Missions.Editor.MEGUINodeIcon.OnPointerEnter ( PointerEventData  eventData)
inline
void Expansions.Missions.Editor.MEGUINodeIcon.OnPointerExit ( PointerEventData  eventData)
inline
void Expansions.Missions.Editor.MEGUINodeIcon.ResetCanvasSetting ( )
inline

Reset the flag for if this Node is on the cavas or not to false.

void Expansions.Missions.Editor.MEGUINodeIcon.SetHighlighterColor ( Color  newColor)
inline

Set the Highlighter color

Parameters
newColor
void Expansions.Missions.Editor.MEGUINodeIcon.SetUp ( MEBasicNode  newBasicNode,
Icon  icon 
)
inline

Setup a new basic Node Icon

Parameters
newBasicNodeThe underpinning data
iconan Icon resource for the image
void Expansions.Missions.Editor.MEGUINodeIcon.SetUp ( MEBasicNode  newBasicNode,
Icon  icon,
MEGUINode  meguicanvasNode 
)
inline

Setup a new basic Node Icon

Parameters
newBasicNodeThe underpinning data
iconan Icon resource for the image
meguicanvasNodeReference to the related MEGUINode
void Expansions.Missions.Editor.MEGUINodeIcon.ToggleHighlighter ( bool  state)
inline

Toggle the highlighter visibility to that passed in

Parameters
stateNew state

Member Data Documentation

Image Expansions.Missions.Editor.MEGUINodeIcon.backgroundImage

the image of the "button"

MEBasicNode Expansions.Missions.Editor.MEGUINodeIcon.basicNode

Basic node that will be used to create the node that gets dropped on the convas.

bool Expansions.Missions.Editor.MEGUINodeIcon.IsInteractable

Change to Toggle the interactability of a node icon.

RawImage Expansions.Missions.Editor.MEGUINodeIcon.nodeImage

Image displayed to represent the node.

TextMeshProUGUI Expansions.Missions.Editor.MEGUINodeIcon.nodeText

Text displayed on the node icon.

Property Documentation

MEGUINode Expansions.Missions.Editor.MEGUINodeIcon.CanvasMEGUINode
get

This is the MEGUINode on the canvas if there is one.

bool Expansions.Missions.Editor.MEGUINodeIcon.IsCanvasNode
get

True if this NodeIcon represents an instance of the Node on the Canvas


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