Show / Hide Table of Contents

    Class Startup

    Inheritance
    Object
    Startup
    Implements
    IStartup
    Namespace: IdleKit.Gameplay
    Assembly: cs.temp.dll.dll
    Syntax
    public abstract class Startup : MonoBehaviour, IStartup

    Properties

    ActionService

    Declaration
    protected virtual IActionService ActionService { get; }
    Property Value
    Type Description
    IActionService

    Context

    Declaration
    protected abstract IContext Context { get; }
    Property Value
    Type Description
    IContext

    Loader

    Declaration
    public virtual ILoader Loader { get; protected set; }
    Property Value
    Type Description
    ILoader

    MainGameContentId

    Declaration
    public abstract string MainGameContentId { get; }
    Property Value
    Type Description
    String

    UserSavedData

    Declaration
    protected virtual IUserSavedData UserSavedData { get; }
    Property Value
    Type Description
    IUserSavedData

    Methods

    GetAuxiliaryLoadPhases()

    Declaration
    protected abstract ILoadPhase[] GetAuxiliaryLoadPhases()
    Returns
    Type Description
    ILoadPhase[]

    GetLoadContentDataLoadPhase()

    Declaration
    protected abstract ILoadPhase GetLoadContentDataLoadPhase()
    Returns
    Type Description
    ILoadPhase

    GetLoadGlobalDataLoadPhase()

    Declaration
    protected abstract ILoadPhase GetLoadGlobalDataLoadPhase()
    Returns
    Type Description
    ILoadPhase

    GetRemoveContentDataLoadPhase()

    Declaration
    protected abstract ILoadPhase GetRemoveContentDataLoadPhase()
    Returns
    Type Description
    ILoadPhase

    GetRemoveGlobalDataLoadPhase()

    Declaration
    protected abstract ILoadPhase GetRemoveGlobalDataLoadPhase()
    Returns
    Type Description
    ILoadPhase

    GetServiceTypes()

    Declaration
    protected virtual Type[] GetServiceTypes()
    Returns
    Type Description
    Type[]

    OnCleanupComplete()

    Declaration
    protected virtual void OnCleanupComplete()

    OnLoadPhaseComplete(ILoadPhase)

    Called when a ILoadPhase finishes loading. It is a good place to inject any custom logic that can not be contained in a Load Phase before the next Load Phase begins loading The IContent reference is extracted from the LoadContentLoadPhase for use in the ClearContentLoadPhase

    Declaration
    protected virtual void OnLoadPhaseComplete(ILoadPhase loadPhase)
    Parameters
    Type Name Description
    ILoadPhase loadPhase

    ResetGame(Boolean)

    Declaration
    public virtual void ResetGame(bool resetUser = false)
    Parameters
    Type Name Description
    Boolean resetUser

    ResetLoader()

    Declaration
    protected virtual void ResetLoader()

    SetCleanupLoadPhases(Boolean)

    Declaration
    protected virtual void SetCleanupLoadPhases(bool resetUser = false)
    Parameters
    Type Name Description
    Boolean resetUser

    SetClearContentLoadPhases(Boolean)

    These ILoadPhase objects will run each time a IContent is being cleared. This should be the opposite of the SetLoadContentLoadPhases(String). Passing resetContentId will wipe the current content Id in UserSavedData.

    Declaration
    protected virtual void SetClearContentLoadPhases(bool resetContentId = true)
    Parameters
    Type Name Description
    Boolean resetContentId

    SetInitializationLoadPhases()

    These ILoadPhase objects will run once and initialize the game

    Declaration
    protected virtual void SetInitializationLoadPhases()

    SetLoadContentLoadPhases(String)

    These ILoadPhase objects will run each time a IContent is being loaded. When the contentId is null (in the StartGame() it would load from the ContentId or the MainGameContentId.

    Declaration
    protected virtual void SetLoadContentLoadPhases(string contentId = null)
    Parameters
    Type Name Description
    String contentId

    SetSwitchStageLoadPhases()

    These ILoadPhase objects will run each time a IStage is being loaded

    Declaration
    protected virtual void SetSwitchStageLoadPhases()

    StartGame()

    Declaration
    public virtual void StartGame()

    SwitchContent(String)

    If switching to an Event, the IdleKit.Core.IEventSettings.Id should be passed here.

    Declaration
    public virtual void SwitchContent(string contentId)
    Parameters
    Type Name Description
    String contentId

    SwitchStage()

    Declaration
    public virtual void SwitchStage()

    Implements

    IStartup
    Back to top Copyright © 2020 East Side Games Inc.