Class StaticDefaultValueMetadata<T>

Namespace

Stride.Core

Assembly

Stride.Core.dll

Defines default value of a specific PropertyKey as a parameter value.

public class StaticDefaultValueMetadata<T> : DefaultValueMetadata<T>

Type Parameters

T

Inheritance

object

PropertyKeyMetadata

DefaultValueMetadata

DefaultValueMetadata<T>

StaticDefaultValueMetadata<T>

Inherited Members

DefaultValueMetadata<T>.GetDefaultValue(ref PropertyContainer)

DefaultValueMetadata.PropertyUpdateCallback

DefaultValueMetadata.Static<T>(T, bool)

DefaultValueMetadata.Delegate<T>(DelegateDefaultValueMetadata<T>.DefaultValueCallback)

Constructors

StaticDefaultValueMetadata(T, bool)

Initializes a new instance of the StaticDefaultValueMetadata<T> class.

public StaticDefaultValueMetadata(T defaultValue, bool keepDefaultValue = false)

Parameters

defaultValue T

The default value.

keepDefaultValue bool

if set to true [keep default value].

Properties

KeepValue

Gets a value indicating whether this value is kept.

public override bool KeepValue { get; }

Property Value

bool

true if this value is kept; otherwise, false.

Methods

GetDefaultValueT(ref PropertyContainer)

Gets the default value of an external property, and specify if this default value should be kept. It could be usefull with properties with default values depending of its container, especially if they are long to generate. An example would be collision data, which should be generated only once.

public override T GetDefaultValueT(ref PropertyContainer obj)

Parameters

obj PropertyContainer

The property container.

Returns

T

The default value.