Version: Unity 6.5 Alpha (6000.5)
LanguageEnglish
  • C#

IPort.TrySetValue

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 TrySetValue(T value);

Parameters

Parameter Description
value The value to assign to the port’s UI field.

Returns

bool true if the value was successfully set; otherwise, false.

Description

Sets a new value to the port's UI field.

This method is intended for editor-time edition 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. It also performs a type check and conversion internally. If the value cannot be cast to IPort.DataType, the method returns false.