Class Universe
Representation of game asset folder
Properties
BuiltIn
Built-in universe of the current game
Declaration
public static Universe BuiltIn { get; }
BuiltInInfo
Info.json of the built-in universe
Declaration
public static UniverseInfo BuiltInInfo { get; }
BuiltInMapRoot
Map root folder path. Map inside this folder should not be edit by the player.
Declaration
public string BuiltInMapRoot { get; }
BuiltInSheetPath
Built-in artwork sheet file path. This file is generated by the game engine.
Declaration
public string BuiltInSheetPath { get; }
CharacterMovementConfigRoot
Folder that holds character movement config json files
Declaration
public string CharacterMovementConfigRoot { get; }
ConversationRoot
Path of the folder that hold conversation files
Declaration
public string ConversationRoot { get; }
CurrentSavingSlot
Current selected saving slot index
Declaration
public int CurrentSavingSlot { get; }
FontRoot
Folder that holds font files
Declaration
public string FontRoot { get; }
GameSheetPath
Artwork sheet file path. This file is painted by the developer of the game.
Declaration
public string GameSheetPath { get; }
Info
Data from Info.json file
Declaration
public UniverseInfo Info { get; }
InfoPath
Info.json file path
Declaration
public string InfoPath { get; }
LanguageRoot
Folder that holds the localization files
Declaration
public string LanguageRoot { get; }
MusicRoot
Folder that holds BGM audio files
Declaration
public string MusicRoot { get; }
SavingRoot
Root of the saving folder
Declaration
public string SavingRoot { get; }
SheetRoot
Artwork sheets root folder path
Declaration
public string SheetRoot { get; }
SlotCharacterRenderingConfigRoot
Root folder path holds the rendering config json files for pose characters
Declaration
public string SlotCharacterRenderingConfigRoot { get; }
SlotInventoryRoot
Root folder path holds the inventory files
Declaration
public string SlotInventoryRoot { get; }
SlotMetaRoot
Meta root folder path of the current selected slot
Declaration
public string SlotMetaRoot { get; }
SlotRoot
Folder path of the current selected slot
Declaration
public string SlotRoot { get; }
SlotUserMapRoot
Map root folder of the current selected slot. Maps inside this folder can be edit by player
Declaration
public string SlotUserMapRoot { get; }
SoundRoot
Folder that holds SFX audio files
Declaration
public string SoundRoot { get; }
UniverseMetaRoot
Root meta folder path. This folder hold random text data.
Declaration
public string UniverseMetaRoot { get; }
UniverseRoot
Root folder path of this universe
Declaration
public string UniverseRoot { get; }
Methods
LoadFromFile(string, bool)
Create a new universe instance from file
Declaration
public static Universe LoadFromFile(string universeFolder, bool useBuiltInSavingRoot = true)
ReloadSavingSlot(int, bool)
Change saving slot
Declaration
public void ReloadSavingSlot(int newSlot, bool forceReload = false)
Parameters
Type | Name | Description |
---|---|---|
int | newSlot | Slot index |
bool | forceReload | Perform this function even the "newSlot" is same with current |
SetSavingRoot(string, int)
Set saving data of the universe instance
Declaration
public void SetSavingRoot(string newSavingRoot, int slot)