FrameIT
|
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... | |
Stage (Stage get, string category, int number, string name, string description, string scene, bool local=true) | |
Copy Constructor. 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.
More... | |
void | deletet_record (PlayerRecord record, bool b_store=true) |
Deletes record and calls PlayerRecord.factState.hardreset().
More... | |
bool | set_record (PlayerRecord record) |
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 (bool player_record_list_too) |
Clears and deletes all files associated with this Stage. More... | |
void | store (bool reset_player=false) |
Stores and overwrites this Stage, player_record, every element in player_record_list and solution (no overwrite for latter if empty). More... | |
bool | DeepLoad () |
Loads every member decorated with JsonIgnoreAttribute: solution, player_record. 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... | |
Static Public Member Functions | |
static bool | load (ref Stage set, string name, List< Directories > hierarchie=null, bool use_install_folder=false) |
Loads a Stage complete using: More... | |
static bool | ShallowLoad (ref Stage set, string path) |
Reads File given by path and writes its contents into set . More... | |
static bool | ShallowLoad (ref Stage set, string name, List< Directories > hierarchie=null, bool use_install_folder=false) |
Determines path via hierarchie and use_install_folder and calls ShallowLoad(ref Stage, string).
| |
static Dictionary< string, Stage > | Grup (List< Directories > hierarchie=null, bool use_install_folder=false) |
Looks for saved Stages in parametised directories and calls on them ShallowLoad(ref Stage, string). More... | |
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 | name = null |
The name this Stage will be displayed with. Also defines names of save files of stage progress, solution 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... | |
List< Directories > | hierarchie = null |
TODO? interface More... | |
Dictionary< string, PlayerRecord > | player_record_list = null |
A list containing all saved player progress. More... | |
SolutionOrganizer | solution = null |
Defining when this Stage.player_record is considered as solved.
| |
PlayerRecord | player_record = null |
Current Stage progress. More... | |
bool | creatorMode = false |
Wether player_record.factState (false ) or solution (true ) is exposed and drawn. More... | |
Properties | |
bool | completed_once [get] |
true iff there is at least one element in player_record_list where PlayerRecord.solved == true . More... | |
FactOrganizer | 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... | |
Private Member Functions | |
void | InitOOP () |
Initiates members which are non primitives. More... | |
Private Attributes | |
FactOrganizer | hiddenState |
Tempory variable storing factState when creatorMode == true . More... | |
string | path = null |
TODO? interafce More... | |
static List< Directories > | hierStage = new List<Directories> { Directories.Stages } |
TODO? interafce More... | |
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 |
Stage.Stage | ( | Stage | get, |
string | category, | ||
int | number, | ||
string | name, | ||
string | description, | ||
string | scene, | ||
bool | local = true |
||
) |
Copy Constructor.
get | to be copied |
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).
bool Stage.DeepLoad | ( | ) |
Loads every member decorated with JsonIgnoreAttribute: solution, player_record.
void Stage.delete | ( | bool | player_record_list_too | ) |
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().
|
static |
Looks for saved Stages in parametised directories and calls on them ShallowLoad(ref Stage, string).
hierarchie | see hierarchie //TODO? Interface |
use_install_folder | see use_install_folder |
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.
|
static |
Loads a Stage complete using:
set | see ShallowLoad(ref Stage, string) |
name | see ShallowLoad(ref Stage, string) |
hierarchie | see hierarchie // TODO? Interface |
use_install_folder | see use_install_folder |
true
iff succeededvoid Stage.push_record | ( | double | seconds_s = -1 , |
bool | force_push = false |
||
) |
Adds current player_record to player_record_list incrementing PlayerRecord.seconds beforehand.
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 | ( | PlayerRecord | record | ) |
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 |
Determines path via hierarchie and use_install_folder and calls ShallowLoad(ref Stage, string).
set | see ShallowLoad(ref Stage, string) |
name | see ShallowLoad(ref Stage, string) |
hierarchie | see hierarchie // TODO? Interface |
use_install_folder | see use_install_folder |
true
iff succeeded
|
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 succeededvoid Stage.store | ( | bool | reset_player = 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 |
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
.
List<Directories> Stage.hierarchie = null |
TODO? interface
|
staticprivate |
TODO? interafce
string Stage.name = null |
The name this Stage will be displayed with. Also defines names of save files of stage progress, solution
|
private |
TODO? interafce
PlayerRecord Stage.player_record = null |
Current Stage progress.
Dictionary<string, PlayerRecord> Stage.player_record_list = null |
A list containing all saved player progress.
string Stage.scene = null |
The name of a UnityEngine.SceneManagement.Scene that this Stage takes place in.
SolutionOrganizer Stage.solution = null |
Defining when this Stage.player_record is considered as solved.
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 null
set
initiates player_record
|
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').