Sandbox.Game.SessionComponents.MySteamAchievementBase Class Reference

Inheritance diagram for Sandbox.Game.SessionComponents.MySteamAchievementBase:

Public Member Functions
virtual void	SessionLoad ()
	Called when session components are getting loaded. More...
virtual void	SessionUpdate ()
	Update called in AfterSimulation. More...
virtual void	SessionSave ()
	Called when session components are getting saved. More...
virtual void	SessionUnload ()
	Called when session gets unloaded. More...
virtual void	SessionBeforeStart ()
	Called once after the session is loaded and before updates start. More...
virtual void	Init ()
	Called once when the session gets loaded for the first time. Always call base.Init()! More...

Protected Member Functions
void	NotifyAchieved ()
	Use to notify the achievement state change. More...

Properties
abstract string	AchievementTag [get]
	Tag that identifies the achievement within the Steam system. More...
bool	IsAchieved [get, protected set]
	Achievement will stop recieving updates when Achieved. More...
abstract bool	NeedsUpdate [get]
	Tells if the Achievement needs to recieve updates. More...

Events
Action< MySteamAchievementBase >	Achieved
	Invoked when the achievement is achieved. Invocation list is cleared afterwards. More...

Detailed Description

Definition at line 23 of file MySteamAchievements.cs.

Member Function Documentation

virtual void Sandbox.Game.SessionComponents.MySteamAchievementBase.Init ( )

inlinevirtual

Called once when the session gets loaded for the first time. Always call base.Init()!

Reimplemented in SpaceEngineers.Game.Achievements.MyAchievement_GiantLeapForMankind, SpaceEngineers.Game.Achievements.MyAchievement_Explorer, SpaceEngineers.Game.Achievements.MyAchievement_DeathWish, SpaceEngineers.Game.Achievements.MyAchievement_IHaveGotPresentForYou, SpaceEngineers.Game.Achievements.MyAchievement_TheHarderTheyFall, SpaceEngineers.Game.Achievements.MyAchievement_LostInSpace, SpaceEngineers.Game.Achievements.MyAchievement_TheBiggerTheyAre, SpaceEngineers.Game.Achievements.MyAchievement_Colorblind, SpaceEngineers.Game.Achievements.MyAchievement_GoingGreen, SpaceEngineers.Game.Achievements.MyAchievement_LockAndLoad, SpaceEngineers.Game.Achievements.MyAchievement_WinWin, SpaceEngineers.Game.Achievements.MyAchievement_ToTheStars, SpaceEngineers.Game.Achievements.MyAchievement_MasterEngineer, and SpaceEngineers.Game.Achievements.MyAchievement_DeclareWar.

Definition at line 103 of file MySteamAchievements.cs.

void Sandbox.Game.SessionComponents.MySteamAchievementBase.NotifyAchieved ( )

inlineprotected

Use to notify the achievement state change.

Definition at line 74 of file MySteamAchievements.cs.

virtual void Sandbox.Game.SessionComponents.MySteamAchievementBase.SessionBeforeStart ( )

inlinevirtual

Called once after the session is loaded and before updates start.

Reimplemented in SpaceEngineers.Game.Achievements.MyAchievement_Monolith, and SpaceEngineers.Game.Achievements.MyAchievement_SmileAndWave.

Definition at line 69 of file MySteamAchievements.cs.

virtual void Sandbox.Game.SessionComponents.MySteamAchievementBase.SessionLoad ( )

inlinevirtual

Called when session components are getting loaded.

Reimplemented in SpaceEngineers.Game.Achievements.MyAchievement_Explorer, SpaceEngineers.Game.Achievements.MyAchievement_LostInSpace, SpaceEngineers.Game.Achievements.MyAchievement_MasterEngineer, SpaceEngineers.Game.Achievements.MyAchievement_DeathWish, and SpaceEngineers.Game.Achievements.MyAchievement_PersonalityCrisis.

Definition at line 49 of file MySteamAchievements.cs.

virtual void Sandbox.Game.SessionComponents.MySteamAchievementBase.SessionSave ( )

inlinevirtual

Called when session components are getting saved.

Definition at line 59 of file MySteamAchievements.cs.

virtual void Sandbox.Game.SessionComponents.MySteamAchievementBase.SessionUnload ( )

inlinevirtual

Called when session gets unloaded.

Definition at line 64 of file MySteamAchievements.cs.

virtual void Sandbox.Game.SessionComponents.MySteamAchievementBase.SessionUpdate ( )

inlinevirtual

Update called in AfterSimulation.

Reimplemented in SpaceEngineers.Game.Achievements.MyAchievement_Explorer, SpaceEngineers.Game.Achievements.MyAchievement_GiantLeapForMankind, SpaceEngineers.Game.Achievements.MyAchievement_PersonalityCrisis, SpaceEngineers.Game.Achievements.MyAchievement_LostInSpace, SpaceEngineers.Game.Achievements.MyAchievement_Colorblind, SpaceEngineers.Game.Achievements.MyAchievement_DeathWish, SpaceEngineers.Game.Achievements.MyAchievement_Monolith, SpaceEngineers.Game.Achievements.MyAchievement_MasterEngineer, SpaceEngineers.Game.Achievements.MyAchievement_SmileAndWave, and SpaceEngineers.Game.Achievements.MyAchievement_NumberFiveIsAlive.

Definition at line 54 of file MySteamAchievements.cs.

Property Documentation

abstract string Sandbox.Game.SessionComponents.MySteamAchievementBase.AchievementTag

get

Tag that identifies the achievement within the Steam system.

Definition at line 34 of file MySteamAchievements.cs.

bool Sandbox.Game.SessionComponents.MySteamAchievementBase.IsAchieved

getprotected set

Achievement will stop recieving updates when Achieved.

Definition at line 39 of file MySteamAchievements.cs.

abstract bool Sandbox.Game.SessionComponents.MySteamAchievementBase.NeedsUpdate

get

Tells if the Achievement needs to recieve updates.

Definition at line 44 of file MySteamAchievements.cs.

Event Documentation

Action<MySteamAchievementBase> Sandbox.Game.SessionComponents.MySteamAchievementBase.Achieved

Invoked when the achievement is achieved. Invocation list is cleared afterwards.

Definition at line 29 of file MySteamAchievements.cs.

---

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

• Sources/Sandbox.Game/Game/SessionComponents/MySteamAchievements.cs