FB2MemoryComponent

Overview

Component that manages memories.

Metadata

Field	Value
Kind	`component`
Environment	B2 - Simulation
Category	`components`
Extends	`FB2Component`
Require	`require('Components.B2MemoryComponent')`

Properties (5)

Name	Type	Description
`LastReadMemoryListTime`	`integer`
`Milestones`	`table<string, FB1Milestone>`	Milestones.
`SocialContextTable`	`table<FB1EntityId, FB1SocialContext>`	Map of FB1SocialContext per EntityId.
`TalkingInteractionBag`	`string`
`bIsTalkingFinished`	`boolean`

Functions (29)

Function	Parameters	Returns	Description
`AddMemory`	MemoryDtId: `string`, TargetEntityId: `FB1EntityId`	`-`	Adds Memory.
`AddMemoryFromRelationshipRecordId`	TargetEntityId: `FB1EntityId`, RelationshipRecordId: `string`	`-`	Looks up the memory id via B1MemoryUtil::GetMemoryIdByRelationshipRecordId from a RelationshipRecordId, then adds the memory to the Owner (TargetEntityId is the relationship partner).
`AddMilestone`	InMilestoneId: `string`, InTargetEntityId: `FB1EntityId`, InTargetDtId: `string`	`-`	Adds Milestone.
`ClearAllSocialContexts`	`-`	`-`	Removes all of my SocialContexts and also removes my memory from the B2MemoryComponent of target entities.
`GetDefaultCityMoveDataPolicy`	`-`	`EB1CityMoveDataPolicy`	Returns Default City Move Data Policy.
`GetHiddenMilestoneIds`	`-`	`table<string, boolean>`	Returns the list of milestone IDs whose ConditionId condition is not met.
`GetMilestones`	`-`	`table<string, FB1Milestone>`	Returns Milestones.
`GetSocialContext`	TargetEntityId: `FB1EntityId`	`FB1SocialContext`	Looks up the SocialContext by TargetEntityId and returns an FB1SocialContext pointer.
`GetTalkSocialContext`	EntityId: `FB1EntityId`, OutTalkSocialContext: `FB1TalkSocialContext`	`-`	Takes an EntityId and an FB1TalkSocialContext and sets its values.
`GetUnreadMemoryCount`	`-`	`integer`	Returns the number of unread memories based on LastReadMemoryListTime.
`HasMemory`	MemoryDtId: `string`	`boolean`	Returns whether a SocialContext with the given MemoryDtId exists.
`HasMemoryWithTarget`	MemoryDtId: `string`, TargetEntityId: `FB1EntityId`	`boolean`	Returns whether the LatestContextMemory in the SocialContext with a specific TargetEntityId matches MemoryDtId.
`HasMilestone`	MilestoneId: `string`	`boolean`	Returns whether it has Milestone.
`IsActiveTalkRefusedMemory`	InEntityId: `FB1EntityId`	`boolean`	Returns whether a SocialContext with MoodScore below 0 is in the Active state.
`IsBoostedTarget`	EntityId: `FB1EntityId`	`boolean`	Returns whether Boosted Target.
`IsTalkRefused`	InEntityId: `FB1EntityId`	`boolean`	Returns whether talk is refused, by probability, when the SocialContext MoodScore is below 0.
`MakeCompactTargetMemoryList`	OutCompactMemories: `FB1CompactTargetMemory[]`	`-`	Builds and returns an FB1CompactTargetMemory array from SocialContext.
`MakeSocialContextPacketData`	OutSocialContexts: `FB1TargetMemory[]`	`-`	Loops over all SocialContexts and returns the Active ones as an FB1TargetMemory array.
`OnAcquiredMilestone`	MilestoneId: `string`, TargetEntityId: `FB1EntityId`, TargetDtId: `string`	`-`	Callback invoked on Acquired Milestone.
`OnAddedTargetSocialContextState`	TargetEntityId: `FB1EntityId`, TargetMoodScore: `number`, MemoryDtId: `string`, bIsActivated: `boolean`	`-`	Updates the SocialContext state for a TargetEntityId according to TargetMoodScore.
`OnHourChanged`	Before: `FDateTime`, After: `FDateTime`	`-`	Callback invoked on Hour Changed.
`OnInteractionFinished`	InteractionId: `string`, TargetEntityId: `FB1EntityId`, InteractionTags: `string[]`	`-`	Callback invoked on Interaction Finished.
`OnInteractionSequenceFinished`	InteractionBagId: `string`, CoopId: `string`, TargetEntityId: `FB1EntityId`	`-`	Callback invoked on Interaction Sequence Finished.
`OnMinuteChanged`	Before: `FDateTime`, After: `FDateTime`	`-`	Callback invoked on Minute Changed.
`OnTalkSequenceFinished`	InteractionBagId: `string`	`-`	Callback invoked on Talk Sequence Finished.
`ReadMilestones`	InMilestoneIdList: `string[]`	`-`
`RemoveSocialContext`	TargetEntityId: `FB1EntityId`	`-`	Removes the SocialContext for a specific entity.
`SolveSocialContext`	bIsExpired: `boolean`, TargetEntityId: `FB1EntityId`	`-`	Changes a SocialContext to the resolved state.
`UpdateReadMemoryListTime`	`-`	`-`	Updates Read Memory List Time.

