Class ConfigKeyCustomDataFeedItems<T>

Namespace

MonkeyLoader.Resonite.Configuration

Assembly

MonkeyLoader.Resonite.Integration.dll

Represents a basic config key component which generate FrooxEngine.DataFeedItems for the config key to represent themselves, rather than requiring default handling.

public abstract class ConfigKeyCustomDataFeedItems<T> : IConfigKeyCustomDataFeedItems<T>, IConfigKeyComponent<IDefiningConfigKey<T>>, IComponent<IDefiningConfigKey<T>>, ICustomDataFeedItems

Type Parameters

T

Inheritance

object

ConfigKeyCustomDataFeedItems<T>

Implements

IConfigKeyCustomDataFeedItems<T>

IConfigKeyComponent<IDefiningConfigKey<T>>

IComponent<IDefiningConfigKey<T>>

ICustomDataFeedItems

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

ConfigKey

Gets the config item that FrooxEngine.DataFeedItems will be generated for.

public IDefiningConfigKey<T> ConfigKey { get; }

Property Value

IDefiningConfigKey<T>

Methods

Enumerate(IReadOnlyList<string>, IReadOnlyList<string>, string?, object?)

Enumerates the FrooxEngine.DataFeedItems that represent this object.

public abstract IAsyncEnumerable<DataFeedItem> Enumerate(IReadOnlyList<string> path, IReadOnlyList<string> groupKeys, string? searchPhrase, object? viewData)

Parameters

path IReadOnlyList<string>

The path for this enumeration request.

groupKeys IReadOnlyList<string>

The group keys for this enumeration request.

searchPhrase string

The search phrase for this enumeration request.

viewData object

The custom view data for this enumeration request.

Returns

IAsyncEnumerable<DataFeedItem>

An async sequence of FrooxEngine.DataFeedItems that represents this object.

OnInitialize(IDefiningConfigKey<T>)

Initializes this component when it's added to an entity's component list.
This may throw a InvalidOperationException when the state of the given entity is invalid for this component.

protected virtual void OnInitialize(IDefiningConfigKey<T> entity)

Parameters

entity IDefiningConfigKey<T>

The entity this component was added to.

Remarks

The ConfigKey property is already initialized when this is called.

Exceptions

InvalidOperationException

When the state of the given entity is invalid.