FB2PreferenceComponent

Overview

Component that manages preferences.

Metadata

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

Properties (4)

Name	Type	Description
`MaxPreferenceCount`	`integer`
`PreferenceBuffMap`	`table<string, FB1PreferenceBuffData>`
`PreferenceMap`	`table<string, boolean>`
`PreferencesCheckSum`	`integer`	PerferenceMap CheckSum [7/12/2024 ahnseok.kim]

Functions (30)

Function	Parameters	Returns	Description
`AddPreferenceBuffData`	InPreferenceId: `string`, bLike: `boolean`	`-`	Adds Preference Buff Data.
`AddPreferenceData`	InPreferenceId: `string`, bLike: `boolean`, bSendPacket: `boolean`	`-`	Adds Preference Data.
`AddPreferenceModifierData`	InPreferenceId: `string`, bLike: `boolean`	`-`	Adds Preference Modifier Data.
`CalculateCheckSum`	`-`	`integer`	CRC check for change detection.
`ChangeContentSlotNum`	InGrowthStep: `EB1GrowthStep`	`-`	GrowthChangeInterface Begin
`FilterContentData`	InGrowthStep: `EB1GrowthStep`	`-`
`GetCityMovePolicyMap`	InCityMoveDataPolicyType: `EB1CityMoveDataPolicyType`	`table<string, EB1CityMoveDataPolicy>`	Returns City Move Policy Map.
`GetCurrentCheckSum`	`-`	`integer`	Returns Current Check Sum.
`GetDefaultCityMoveDataPolicy`	`-`	`EB1CityMoveDataPolicy`	Returns Default City Move Data Policy.
`GetFoodPreferenceState`	InFoodTags: `string[]`, OutPreferenceId: `string`	`EB1PreferenceState`	Returns Food Preference State.
`GetMaxPreferenceCount`	`-`	`integer`	Returns Max Preference Count.
`GetPreferenceBuffMap`	`-`	`table<string, FB1PreferenceBuffData>`	Returns Preference Buff Map.
`GetPreferenceMap`	`-`	`table<string, boolean>`	Returns Preference Map.
`GetPreferenceState`	InPreferenceId: `string`	`EB1PreferenceState`	Returns Preference State.
`IsPreferenceLike`	InPreferenceId: `string`	`boolean`	Returns whether Preference Like.
`OnFinishInteraction`	InReactionContext: `FB2PreferenceReactionContext`, IsCanceled: `boolean`	`-`	Callback invoked on Finish Interaction.
`OnFinishMission`	InMissionDtKey: `string`, InMissionId: `FB1MissionId`	`-`	Callback invoked on Finish Mission.
`OnPlayerPreferenceUpdated`	`-`	`-`	Callback invoked on Player Preference Updated.
`OnStartInteraction`	InOutReactionContext: `FB2PreferenceReactionContext`	`-`	Callback invoked on Start Interaction.
`RefreshModifierList`	InPreferenceId: `string`, InPreferenceState: `EB1PreferenceState`	`-`
`RemovePreferenceBuffData`	InPreferenceId: `string`	`-`	Removes Preference Buff Data.
`RemovePreferenceModifierData`	InPreferenceId: `string`	`-`	Removes Preference Modifier Data.
`ReplaceContentData`	InPrevGrowthStep: `EB1GrowthStep`, InCurrGrowthStep: `EB1GrowthStep`	`-`
`Send_S_UpdatePreferenceData`	`-`	`-`
`SetPreferenceByTrait`	InTraitList: `string[]`	`-`	Sets Preference By Trait.
`SetPreferenceDisalbedTimer`	`-`	`-`	Sets Preference Disalbed Timer.
`StartFoodReaction`	InOutReactionContext: `FB2PreferenceReactionContext`	`-`	Starts Food Reaction.
`TryGetPreferenceReactionBagId`	InReactionContext: `FB2PreferenceReactionContext`, OutReactionBagId: `string`, OutPreferenceId: `string`	`boolean`
`TryPlayPreferenceFx`	bInLike: `boolean`	`-`
`UpdateCalculatedCheckSum`	`-`	`boolean`	Updates Calculated Check Sum.

Override points (16)

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

Function	Parameters	Returns	Description
`Override_AddPreferenceBuffData`	InPreferenceId: `string`, bLike: `boolean`	`-`	Adds Preference Buff Data.
`Override_AddPreferenceData`	InPreferenceId: `string`, bLike: `boolean`, bSendPacket: `boolean`	`-`	Adds Preference Data.
`Override_AddPreferenceModifierData`	InPreferenceId: `string`, bLike: `boolean`	`-`	Adds Preference Modifier Data.
`Override_CalculateCheckSum`	`-`	`integer`	CRC check for change detection.
`Override_ChangeContentSlotNum`	InGrowthStep: `EB1GrowthStep`	`-`	GrowthChangeInterface Begin
`Override_FilterContentData`	InGrowthStep: `EB1GrowthStep`	`-`
`Override_OnFinishInteraction`	InReactionContext: `FB2PreferenceReactionContext`, IsCanceled: `boolean`	`-`	Callback invoked on Finish Interaction.
`Override_OnFinishMission`	InMissionDtKey: `string`, InMissionId: `FB1MissionId`	`-`	Callback invoked on Finish Mission.
`Override_OnPlayerPreferenceUpdated`	`-`	`-`	Callback invoked on Player Preference Updated.
`Override_OnStartInteraction`	InOutReactionContext: `FB2PreferenceReactionContext`	`-`	Callback invoked on Start Interaction.
`Override_RefreshModifierList`	InPreferenceId: `string`, InPreferenceState: `EB1PreferenceState`	`-`
`Override_RemovePreferenceBuffData`	InPreferenceId: `string`	`-`	Removes Preference Buff Data.
`Override_RemovePreferenceModifierData`	InPreferenceId: `string`	`-`	Removes Preference Modifier Data.
`Override_ReplaceContentData`	InPrevGrowthStep: `EB1GrowthStep`, InCurrGrowthStep: `EB1GrowthStep`	`-`
`Override_Send_S_UpdatePreferenceData`	`-`	`-`
`Override_UpdateCalculatedCheckSum`	`-`	`boolean`	Updates Calculated Check Sum.