Class PropertyAttribute

Attribute used to annotate task properties.

Inheritance

Object

Attribute

PropertyAttribute

Namespace: Unity.Kinematica

Syntax

[AttributeUsage(AttributeTargets.Field)]
public class PropertyAttribute : Attribute, _Attribute

Remarks

Tasks can optionally have properties than be read from or written to by user code. In order to display these properties as editable fields in the corresponding task graph visualization the property attribute can be used.

public struct TimerTask : Task
{
    [Property]
    float timeInSeconds;
}

Constructors

PropertyAttribute(String)

Constructs a property attribute with the name passed as argument.

Declaration

public PropertyAttribute(string name = null)

Parameters

Type	Name	Description
String	name	Name that is to be used for the property.

Remarks

By default the type name is used for display purposes. Alternatively, an override name can be passed to the property attribute constructor.

See Also

Task