Interface IAvatarCollection

A collection of avatar objects with their sources. Used to separate avatars thematically and for easier management of a large amounts of avatars. A whole collection can be unlocked for the player, as well as individual avatars within it. The containing IAvatarCollection must be Unlocked and Obtained for the player to unlock individual Avatars.

Inherited Members
Namespace: IdleKit.Gameplay
Assembly: cs.temp.dll.dll
Syntax
public interface IAvatarCollection : IEntity, IInjectable, IUnlockable

Properties

AvatarCollectionData

Associated IEntityData for this avatar collection.

Declaration
IAvatarCollectionData AvatarCollectionData { get; }
Property Value
Type Description
IAvatarCollectionData

AvatarCollectionSavedData

Associated ISavedData for this avatar collection. Contains information about avatars unlocked for player use.

Declaration
IAvatarCollectionSavedData AvatarCollectionSavedData { get; }
Property Value
Type Description
IAvatarCollectionSavedData

Methods

ContainsAvatar(String)

Checks whether the avatar with the provided is contained within this IAvatarCollection.

Declaration
bool ContainsAvatar(string avatarId)
Parameters
Type Name Description
String avatarId
Returns
Type Description
Boolean

GetAvatarTitle(String)

Returns Title of an Avatar.

Declaration
string GetAvatarTitle(string avatarId)
Parameters
Type Name Description
String avatarId
Returns
Type Description
String

GetUnlockedAvatars()

Returns all inside of this collection, which have been unlocked by the player.

Declaration
Avatar[] GetUnlockedAvatars()
Returns
Type Description
Avatar[]

LockAvatar(String)

Restricts player's access to the avatar with the provided .

Declaration
void LockAvatar(string avatarId)
Parameters
Type Name Description
String avatarId

UnlockAvatar(String)

Records the provided as available to the player.

Declaration
void UnlockAvatar(string avatarId)
Parameters
Type Name Description
String avatarId