SerializedData Class Reference

Detailed Description

This takes data from the DataManager (given in the constructor) and packages into a class that can be serialized. FileReadWrite can then write this class to a file, or create a new one after reading from a pre-existing file. In short, this class is an intermediate format between the DataManager and data saved to a file, allowing FileReadWrite to translate between the two.

Documentation updated 2/3/2025

Author

Stephen Nuttall

Public Member Functions
	SerializedData (DataManager dataManager)
	Constructor. Sets all variables to the values in the DataManager.

Properties
string	abilityName_1 [get, private set]
string	abilityName_2 [get, private set]
string	abilityName_3 [get, private set]
string	abilityName_4 [get, private set]

General Data
Data related to the player, time of day, soul counts, and more.
int	playerHealth [get, private set]
int	healthPotionCount [get, private set]
	The amount of health potions the player currently has.
TimeOfDay	currTimeOfDay [get, private set]
	Time of day that should be restored when a new scene is loaded. 0 = day, 1 = night, 2 = eclipse, and 3 = blood moon.
int	souls [get, private set]
	Current amount of souls.
int	godSouls [get, private set]
	Current amount of god souls.
bool	abilitiesUnlocked [get, private set]
	Whether the ability hotbar is unlocked yet or not.
bool	skyhubUnlocked [get, private set]
	True if warp obelisks should allow the player to warp to the Skyhub. Unlocks after Geb is defeated.
bool	maatTalked [get, private set]
	If Ma'at has never been talked to before, the welcome message should be displayed.
bool	skyhubExited [get, private set]
	If the player has ever exited the Skyhub.
bool	skyhubLeadsToOpening [get, private set]
	Set to true and the Skyhub will spawn the player back at the Opening scene.

Scene Data
Details about the current scene, previous scene, and the respawn scene.
int	currSceneIndex [get, private set]
int	prevSceneIndex [get, private set]
	The index of the scene that was previously loaded.
string	currSceneName [get, private set]
	The name of the scene that is currently loaded.
string	prevSceneName [get, private set]
	The name of the scene that was previously loaded.
string	respawnSceneName [get, private set]
	The name of the scene the player’s respawn point is in.
float	respawnPoint_X [get, private set]
	The X coordinate of the player’s respawn point.
float	respawnPoint_Y [get, private set]
	The Y coordinate of the player’s respawn point.

Volume Settings
The volume gets multiplied by these values in AudioManager.cs (values ranging from 0 to 1, accessible from the settings menu).
float	masterVolumeSetting [get, private set]
float	musicVolumeSetting [get, private set]
	The music volume gets multiplied by this values in AudioManager.cs (values ranging from 0 to 1).
float	sfxVolumeSetting [get, private set]
	The SFX volume gets multiplied by this values in AudioManager.cs (values ranging from 0 to 1).

Constructor & Destructor Documentation

SerializedData()

SerializedData.SerializedData

(

DataManager

dataManager

)

Constructor. Sets all variables to the values in the DataManager.

Property Documentation

abilitiesUnlocked

bool SerializedData.abilitiesUnlocked

getprivate set

Whether the ability hotbar is unlocked yet or not.

abilityName_1

string SerializedData.abilityName_1

getprivate set

abilityName_2

string SerializedData.abilityName_2

getprivate set

abilityName_3

string SerializedData.abilityName_3

getprivate set

abilityName_4

string SerializedData.abilityName_4

getprivate set

currSceneIndex

int SerializedData.currSceneIndex

getprivate set

The index of the scene that is currently loaded.

currSceneName

string SerializedData.currSceneName

getprivate set

The name of the scene that is currently loaded.

currTimeOfDay

TimeOfDay SerializedData.currTimeOfDay

getprivate set

Time of day that should be restored when a new scene is loaded. 0 = day, 1 = night, 2 = eclipse, and 3 = blood moon.

godSouls

int SerializedData.godSouls

getprivate set

Current amount of god souls.

healthPotionCount

int SerializedData.healthPotionCount

getprivate set

The amount of health potions the player currently has.

maatTalked

bool SerializedData.maatTalked

getprivate set

If Ma'at has never been talked to before, the welcome message should be displayed.

masterVolumeSetting

float SerializedData.masterVolumeSetting

getprivate set

The master volume gets multiplied by this values in AudioManager.cs (values ranging from 0 to 1).

musicVolumeSetting

float SerializedData.musicVolumeSetting

getprivate set

The music volume gets multiplied by this values in AudioManager.cs (values ranging from 0 to 1).

playerHealth

int SerializedData.playerHealth

getprivate set

Player health that should be restored when a new scene is loaded.

prevSceneIndex

int SerializedData.prevSceneIndex

getprivate set

The index of the scene that was previously loaded.

prevSceneName

string SerializedData.prevSceneName

getprivate set

The name of the scene that was previously loaded.

respawnPoint_X

float SerializedData.respawnPoint_X

getprivate set

The X coordinate of the player’s respawn point.

respawnPoint_Y

float SerializedData.respawnPoint_Y

getprivate set

The Y coordinate of the player’s respawn point.

respawnSceneName

string SerializedData.respawnSceneName

getprivate set

The name of the scene the player’s respawn point is in.

sfxVolumeSetting

float SerializedData.sfxVolumeSetting

getprivate set

The SFX volume gets multiplied by this values in AudioManager.cs (values ranging from 0 to 1).

skyhubExited

bool SerializedData.skyhubExited

getprivate set

If the player has ever exited the Skyhub.

skyhubLeadsToOpening

bool SerializedData.skyhubLeadsToOpening

getprivate set

Set to true and the Skyhub will spawn the player back at the Opening scene.

skyhubUnlocked

bool SerializedData.skyhubUnlocked

getprivate set

True if warp obelisks should allow the player to warp to the Skyhub. Unlocks after Geb is defeated.

souls

int SerializedData.souls

getprivate set

Current amount of souls.

---

The documentation for this class was generated from the following file:

• Assets/Scripts/Data Management/SerializedData.cs