Override points (18)

Implement these in Lua as FB2MemoryComponent.Override_Name = function(...) end.

Function	Parameters	Returns	Description
`Override_AddMemory`	MemoryDtId: `string`, TargetEntityId: `FB1EntityId`	`-`	Adds Memory.
`Override_AddMemoryFromRelationshipRecordId`	TargetEntityId: `FB1EntityId`, RelationshipRecordId: `string`	`-`	Looks up the memory id via B1MemoryUtil::GetMemoryIdByRelationshipRecordId from a RelationshipRecordId, then adds the memory to the Owner (TargetEntityId is the relationship partner).
`Override_AddMilestone`	InMilestoneId: `string`, InTargetEntityId: `FB1EntityId`, InTargetDtId: `string`	`-`	Adds Milestone.
`Override_ClearAllSocialContexts`	`-`	`-`	Removes all of my SocialContexts and also removes my memory from the B2MemoryComponent of target entities.
`Override_HasMemory`	MemoryDtId: `string`	`boolean`	Returns whether a SocialContext with the given MemoryDtId exists.
`Override_HasMemoryWithTarget`	MemoryDtId: `string`, TargetEntityId: `FB1EntityId`	`boolean`	Returns whether the LatestContextMemory in the SocialContext with a specific TargetEntityId matches MemoryDtId.
`Override_HasMilestone`	MilestoneId: `string`	`boolean`	Returns whether it has Milestone.
`Override_OnAcquiredMilestone`	MilestoneId: `string`, TargetEntityId: `FB1EntityId`, TargetDtId: `string`	`-`	Callback invoked on Acquired Milestone.
`Override_OnAddedTargetSocialContextState`	TargetEntityId: `FB1EntityId`, TargetMoodScore: `number`, MemoryDtId: `string`, bIsActivated: `boolean`	`-`	Updates the SocialContext state for a TargetEntityId according to TargetMoodScore.
`Override_OnHourChanged`	Before: `FDateTime`, After: `FDateTime`	`-`	Callback invoked on Hour Changed.
`Override_OnInteractionFinished`	InteractionId: `string`, TargetEntityId: `FB1EntityId`, InteractionTags: `string[]`	`-`	Callback invoked on Interaction Finished.
`Override_OnInteractionSequenceFinished`	InteractionBagId: `string`, CoopId: `string`, TargetEntityId: `FB1EntityId`	`-`	Callback invoked on Interaction Sequence Finished.
`Override_OnMinuteChanged`	Before: `FDateTime`, After: `FDateTime`	`-`	Callback invoked on Minute Changed.
`Override_OnTalkSequenceFinished`	InteractionBagId: `string`	`-`	Callback invoked on Talk Sequence Finished.
`Override_ReadMilestones`	InMilestoneIdList: `string[]`	`-`
`Override_RemoveSocialContext`	TargetEntityId: `FB1EntityId`	`-`	Removes the SocialContext for a specific entity.
`Override_SolveSocialContext`	bIsExpired: `boolean`, TargetEntityId: `FB1EntityId`	`-`	Changes a SocialContext to the resolved state.
`Override_UpdateReadMemoryListTime`	`-`	`-`	Updates Read Memory List Time.