Class DefaultValueMetadata

Namespace

Stride.Core

Assembly

Stride.Core.dll

Abstract class that could be overloaded in order to define how to get default value of an PropertyKey.

public abstract class DefaultValueMetadata : PropertyKeyMetadata

Inheritance

object

PropertyKeyMetadata

DefaultValueMetadata

Derived

DefaultValueMetadata<T>

Properties

KeepValue

Gets a value indicating whether this value is kept.

public virtual bool KeepValue { get; }

Property Value

bool

true if this value is kept; otherwise, false.

PropertyUpdateCallback

Gets or sets the property update callback.

public PropertyContainer.PropertyUpdatedDelegate? PropertyUpdateCallback { get; set; }

Property Value

PropertyContainer.PropertyUpdatedDelegate

The property update callback.

Methods

Delegate<T>(DefaultValueCallback)

public static DelegateDefaultValueMetadata<T> Delegate<T>(DelegateDefaultValueMetadata<T>.DefaultValueCallback callback)

Parameters

callback DelegateDefaultValueMetadata<T>.DefaultValueCallback

Returns

DelegateDefaultValueMetadata<T>

Type Parameters

T

GetDefaultValue(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 abstract object GetDefaultValue(ref PropertyContainer obj)

Parameters

obj PropertyContainer

The property container.

Returns

object

The default value.

Static<T>(T, bool)

public static StaticDefaultValueMetadata<T> Static<T>(T defaultValue, bool keepDefaultValue = false)

Parameters

defaultValue T

keepDefaultValue bool

Returns

StaticDefaultValueMetadata<T>

Type Parameters

T