Class SharedConfig

Namespace

MonkeyLoader.Resonite.Configuration

Assembly

MonkeyLoader.Resonite.Integration.dll

Contains constants and helper methods to work with ConfigKeySessionShare<T>.

public static class SharedConfig

Inheritance

object

SharedConfig

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Fields

Identifier

The name of the shared config slot in a FrooxEngine.World's Assets FrooxEngine.Slot.

public const string Identifier = "MonkeyLoader.SharedConfig"

Field Value

string

WriteBackPrefix

The prefix for the SetValue eventLabel used when the cause is a change in a FrooxEngine.World's shared value.

public const string WriteBackPrefix = "SharedConfig.WriteBack"

Field Value

string

Remarks

The actually passed label has the following format: $"{WriteBackPrefix}.{field.FrooxEngine.World.GetIdentifier()}"

Methods

GetIdentifier(World)

Gets the FrooxEngine.World.SessionId or the FrooxEngine.World.Name to use with the WriteBackPrefix.

public static string GetIdentifier(this World world)

Parameters

world World

The world to get the identifier for.

Returns

string

A string identifying the world.

GetSharedConfigSlot(World)

Gets the SharedConfig FrooxEngine.Slot in a FrooxEngine.World's Assets slot.

public static Slot GetSharedConfigSlot(this World world)

Parameters

world World

The FrooxEngine.World to get the FrooxEngine.Slot for.

Returns

Slot

The SharedConfig slot for the given world.

GetSharedConfigSlot(World, IConfigOwner)

Gets the given config owner's FrooxEngine.Slot under the SharedConfig slot.

public static Slot GetSharedConfigSlot(this World world, IConfigOwner configOwner)

Parameters

world World

The FrooxEngine.World to get the FrooxEngine.Slot for.

configOwner IConfigOwner

The config owner to get the FrooxEngine.Slot for.

Returns

Slot

The config owner's SharedConfig slot for the given world.

MakeShared<T>(IEntity<IDefiningConfigKey<T>>, T?, bool)

Wraps the given IDefiningConfigKey<T> in a ConfigKeySessionShare<T>, to make its local value available as a shared resource in Resonite sessions, and optionally allow writing back changes from the session to the config item.

public static IDefiningConfigKey<T> MakeShared<T>(this IEntity<IDefiningConfigKey<T>> definingKey, T? defaultValue = default, bool allowWriteBack = false)

Parameters

definingKey IEntity<IDefiningConfigKey<T>>

The defining key to wrap.

defaultValue T

The default value for the shared config item for users that don't have it themselves.

allowWriteBack bool

Whether to allow writing back changes from the session to the config item.

Returns

IDefiningConfigKey<T>

The wrapped defining key.

Type Parameters

T

The type of the config item's value.

MakeShared<TKey, TShared>(IEntity<IDefiningConfigKey<TKey>>, Converter<TKey?, TShared?>, Converter<TShared?, TKey?>, TKey?, bool)

Wraps the given IDefiningConfigKey<T> in a ConfigKeySessionShare<T>, to make its local value available as a shared resource in Resonite sessions, and optionally allow writing back changes from the session to the config item.

public static IDefiningConfigKey<TKey> MakeShared<TKey, TShared>(this IEntity<IDefiningConfigKey<TKey>> definingKey, Converter<TKey?, TShared?> convertToShared, Converter<TShared?, TKey?> convertToKey, TKey? defaultValue = default, bool allowWriteBack = false)

Parameters

definingKey IEntity<IDefiningConfigKey<TKey>>

The defining key to wrap.

convertToShared Converter<TKey, TShared>

Converts the config item's value to the shared resource's.

convertToKey Converter<TShared, TKey>

Converts the shared resource's value to the config item's.

defaultValue TKey

The default value for the shared config item for users that don't have it themselves.

allowWriteBack bool

Whether to allow writing back changes from the session to the config item.

Returns

IDefiningConfigKey<TKey>

The wrapped defining key.

Type Parameters

TKey

The type of the config item's value.

TShared

The type of the resource shared in Resonite FrooxEngine.Worlds. Must be a valid generic parameter for FrooxEngine.ValueField<T> components.

TryGetWorldIdentifier(IConfigKeyChangedEventArgs, out string?)

Determines whether the IConfigKeyChangedEventArgs were caused by a change in a FrooxEngine.World's shared value, and extracts the World Identifier from the Label if so.

public static bool TryGetWorldIdentifier(this IConfigKeyChangedEventArgs configKeyChangedEventArgs, out string? worldIdentifier)

Parameters

configKeyChangedEventArgs IConfigKeyChangedEventArgs

The event args of the change.

worldIdentifier string

The extracted World Identifier or null.

Returns

bool

true if the event was caused by a change in a FrooxEngine.World's shared value; otherwise, false.