API reference

FeatureDescription Class

Constructors

FeatureDescription ( shortDescription , description , minValueHint , maxValueHint , featureStates )
Signature
FeatureDescription(string shortDescription, string description, float minValueHint, float maxValueHint, FeatureStateDescription[] featureStates)
Parameters
shortDescription: string
description: string
minValueHint: float
maxValueHint: float
featureStates: FeatureStateDescription[]

Properties

Description : string
[Get]
Signature
string Description
FeatureStates : FeatureStateDescription[]
[Get]
A hint to the editor on which feature states to provide by default, and in which order they should appear.
The underlying system will accept other ranges; this is just for the UI.
Signature
FeatureStateDescription [] FeatureStates
MaxValueHint : float
[Get]
Signature
float MaxValueHint
MinValueHint : float
[Get]
Signature
float MinValueHint
ShortDescription : string
[Get]
Signature
string ShortDescription