JournalManager
Documents the JournalManager class and its functions.
NOT DOCUMENTED
We currently don't have information on how these functions work. They are being documented here for visibility.
Invoking JournalManager
To invoke the journal manager, use the following Global function:
jm = Game.JournalManager()
Sub-functions
ChangeEntryState
ChangeEntryState(uniquePath : String, className : String, state : gameJournalEntryState, notifyOption : JournalNotifyOption) : Bool;
ChangeEntryStateByHash
ChangeEntryStateByHash(hash : Uint32, state : gameJournalEntryState, notifyOption : JournalNotifyOption);
CreateScriptedQuestFromTemplate
CreateScriptedQuestFromTemplate(templateQuestEntryId : String, uniqueId : String, title : String) : Bool;
DebugShowAllPoiMappins
DebugShowAllPoiMappins();
DeleteScriptedQuest
DeleteScriptedQuest(templateQuestEntryId : String, uniqueId : String) : Bool;
GetBriefings
GetBriefings(context : JournalRequestContext, out entries : array:wref:JournalEntry);
GetChildren
GetChildren(parentEntry : wref:JournalEntry, filter : JournalRequestStateFilter, out childEntries : array:wref:JournalEntry);
GetCodexCategories
GetCodexCategories(context : JournalRequestContext, out entries : array:wref:JournalEntry);
GetContactDataArray
GetContactDataArray(includeUnknown : Bool) : array:ref:IScriptable;
GetContacts
GetContacts(context : JournalRequestContext, out entries : array:wref:JournalEntry);
GetConversations
GetConversations(contactEntry : wref:JournalEntry, out conversations : array:wref:JournalEntry);
GetDistanceToNearestMappin
GetDistanceToNearestMappin(entry : wref:JournalQuestObjective) : Float;
GetDistrict
GetDistrict(entry : wref:JournalEntry) : wref:District_Record;
GetEntry
GetEntry(hash : Uint32) : wref:JournalEntry;
GetEntryByString
GetEntryByString(uniquePath : String, className : String) : wref:JournalEntry;
GetEntryHash
GetEntryHash(entry : wref:JournalEntry) : Int32;
GetEntryState
GetEntryState(entry : wref:JournalEntry) : gameJournalEntryState;
GetEntryTimestamp
GetEntryTimestamp(entry : wref:JournalEntry) : GameTime;
GetFlattenedMessagesAndChoices
GetFlattenedMessagesAndChoices(contactEntry : wref:JournalEntry, out messages : array:wref:JournalEntry, out choiceEntries : array:wref:JournalEntry);
GetInternetPages
GetInternetPages(context : JournalRequestContext, out entries : array:wref:JournalEntry);
GetInternetSites
GetInternetSites(context : JournalRequestContext, out entries : array:wref:JournalEntry);
GetMainInternetPage
GetMainInternetPage(siteEntry : wref:JournalInternetSite) : wref:JournalInternetPage;
GetMessagesAndChoices
GetMessagesAndChoices(conversationEntry : wref:JournalEntry, out messages : array:wref:JournalEntry, out choiceEntries : array:wref:JournalEntry);
GetMetaQuestData
GetMetaQuestData(metaQuestId : gamedataMetaQuest) : JournalMetaQuestScriptedData;
GetMetaQuests
GetMetaQuests(context : JournalRequestContext, out entries : array:wref:JournalEntry);
GetObjectiveCurrentCounter
GetObjectiveCurrentCounter(entry : wref:JournalQuestObjective) : Int32;
GetObjectiveTotalCounter
GetObjectiveTotalCounter(entry : wref:JournalQuestObjective) : Int32;
GetOnscreens
GetOnscreens(context : JournalRequestContext, out entries : array:ref:JournalOnscreensStructuredGroup);
GetParentEntry
GetParentEntry(childEntry : wref:JournalEntry) : wref:JournalEntry;
GetPointOfInterestMappinHashFromQuestHash
GetPointOfInterestMappinHashFromQuestHash(hash : Uint32) : Uint32;
GetQuests
GetQuests(context : JournalRequestContext, out entries : array:wref:JournalEntry);
GetRandomChildren
GetRandomChildren(parentEntry : wref:JournalEntry, filter : JournalRequestStateFilter, childCount : Int32, out childEntries : array:wref:JournalEntry);
GetRecommendedLevel
GetRecommendedLevel(entry : wref:JournalEntry) : Uint32;
GetTarots
GetTarots(context : JournalRequestContext, out entries : array:wref:JournalEntry);
GetTrackedEntry
GetTrackedEntry() : wref:JournalEntry;
HasAnyDelayedStateChanges
HasAnyDelayedStateChanges() : Bool;
IsAttachedToAnyActiveQuest
IsAttachedToAnyActiveQuest(hash : Int32) : Bool;
IsAttachedToTrackedObjective
IsAttachedToTrackedObjective(hash : Int32) : Bool;
IsEntryTracked
IsEntryTracked(entry : wref:JournalEntry) : Bool;
IsEntryVisited
IsEntryVisited(entry : wref:JournalEntry) : Bool;
OnQuestEntryTracked
OnQuestEntryTracked(entry : wref:JournalEntry) : Bool;
OnQuestEntryUntracked
OnQuestEntryUntracked(entry : wref:JournalEntry) : Bool;
RegisterScriptCallback
RegisterScriptCallback(obj : ref:IScriptable, functionName : CName, type : gameJournalListenerType);
SetEntryVisited
SetEntryVisited(entry : wref:JournalEntry, value : Bool);
SetScriptedQuestEntryState
SetScriptedQuestEntryState(templateQuestEntryId : String, uniqueId : String, templatePhaseAndObjectivePath : String, state : gameJournalEntryState, notifyOption : JournalNotifyOption, track : Bool);
SetScriptedQuestMappinData
SetScriptedQuestMappinData(templateQuestEntryId : String, uniqueId : String, templatePhaseObjectiveAndMappinPath : String, mappinData : MappinData) : Bool;
SetScriptedQuestMappinEntityID
SetScriptedQuestMappinEntityID(templateQuestEntryId : String, uniqueId : String, templatePhaseObjectiveAndMappinPath : String, entityID : EntityID) : Bool;
SetScriptedQuestMappinSlotName
SetScriptedQuestMappinSlotName(templateQuestEntryId : String, uniqueId : String, templatePhaseObjectiveAndMappinPath : String, recordID : TweakDBID) : Bool;
SetScriptedQuestObjectiveDescription
SetScriptedQuestObjectiveDescription(templateQuestEntryId : String, uniqueId : String, templatePhaseAndObjectivePath : String, description : String) : Bool;
TrackEntry
TrackEntry(entry : wref:JournalEntry);
TrackPrevNextEntry
TrackPrevNextEntry(next : Bool);
UnregisterScriptCallback
UnregisterScriptCallback(obj : ref:IScriptable, functionName : CName);