plyCommon.plyNode_Msg Class Reference
Sends a message to a GameObject More...
Inherits plyCommon.plyNode.
Public Types | |
| enum | TargetObjectType { TargetObjectType.Name, TargetObjectType.Tag, TargetObjectType.Type, TargetObjectType.Active, TargetObjectType.Self } |
| How to find the GameObject More... | |
 Public Types inherited from plyCommon.plyNode | |
| enum | ReturnCode { ReturnCode.Continue = -1, ReturnCode.WaitingForData = -2, ReturnCode.Stop = -3 } |
| Return codes used in Enter(), Update(), etc More... | |
Public Member Functions | |
| override string | PrettyName () |
| override void | OnAddedToGraph () |
| override void | CopyTo (plyNode n) |
| override int | Enter () |
| Public Member Functions inherited from plyCommon.plyNode | |
| void | Awake (plyGraph owningGraph) |
| called by graph's Awake at runtime More... | |
| void | LogError (string message) |
| show an error message that include the name of the node the error occurred in More... | |
| void | LogWarning (string message) |
| show w warning message that include the name of the node the error occurred in More... | |
| virtual int | InitOutlinkCount () |
| This should return the number of out links that the node should be initialized with when first added to the graph. More... | |
| virtual int | Update () |
| Called by graph manager as long as this node is the active one in the active graph. This will only be called if you returned ReturnCode.Continue in Enter(), causing this node to stay the active node. Returned value should be the index of next node to Enter() as per outLinks[] array or a (int)plyNode.ReturnCode More... | |
| virtual void | ReceiveData (object data) |
| Called when some data is send to the active node. This can only be called for this node if you returned ReturnCode.Continue in Enter() and did not yet return any other code in Update() More... | |
| Dictionary< string, plyMetaData > | AllMetaData () |
| List< plyMetaData > | AllMetaDataList () |
| plyMetaData | GetMetaData (string name) |
| Return reference to meta data object. Null if not found. More... | |
| object | GetMetaDataValue (string name) |
| Return meta data value. Null if named meta data not found. More... | |
| void | SetMetaDataValue (string name, object val) |
| Set meta data value. Will create the named meta data if not found and then set value. More... | |
Public Attributes | |
| TargetObjectType | targetObjType = TargetObjectType.Name |
| How to find the GameObject More... | |
| string | targetObjTypeData = "" |
| The name, tag or component type More... | |
| string | methodName = "" |
| The name of the method to call More... | |
| plyDataObject | val = new plyDataObject() |
| value to send to method More... | |
| Public Attributes inherited from plyCommon.plyNode | |
| plyNode[] | outLinks = new plyNode[0] |
| The nodes that are linked to this one's outputs More... | |
| int[] | outLinkIds = new int[0] |
| Ids of the nodes that are linked to. This and the outLinks array should always be of the same size. More... | |
| int | id = -1 |
| Unique identifier for node. Do not set this manually. The graph editor updates it as needed. More... | |
| string | customIdent = "" |
| A custom identifier you may use to identify the node by More... | |
| string | comment = "" |
| Node comment. Normally used as messages/ reminders in the graph editor More... | |
| bool | showComment = true |
| Set true if comment should appear in the graph editor More... | |
| plyMetaData[] | metaData = new plyMetaData[0] |
| Meta data is optional data/ information that the designer may associate with the node. Do not access at runtime. Use the provided functions. More... | |
| Rect | __rect = new Rect() |
| Used by editor. You may update width/ height with the node window's size but should not change x and y as that is used to track the position of the node in the graph editor. More... | |
Additional Inherited Members | |
| Properties inherited from plyCommon.plyNode | |
| int | __outlinks_offset [get, set] |
| object | __node_ed [get, set] |
| plyGraph | owningGraph [get, set] |
| The (runtime) Graph that owns this node More... | |
| Dictionary< string, plyMetaData > | runtimeMetaData [get, set] |
Detailed Description
Sends a message to a GameObject
Member Enumeration Documentation
How to find the GameObject
| Enumerator | |
|---|---|
| Name |
by its name |
| Tag |
by its tag |
| Type |
by type of component it has. expected to be unique |
| Active |
it is whatever the plyGraph.activeGO static is set to at the time |
| Self |
is the instance of the GraphManager's GameObject in the scene |
Member Data Documentation
| string plyCommon.plyNode_Msg.methodName = "" |
The name of the method to call
| TargetObjectType plyCommon.plyNode_Msg.targetObjType = TargetObjectType.Name |
How to find the GameObject
| string plyCommon.plyNode_Msg.targetObjTypeData = "" |
The name, tag or component type
| plyDataObject plyCommon.plyNode_Msg.val = new plyDataObject() |
value to send to method