MoreMountains.Tools.MMAchievement Class Reference

Public Member Functions
virtual void	UnlockAchievement ()
	Unlocks the achievement, asks for a save of the current achievements, and triggers an MMAchievementUnlockedEvent for this achievement.
virtual void	LockAchievement ()
	Locks the achievement.
virtual void	AddProgress (int newProgress)
	Adds the specified value to the current progress.
virtual void	SetProgress (int newProgress)
	Sets the progress to the value passed in parameter.
virtual MMAchievement	Copy ()
	Copies this achievement (useful when loading from a scriptable object list)

Public Attributes
string	AchievementID
	the unique identifier for this achievement
AchievementTypes	AchievementType
	is this achievement progress based or
bool	HiddenAchievement
	if this is true, the achievement won't be displayed in a list
bool	UnlockedStatus
	if this is true, the achievement has been unlocked. Otherwise, it's still up for grabs
string	Title
	the achievement's name/title
string	Description
	the achievement's description
int	Points
	the amount of points unlocking this achievement gets you
Sprite	LockedImage
	the image to display while this achievement is locked
Sprite	UnlockedImage
	the image to display when the achievement is unlocked
AudioClip	UnlockedSound
	a sound to play when the achievement is unlocked
int	ProgressTarget
	the amount of progress needed to unlock this achievement.
int	ProgressCurrent
	the current amount of progress made on this achievement

Protected Member Functions
virtual void	EvaluateProgress ()
	Evaluates the current progress of the achievement, and unlocks it if needed.

Member Function Documentation

AddProgress()

virtual void MoreMountains.Tools.MMAchievement.AddProgress ( int newProgress )

virtual

Adds the specified value to the current progress.

Parameters

newProgress

New progress.

Copy()

virtual MMAchievement MoreMountains.Tools.MMAchievement.Copy ( )

virtual

Copies this achievement (useful when loading from a scriptable object list)

EvaluateProgress()

virtual void MoreMountains.Tools.MMAchievement.EvaluateProgress ( )

protectedvirtual

Evaluates the current progress of the achievement, and unlocks it if needed.

LockAchievement()

virtual void MoreMountains.Tools.MMAchievement.LockAchievement ( )

virtual

Locks the achievement.

SetProgress()

virtual void MoreMountains.Tools.MMAchievement.SetProgress ( int newProgress )

virtual

Sets the progress to the value passed in parameter.

Parameters

newProgress

New progress.

UnlockAchievement()

virtual void MoreMountains.Tools.MMAchievement.UnlockAchievement ( )

virtual

Unlocks the achievement, asks for a save of the current achievements, and triggers an MMAchievementUnlockedEvent for this achievement.

This will usually then be caught by the MMAchievementDisplay class.

Member Data Documentation

AchievementID

string MoreMountains.Tools.MMAchievement.AchievementID

the unique identifier for this achievement

AchievementType

AchievementTypes MoreMountains.Tools.MMAchievement.AchievementType

is this achievement progress based or

Description

string MoreMountains.Tools.MMAchievement.Description

the achievement's description

HiddenAchievement

bool MoreMountains.Tools.MMAchievement.HiddenAchievement

if this is true, the achievement won't be displayed in a list

LockedImage

Sprite MoreMountains.Tools.MMAchievement.LockedImage

the image to display while this achievement is locked

Points

int MoreMountains.Tools.MMAchievement.Points

the amount of points unlocking this achievement gets you

ProgressCurrent

int MoreMountains.Tools.MMAchievement.ProgressCurrent

the current amount of progress made on this achievement

ProgressTarget

int MoreMountains.Tools.MMAchievement.ProgressTarget

the amount of progress needed to unlock this achievement.

Title

string MoreMountains.Tools.MMAchievement.Title

the achievement's name/title

UnlockedImage

Sprite MoreMountains.Tools.MMAchievement.UnlockedImage

the image to display when the achievement is unlocked

UnlockedSound

AudioClip MoreMountains.Tools.MMAchievement.UnlockedSound

a sound to play when the achievement is unlocked

UnlockedStatus

bool MoreMountains.Tools.MMAchievement.UnlockedStatus

if this is true, the achievement has been unlocked. Otherwise, it's still up for grabs

---

The documentation for this class was generated from the following file:

• H:/Code/MoreMountains/InventoryEngineStore/Assets/InventoryEngine/MMTools/Foundation/MMAchievements/Scripts/MMAchievement.cs