|
FrameIT
|
Classes | |
| class | PlayerRecord |
| Represents a save slot. More... | |
| class | SaveGame |
Public Member Functions | |
| Stage () | |
| Initiates all parameterless members. Used by JsonConverter to initate empty class.
| |
| Stage (string category, int number, string name, string description, string scene, bool local=true) | |
| Standard Constructor. Initiates all members. More... | |
| void | InitFields (string category, int number, string name, string description, string scene, bool local) |
| Sets members which are primitives. More... | |
| void | ClearAll () |
| Resets to factory condition. ClearSolution ClearPlay ClearALLRecords More... | |
| void | ClearSolution () |
Resets solution and calling solution.hardreset(bool).
| |
| void | ClearPlay () |
Resets current player_record and calling player_record.factState.hardreset(bool).
| |
| void | ClearALLRecords () |
Resets and deletes all members of player_record_list.
| |
| void | deletet_record (PlayerRecord record, bool b_store=true) |
Deletes record and calls PlayerRecord.factState.hardreset().
| |
| bool | set_record (string record_index) |
| Clones record to player_record iff found in player_record_list or initiates new player_record iff record == null. More... | |
| void | push_record (double seconds_s=-1, bool force_push=false) |
| Adds current player_record to player_record_list incrementing PlayerRecord.seconds beforehand. More... | |
| void | SetMode (bool create) |
Switches between player_record.factState (false) and solution (true) to display in GameWorld. More... | |
| void | delete () |
| Clears and deletes all files associated with this Stage. More... | |
| void | store (bool reset_player=false, bool force_stage_file=false) |
| Stores and overwrites this Stage, player_record, every element in player_record_list and solution (no overwrite for latter if empty). More... | |
| void | ResetPlay () |
| Calls ClearPlay and store(true). More... | |
| void | ResetSaves () |
| Calls ClearPlay, ClearALLRecords and store(true). More... | |
| bool | CheckSolved () |
| Checks if current player_record is solved. Iff return value true: More... | |
Public Member Functions inherited from IJSONsavable< Stage > | |
| virtual string | _IJGetName (string name) |
| virtual List< Directories > | _IJGetHierarchie (List< Directories > hierarchie_base) |
| virtual bool | _IJGetRawObject (out T payload, string path) |
| virtual T | _IJPreProcess (T payload) |
| virtual T | _IJPostProcess (T payload) |
| bool | store (List< Directories > hierarchie, string name, bool use_install_folder=false, bool overwrite=true, bool deep_store=true) |
| bool | store_children (List< Directories > hierarchie, string name, bool use_install_folder=false, bool overwrite=true, bool deep_store=true) |
Static Public Member Functions | |
| static bool | ShallowLoad (out Stage set, string path) |
| Reads File given by path and writes its contents into set . More... | |
Static Public Member Functions inherited from IJSONsavable< Stage > | |
| static bool | store (List< Directories > hierarchie, string name, T payload, bool use_install_folder=false, bool overwrite=true, bool deep_store=true) |
| static bool | store_children (List< Directories > hierarchie, string name, T payload, bool use_install_folder=false, bool overwrite=true, bool deep_store=true) |
| static bool | load_children (List< Directories > hierarchie, string name, ref T raw_payload, bool use_install_folder=false, bool deep_load=true, bool post_process=true) |
| static bool | load (List< Directories > hierarchie, string name, out T payload, bool use_install_folder=false, bool deep_load=true, bool post_process=true) |
| static T | postprocess (T payload) |
| static T | preprocess (T payload) |
| static void | delete_children (List< Directories > hierarchie, string name, bool use_install_folder=false, int skip_last_children=0) |
| static bool | delete (List< Directories > hierarchie, string name, bool use_install_folder=false) |
Public Attributes | |
| string | category = null |
| Which category this Stage should be displayed in. More... | |
| int | number = -1 |
| Where to display this Stage within a category relative to others. More... | |
| string | description = null |
| The description this Stage will be displayed with. More... | |
| string | scene = null |
| The name of a UnityEngine.SceneManagement.Scene that this Stage takes place in. More... | |
| bool | use_install_folder = false |
| Wether this Stage is located in installation folder or user data (a.k.a. !local). More... | |
| SolutionRecorder | solution = null |
Defining when this Stage.player_record is considered as solved.
| |
| SaveGame | savegame = null |
| A single class containing all savegame-data. Stored seperately. More... | |
| List< PlayerRecord > | solution_approches = new() |
| List< string > | AllowedScrolls = null |
| List< Gadget > | AllowedGadgets = null |
| bool | creatorMode = false |
Wether player_record.factState (false) or solution (true) is exposed and drawn. More... | |
Properties | |
| string | name = null [getset] |
| The name this Stage will be displayed with. Also defines names of save files of stage progress, solution More... | |
| string | path = null [getset] |
| bool | completed_once [get] |
true iff there is at least one element in player_record_list where PlayerRecord.solved == true. More... | |
| PlayerRecord | player_record [getset] |
| Current Stage progress. More... | |
| Dictionary< string, PlayerRecord >? | player_record_list [getset] |
| A list containing all saved player progress. More... | |
| FactRecorder | factState [getset] |
| A wrapper returning (or setting) player_record.factState. When player_record == null: More... | |
| string | record_name [get] |
| Returns a name for player_record.name which needs to be uniquified once put into player_record_list (e.g. by push_record(double, bool) adding '_i'). More... | |
Properties inherited from IJSONsavable< Stage > | |
| string | name [getset] |
| string | path [getset] |
Private Member Functions | |
| void | InitOOP () |
| Initiates members which are non primitives. More... | |
Static Private Member Functions | |
| static | Stage () |
Private Attributes | |
| string | record_index |
| FactRecorder | hiddenState |
Tempory variable storing factState when creatorMode == true. More... | |
Additional Inherited Members | |
Static Public Attributes inherited from IJSONsavable< Stage > | |
| static readonly IJSONsavable< T > | Instance |
| static readonly FieldInfo[] | JsonSaveableFields |
| static readonly FieldInfo[] | JsonAutoPreProcessFields |
| static readonly FieldInfo[] | JsonAutoPostProcessFields |
| static readonly FieldInfo[] | JsonSeperateFields |
Static Protected Attributes inherited from IJSONsavable< Stage > | |
| static List< Directories > | hierarchie |
|
staticprivate |
| Stage.Stage | ( | ) |
Initiates all parameterless members.
Used by JsonConverter to initate empty class.
| Stage.Stage | ( | string | category, |
| int | number, | ||
| string | name, | ||
| string | description, | ||
| string | scene, | ||
| bool | local = true |
||
| ) |
Standard Constructor.
Initiates all members.
| category | sets category |
| number | sets number |
| name | sets name |
| description | sets description |
| scene | sets scene |
| local | sets !use_install_folder |
| bool Stage.CheckSolved | ( | ) |
Checks if current player_record is solved.
Iff return value true:
true. true iff current player_record is solved.| void Stage.ClearAll | ( | ) |
Resets to factory condition. ClearSolution ClearPlay ClearALLRecords
| void Stage.ClearALLRecords | ( | ) |
Resets and deletes all members of player_record_list.
| void Stage.ClearPlay | ( | ) |
Resets current player_record and calling player_record.factState.hardreset(bool).
| void Stage.ClearSolution | ( | ) |
Resets solution and calling solution.hardreset(bool).
| void Stage.delete | ( | ) |
Clears and deletes all files associated with this Stage.
| player_record_list_too | iff set false, all files regarding player_record_list will be spared. |
| void Stage.deletet_record | ( | PlayerRecord | record, |
| bool | b_store = true |
||
| ) |
Deletes record and calls PlayerRecord.factState.hardreset().
| void Stage.InitFields | ( | string | category, |
| int | number, | ||
| string | name, | ||
| string | description, | ||
| string | scene, | ||
| bool | local | ||
| ) |
Sets members which are primitives.
| category | sets category |
| number | sets number |
| name | sets name |
| description | sets description |
| scene | sets scene |
| local | sets !use_install_folder |
|
private |
Initiates members which are non primitives.
| void Stage.push_record | ( | double | seconds_s = -1, |
| bool | force_push = false |
||
| ) |
Adds current player_record to player_record_list incrementing PlayerRecord.seconds beforehand.
IMPACTS SERVER PERFORMANCE: Increases number of Facts at the Server for every Fact in current player_record
| seconds_s | time in seconds to be added to player_record.seconds before pushing. Iff set to -1 Time.timeSinceLevelLoadAsDouble will be used. |
| force_push | iff set true && StageStatic.mode == StageStatic.Mode.Create && creatorMode current displayed solution in factState will be pushed into player_record_list |
| void Stage.ResetPlay | ( | ) |
Calls ClearPlay and store(true).
| void Stage.ResetSaves | ( | ) |
Calls ClearPlay, ClearALLRecords and store(true).
| bool Stage.set_record | ( | string | record_index | ) |
Clones record to player_record iff found in player_record_list
or initiates new player_record iff record ==null.
| record | to be set or null |
false iff record not found in player_record_list | void Stage.SetMode | ( | bool | create | ) |
Switches between player_record.factState (false) and solution (true) to display in GameWorld.
| create | sets creatorMode |
|
static |
Reads File given by path and writes its contents into set .
Will not read members decorated with JsonIgnoreAttribute: solution, player_record.
| set | to be written in |
| path | file location |
true iff succeeded| void Stage.store | ( | bool | reset_player = false, |
| bool | force_stage_file = false |
||
| ) |
Stores and overwrites this Stage, player_record, every element in player_record_list and solution (no overwrite for latter if empty).
| reset_player | wether to clear current player_record |
| List<Gadget> Stage.AllowedGadgets = null |
| List<string> Stage.AllowedScrolls = null |
| string Stage.category = null |
Which category this Stage should be displayed in.
| bool Stage.creatorMode = false |
Wether player_record.factState (false) or solution (true) is exposed and drawn.
| string Stage.description = null |
The description this Stage will be displayed with.
|
private |
Tempory variable storing factState when creatorMode == true.
|
private |
| SaveGame Stage.savegame = null |
A single class containing all savegame-data. Stored seperately.
| string Stage.scene = null |
The name of a UnityEngine.SceneManagement.Scene that this Stage takes place in.
| SolutionRecorder Stage.solution = null |
Defining when this Stage.player_record is considered as solved.
| List<PlayerRecord> Stage.solution_approches = new() |
| bool Stage.use_install_folder = false |
Wether this Stage is located in installation folder or user data (a.k.a. !local).
|
get |
true iff there is at least one element in player_record_list where PlayerRecord.solved == true.
|
getset |
A wrapper returning (or setting) player_record.factState.
When player_record == null:
get returns nullset initiates player_record
|
getset |
The name this Stage will be displayed with. Also defines names of save files of stage progress, solution
|
getset |
|
getset |
Current Stage progress.
|
getset |
A list containing all saved player progress.
|
getprivate |
Returns a name for player_record.name which needs to be uniquified once put into player_record_list (e.g. by push_record(double, bool) adding '_i').