Interface IGameConfigurationExtensionProvider

Provides the IGameConfigurationExtension for a IGame, and exposes database-level methods that are not specific to a certain IGame instance.

Inherited Members

IGameExtensionProvider<IGameConfigurationExtension>.MakeExtension(IGameRecord)

Namespace: Snowflake.Model.Game.LibraryExtensions

Assembly: Snowflake.Framework.Primitives.dll

Syntax

public interface IGameConfigurationExtensionProvider : IGameExtensionProvider<IGameConfigurationExtension>, IGameExtensionProvider

Methods

DeleteProfile(Guid)

Deletes the profile with the given valueCollectionGuid

Declaration

void DeleteProfile(Guid valueCollectionGuid)

Parameters

Type	Name	Description
System.Guid	valueCollectionGuid	The unique GUID of the configuration profile.

DeleteProfileAsync(Guid)

Asynchronously deletes the profile with the given valueCollectionGuid

Declaration

Task DeleteProfileAsync(Guid valueCollectionGuid)

Parameters

Type	Name	Description
System.Guid	valueCollectionGuid	The unique GUID of the configuration profile.

Returns

Type	Description
System.Threading.Tasks.Task

GetOwningValueCollection(Guid)

Gets the Guid of the value collection of the value in the in the database with the given valueGuid.

Declaration

Guid GetOwningValueCollection(Guid valueGuid)

Parameters

Type	Name	Description
System.Guid	valueGuid	The unique GUID of the configuration value to update.

Returns

Type	Description
System.Guid

GetOwningValueCollectionAsync(Guid)

Gets the Guid of the value collection of the value in the in the database with the given valueGuid asynchronously.

Declaration

Task<Guid> GetOwningValueCollectionAsync(Guid valueGuid)

Parameters

Type	Name	Description
System.Guid	valueGuid	The unique GUID of the configuration value to update.

Returns

Type	Description
System.Threading.Tasks.Task<System.Guid>

GetProfile<T>(Guid)

Gets the IConfigurationCollection<T> configuration profile with the given valueCollectionGuid

Declaration

IConfigurationCollection<T> GetProfile<T>(Guid valueCollectionGuid)

    where T : class, IConfigurationCollection<T>

Parameters

Type	Name	Description
System.Guid	valueCollectionGuid	The unique GUID of the configuration profile.

Returns

Type	Description
IConfigurationCollection<T>	The IConfigurationCollection<T> with the given GUID.

Type Parameters

Name	Description
T	The configuration collection prototype.

GetProfileAsync<T>(Guid)

Asynchronously gets the IConfigurationCollection<T> configuration profile with the given valueCollectionGuid

Declaration

Task<IConfigurationCollection<T>> GetProfileAsync<T>(Guid valueCollectionGuid)

    where T : class, IConfigurationCollection<T>

Parameters

Type	Name	Description
System.Guid	valueCollectionGuid	The unique GUID of the configuration profile.

Returns

Type	Description
System.Threading.Tasks.Task<IConfigurationCollection<T>>	The IConfigurationCollection<T> with the given GUID.

Type Parameters

Name	Description
T	The configuration collection prototype.

UpdateProfile(IConfigurationCollection)

Updates the entire IConfigurationCollection. Notice this method is type-agnostic and ignores the prototype of the IConfigurationCollection.

Declaration

void UpdateProfile(IConfigurationCollection profile)

Parameters

Type	Name	Description
IConfigurationCollection	profile	The configuration collection to update.

UpdateProfileAsync(IConfigurationCollection)

Updates the entire IConfigurationCollection. Notice this method is type-agnostic and ignores the prototype of the IConfigurationCollection.

Declaration

Task UpdateProfileAsync(IConfigurationCollection profile)

Parameters

Type	Name	Description
IConfigurationCollection	profile	The configuration collection to update.

Returns

Type	Description
System.Threading.Tasks.Task

UpdateValue(IConfigurationValue)

Updates the given IConfigurationValue.

Declaration

void UpdateValue(IConfigurationValue newValue)

Parameters

Type	Name	Description
IConfigurationValue	newValue	The new IConfigurationValue. A value with the same Guid must be present in the database, this is ensured if the value came from an existing IConfigurationCollection<T>.

UpdateValue(Guid, Object)

Updates the IConfigurationValue in the database with the given valueGuid and gives it the value newValue.

Declaration

void UpdateValue(Guid valueGuid, object newValue)

Parameters

Type	Name	Description
System.Guid	valueGuid	The unique GUID of the configuration value to update.
System.Object	newValue	The new value of the configuration value.

UpdateValueAsync(IConfigurationValue)

Asychronously updates the given IConfigurationValue.

Declaration

Task UpdateValueAsync(IConfigurationValue newValue)

Parameters

Type	Name	Description
IConfigurationValue	newValue	The new IConfigurationValue. A value with the same Guid must be present in the database, this is ensured if the value came from an existing IConfigurationCollection<T>.

Returns

Type	Description
System.Threading.Tasks.Task

UpdateValueAsync(Guid, Object)

Asynchronously updates the IConfigurationValue in the database with the given valueGuid and gives it the value newValue.

Declaration

Task UpdateValueAsync(Guid valueGuid, object newValue)

Parameters

Type	Name	Description
System.Guid	valueGuid	The unique GUID of the configuration value to update.
System.Object	newValue	The new value of the configuration value.

Returns

Type	Description
System.Threading.Tasks.Task