Adventure Creator
1.79.1
An adventure game toolkit for Unity, by Chris Burton, ICEBOX Studios 2013-2022
|
Public Member Functions | |
void | OnInitPersistentEngine () |
void | OpenDocument (Document document) |
Opens a Document. To view it, a Menu with an Appear Type of OnViewDocument must be present in the Menu Manager. More... | |
void | OpenDocument (int documentID) |
Opens a Document. To view it, a Menu with an Appear Type of OnViewDocument must be present in the Menu Manager. More... | |
void | CloseDocument () |
bool | DocumentIsInCollection (int documentID) |
Checks if a particular Document is in the Player's collection More... | |
bool | HasBeenRead (Document document) |
Checks if a given Document has been read by the Player More... | |
bool | HasBeenRead (int documentID) |
Checks if a given Document has been read by the Player More... | |
DocumentInstance | GetCollectedDocumentInstance (Document document) |
Gets the DocumentInstance class for a Document present in the Player's collection More... | |
DocumentInstance | GetCollectedDocumentInstance (int ID) |
Gets the DocumentInstance class for a Document present in the Player's collection More... | |
void | AddToCollection (Document document) |
Adds a Document to the Player's own collection More... | |
void | AddToCollection (int documentID) |
Adds a Document to the Player's own collection More... | |
void | RemoveFromCollection (Document document) |
Removes a Document from the Player's own collection More... | |
void | RemoveFromCollection (int documentID) |
Removes a Document from the Player's own collection More... | |
void | ClearCollection () |
int | GetLastOpenPage (DocumentInstance documentInstance) |
Gets the page number to return to when opening a previously-read Document More... | |
void | SetLastOpenPage (DocumentInstance documentInstance, int page) |
Sets the page number to return to when a given Document is next opened More... | |
PlayerData | SavePlayerDocuments (PlayerData playerData) |
Updates a PlayerData class with its own variables that need saving. More... | |
void | AssignPlayerDocuments (PlayerData playerData) |
Restores saved data from a PlayerData class More... | |
int[] | GetCollectedDocumentIDs (int[] limitToCategoryIDs=null) |
Gets an array of ID numbers that each represent a Document held by the Player More... | |
Protected Member Functions | |
void | GetDocumentsOnStart () |
Protected Attributes | |
DocumentInstance | activeDocumentInstance |
readonly Dictionary< int, DocumentInstance > | collectedDocumentsDict = new Dictionary<int, DocumentInstance> () |
Properties | |
DocumentInstance | ActiveDocumentInstance [get] |
Document? | ActiveDocument [get] |
This script stores information about the currently-open Document, as well as any runtime-made changes to all Documents.
void AC.RuntimeDocuments.AddToCollection | ( | Document | document | ) |
void AC.RuntimeDocuments.AddToCollection | ( | int | documentID | ) |
void AC.RuntimeDocuments.AssignPlayerDocuments | ( | PlayerData | playerData | ) |
Restores saved data from a PlayerData class
playerData | The PlayerData class to load from |
void AC.RuntimeDocuments.ClearCollection | ( | ) |
Removes all Documents from the Player's own collection
void AC.RuntimeDocuments.CloseDocument | ( | ) |
Closes the currently-viewed Document, if there is one
bool AC.RuntimeDocuments.DocumentIsInCollection | ( | int | documentID | ) |
int [] AC.RuntimeDocuments.GetCollectedDocumentIDs | ( | int[] | limitToCategoryIDs = null | ) |
DocumentInstance AC.RuntimeDocuments.GetCollectedDocumentInstance | ( | Document | document | ) |
Gets the DocumentInstance class for a Document present in the Player's collection
document | The original Document, as defined in the Inventory Manager |
DocumentInstance AC.RuntimeDocuments.GetCollectedDocumentInstance | ( | int | ID | ) |
Gets the DocumentInstance class for a Document present in the Player's collection
ID | The ID of the Document |
int AC.RuntimeDocuments.GetLastOpenPage | ( | DocumentInstance | documentInstance | ) |
bool AC.RuntimeDocuments.HasBeenRead | ( | Document | document | ) |
bool AC.RuntimeDocuments.HasBeenRead | ( | int | documentID | ) |
void AC.RuntimeDocuments.OnInitPersistentEngine | ( | ) |
This is called when the game begins, and sets up the initial state.
void AC.RuntimeDocuments.OpenDocument | ( | Document | document | ) |
void AC.RuntimeDocuments.OpenDocument | ( | int | documentID | ) |
void AC.RuntimeDocuments.RemoveFromCollection | ( | Document | document | ) |
void AC.RuntimeDocuments.RemoveFromCollection | ( | int | documentID | ) |
PlayerData AC.RuntimeDocuments.SavePlayerDocuments | ( | PlayerData | playerData | ) |
Updates a PlayerData class with its own variables that need saving.
playerData | The original PlayerData class |
void AC.RuntimeDocuments.SetLastOpenPage | ( | DocumentInstance | documentInstance, |
int | page | ||
) |
|
get |
The currently-active Document Instance