Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


IOptionBuilder

Interface used to build and configure node options in a fluent manner.
Read time 1 minuteLast updated 6 days ago

Definition

public interface IOptionBuilder

Remarks

Provided by the Node.IOptionDefinitionContext in a node's Node.OnDefineOptions method.

Examples

protected override void OnDefineOptions(IOptionDefinitionContext context){ context.AddOption("MyOption", typeof(int))) .WithDefaultValue(2) .Delayed();}

Methods

Method

Description

AsTextAreaConfigures the option to use the TextAreaAttribute.
BuildBuilds and returns the final INodeOption instance based on the current configuration of the builder.
DelayedConfigures the option to use the DelayedAttribute.
ShowInInspectorOnlyConfigures the option to be shown only in the inspector, not in the node header.
WithDefaultValueConfigures the default value for the option being built.
WithDisplayNameConfigures the display name of the option being built.
WithTooltipConfigures the tooltip text for the option being built.