|
FrameIT
|
Keeps track of all available and current Stage More...
Classes | |
| struct | StageErrorStruct |
| Created when an error (may) occures while a Stage is being created, because of incompatible variables. More... | |
Public Types | |
| enum | Mode { Play , Create } |
| Available Modes a Stage to be selected and/ or loaded in. More... | |
Static Public Member Functions | |
| static void | SetMode (Mode mode, GameObject gameObject=null) |
| sets mode and en-/ disables children of gameObject with certain Tags, only available in certain Modes (e.g. in Def_Stage) More... | |
| static StageErrorStruct | Validate (string category, int id, string name, string description, string scene, bool local=true) |
| static StageErrorStruct | LoadNewStage (string category, int id, string name, string description, string scene, bool local=true, bool forcelocal=false) |
| static void | LoadCreate () |
| Load current stage in Mode.Create More... | |
| static int | NextNumber (bool local, string category) |
| Finds first unused Stage.number in a certain category . More... | |
| static bool | ContainsNumber (string category, int i, bool local) |
Looks wether an Stage.number i exists within a certain Stage.category category in local saves (local == true) or install path. More... | |
| static void | ShallowLoadStages (bool force=false) |
| Looks for and initial loads (see Stage.ShallowLoad(out Stage, string)) Stages in local_stage and !local_stage. More... | |
| static void | SetStage (string name, bool local) |
| Sets parameters, defining what to load in LoadInitStage(bool, GameObject) and LoadInitStage(string, bool, bool, GameObject). More... | |
| static Stage | GetStage (string name, bool local) |
| Returns a Stage or throws Exception if not found. More... | |
| static void | Delete (Stage stage) |
Deletes a Stage and all its associated files (including save games).
| |
| static bool | LoadInitStage (string name, bool local=false, bool restore_session=true, GameObject gameObject=null) |
| Wrapps LoadInitStage(bool, GameObject) with extra parameters. Loads and initiates Stage defined by name and local . More... | |
| static bool | LoadInitStage (bool restore_session, GameObject gameObject=null) |
| Loads and initiates Stage defined by current_name and local_stage. More... | |
| static bool | ContainsKey (string key) |
| Wrapps ContainsKey(string, bool); defaulting local to local_stage More... | |
| static bool | ContainsKey (string key, bool local) |
Looks for a Stage key in StageLocal (local ==true) or StageOfficial (local ==false). More... | |
Static Public Attributes | |
| static Dictionary< string, int > | Category |
| Used to map StageOfficial categories into a ordered list for the StageMenue. More... | |
| static string | current_name |
Stage.name of current stage or one to be loaded.
| |
| static bool | local_stage |
!Stage.use_install_folder of current stage or one to be loaded.
| |
| static Mode | mode |
| Current Mode More... | |
| static readonly List< string > | Worlds = GenerateWorldList() |
| Loadable world scenes More... | |
Properties | |
| static IReadOnlyDictionary< string, Stage > | StageOfficial [get] |
| static IReadOnlyDictionary< string, Stage > | StageLocal [get] |
| static Stage???? | stage [getset] |
| Current Stage More... | |
| static double | stage_time [get] |
| static StageErrorStruct | last_error [getprivate set] |
| TODO: set when encountering an error More... | |
Static Private Member Functions | |
| static List< string > | GenerateWorldList () |
| Extracts all loadable scenes for Worlds. More... | |
Static Private Attributes | |
| static readonly List< Dictionary< string, Stage > > | StageChapters = new() { new(), new() } |
| static readonly int | MaxTriesOfShallowLoadStages = 2 |
| static int | TriesOfShallowLoadStages = 0 |
Keeps track of all available and current Stage
| enum StageStatic.Mode |
Available Modes a Stage to be selected and/ or loaded in.
| Enumerator | |
|---|---|
| Play | |
| Create | |
|
static |
Wrapps ContainsKey(string, bool); defaulting local to local_stage
|
static |
Looks for a Stage key in StageLocal (local ==true) or StageOfficial (local ==false).
(local ? StageLocal : StageOfficial).ContainsKey(key)
|
static |
Looks wether an Stage.number i exists within a certain Stage.category category in local saves (local == true) or install path.
| category | to look in |
| i | to look for |
| local | where to look |
|
static |
Deletes a Stage and all its associated files (including save games).
| stage | to be deleted |
|
staticprivate |
|
static |
Returns a Stage or throws Exception if not found.
| name | Stage.name |
| local | where to look |
(local ? StageLocal : StageOfficial)[name];
|
static |
Load current stage in Mode.Create
|
static |
Loads and initiates Stage defined by current_name and local_stage.
| restore_session | wether to restore last (loaded) player session (true) or start from scratch (false). |
| gameObject | (e.g. UI/ Def_Stage) toggles recursively children with tag "DevelopingMode" to mode == Mode.Create. |
false iff Stage defined by current_name and local_stage could not be found or loaded.
|
static |
Wrapps LoadInitStage(bool, GameObject) with extra parameters. Loads and initiates Stage defined by name and local .
| name | sets current_name iff succeedes |
| local | sets current_name iff succeedes |
| restore_session | wether to restore last (loaded) player session (true) or start from scratch (false). |
| gameObject | (e.g. UI/ Def_Stage) toggles recursively children with tag "DevelopingMode" to mode == Mode.Create. |
false iff Stage defined by name and local could not be found or loaded.
|
static |
|
static |
Finds first unused Stage.number in a certain category .
| local | which kind of stage we are looking at |
| category | the category in question |
|
static |
|
static |
Sets parameters, defining what to load in LoadInitStage(bool, GameObject) and LoadInitStage(string, bool, bool, GameObject).
| name | sets current_name |
| local | sets local_stage |
|
static |
Looks for and initial loads (see Stage.ShallowLoad(out Stage, string)) Stages in local_stage and !local_stage.
|
static |
|
static |
Used to map StageOfficial categories into a ordered list for the StageMenue.
|
static |
Stage.name of current stage or one to be loaded.
|
static |
!Stage.use_install_folder of current stage or one to be loaded.
|
staticprivate |
|
staticprivate |
|
staticprivate |
|
static |
Loadable world scenes
|
staticgetprivate set |
TODO: set when encountering an error
|
staticget |
|
staticget |
Key: stage nameValue: stages created by local user
|
staticget |
Key: stage nameValue: stages created by KWARC