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

IPortBuilder<T0>.WithDisplayName

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 T WithDisplayName(string displayName);

Parameters

Parameter Description
displayName The display name to assign to the port.

Returns

T The current builder instance for method chaining.

Description

Configures the display name of the port being built.

Use this method to assign a custom label to the port. This label appears in the user interface next to the port and helps clarify its purpose. Set the display name before calling Build. The value does not affect functionality but improves usability and readability. If not set, the port name passed during creation (see: Node.IPortDefinitionContext.AddInputPort and Node.IPortDefinitionContext.AddOutputPort) is used as the fallback display name.