Version: Unity 6.4 Alpha (6000.4)
LanguageEnglish
  • C#

IPort.TryGetValue

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Declaration

public bool TryGetValue(out T value);

Parameters

Parameter Description
value When successful, contains the value assigned to the port’s field.

Returns

bool true if the port is not connected and a field value is available; otherwise, false.

Description

Tries to retrieve the current value assigned to the port’s UI field.

This method is intended for editor-time inspection of an input port’s value, configured through a field displayed in the UI. If the port is connected, the field is hidden and no value is available, so the method returns false. If the value was never explicitly set, this method still returns true, and will contain the default value for type T.