IBM.Watson.DeveloperCloud.Widgets.Widget.Output Class Reference

This object handles output on a widget. More...

Classes
class	Connection
	The connection between widgets. More...

Public Member Functions
	Output (Type dataType, bool allowMany=false)
	The constructor for an widget output object. More...
override string	ToString ()
	<exclude> More...
virtual void	Start (Widget owner)
	Starts this Output. More...
virtual bool	SendData (Data data)
	Sends a data object to the target of this output. More...
bool	AddConnection (Input input)
	Add a connection to this output, returns false if the connection can't be made. More...
bool	AddConnection (GameObject targetObject, string targetConnection=null)
	Add a connect to a given object and optional target input. More...
bool	RemoveConnection (Connection c)
	Remove the connection between widgets. More...

Properties
bool	IsConnected [get]
	Returns true if this output is connected to a input. More...
Connection[]	Connections [get]
	Connections between widgets. More...
Widget	Owner [get, set]
	Returns a reference to the Widget owner, this is set when the Widget initializes. More...
Type	DataType [get, set]
	The type of data this output sends. More...
bool	AllowMany [get]
	If true, allows more than one input to be connected to this output. More...
OnInputAdded	OnInputAdded [get, set]
	Gets or sets the on input added callback More...
OnInputRemoved	OnInputRemoved [get, set]
	Gets or sets the on input removed callback More...

Detailed Description

This object handles output on a widget.

Constructor & Destructor Documentation

IBM.Watson.DeveloperCloud.Widgets.Widget.Output.Output ( Type  dataType, bool  allowMany = false  )

inline

The constructor for an widget output object.

Parameters

dataType	The type of data this widget outputs.
allowMany	If true, then this output will connect to more than one input.

Member Function Documentation

bool IBM.Watson.DeveloperCloud.Widgets.Widget.Output.AddConnection ( Input  input )

inline

Add a connection to this output, returns false if the connection can't be made.

Parameters

input

A reference to the connection to establish.

Returns

Returns true on success.

bool IBM.Watson.DeveloperCloud.Widgets.Widget.Output.AddConnection ( GameObject  targetObject, string  targetConnection = null  )

inline

Add a connect to a given object and optional target input.

Parameters

targetObject	The object to target.
targetConnection	A optional argument of the target input on the object.

Returns

Returns true if a Connection object was added.

bool IBM.Watson.DeveloperCloud.Widgets.Widget.Output.RemoveConnection ( Connection  c )

inline

Remove the connection between widgets.

Parameters

c

Returns

virtual bool IBM.Watson.DeveloperCloud.Widgets.Widget.Output.SendData ( Data  data )

inlinevirtual

Sends a data object to the target of this output.

Parameters

data	Data object to send.

Returns

Returns true if the data was sent to another widget.

virtual void IBM.Watson.DeveloperCloud.Widgets.Widget.Output.Start ( Widget  owner )

inlinevirtual

Starts this Output.

Parameters

owner

The Widget owner of this Output.

override string IBM.Watson.DeveloperCloud.Widgets.Widget.Output.ToString ( )

inline

<exclude>

Property Documentation

bool IBM.Watson.DeveloperCloud.Widgets.Widget.Output.AllowMany

get

If true, allows more than one input to be connected to this output.

Connection [] IBM.Watson.DeveloperCloud.Widgets.Widget.Output.Connections

get

Connections between widgets.

Type IBM.Watson.DeveloperCloud.Widgets.Widget.Output.DataType

getset

The type of data this output sends.

bool IBM.Watson.DeveloperCloud.Widgets.Widget.Output.IsConnected

get

Returns true if this output is connected to a input.

OnInputAdded IBM.Watson.DeveloperCloud.Widgets.Widget.Output.OnInputAdded

getset

Gets or sets the on input added callback

The on input added.

OnInputRemoved IBM.Watson.DeveloperCloud.Widgets.Widget.Output.OnInputRemoved

getset

Gets or sets the on input removed callback

The on input removed.

Widget IBM.Watson.DeveloperCloud.Widgets.Widget.Output.Owner

getset

Returns a reference to the Widget owner, this is set when the Widget initializes.

---

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

• Scripts/Widgets/Widget.cs