Interface IStartup
This class should handle starting the game. It also provides some access to IContent related data to use when determining what IContent to load.
Namespace: IdleKit.Framework
Assembly: cs.temp.dll.dll
Syntax
public interface IStartup
Properties
contentIds
A list of all available IContents a user could load into.
Declaration
List<string> contentIds { get; }
Property Value
Type | Description |
---|---|
List<String> |
mainGameContentId
Declaration
string mainGameContentId { get; }
Property Value
Type | Description |
---|---|
String |
Methods
ResetGame(Boolean)
This should be called when the user wants to restart the game. It would load in the same
IContent that the user currently is on. resetUser
determines if all the
ISavedData should reset.
Declaration
void ResetGame(bool resetUser = false)
Parameters
Type | Name | Description |
---|---|---|
Boolean | resetUser |
StartGame()
This should be called once on startup. All one time initialization should be run in this method.
Declaration
void StartGame()
SwitchContent(String)
This should be run each time a user moves between IContents. Any IContent related cleanup and initialization should be run in this method.
Declaration
void SwitchContent(string contentId)
Parameters
Type | Name | Description |
---|---|---|
String | contentId |
SwitchStage()
This should be run each time a user moves between IStages. Any IStage related cleanup and initialization should be run in this method.
Declaration
void SwitchStage()