Description

Definition

Text which is used on the UI’s information box to be displayed to a user when configuring a NinjaScript object.

Method Return Value

A string value representing text used to describe the object.

Warning: This property should ONLY be set from the OnStateChange() method during State.SetDefaults or State.Configure.

Syntax

Description

Examples

1 protected override void OnStateChange()
2 {
3    if (State == State.SetDefaults)
4    {
5      Name = "Examples Indicator";
6      Description = @"An indicator used to demonstrate various NinjaScript methods and properties";
7    }
8 }