FB2InteractionComponent

Overview

Component that manages the interaction queue/execution.

Metadata

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

Properties (21)

Name	Type	Description
`ActiveInteractionCooltimeRealTime`	`number`
`AttackComboIndex`	`integer`	Attack combo state. (Attack is right-hand only for now.)
`AttackComboLastFinishRealTime`	`number`
`AttackComboProfileId`	`string`
`AutoFindRepeatState`	`FB2AutoFindRepeatState`
`CachedInteractionSnapshot`	`FB1InteractionQueueUIData[]`
`CompetitionContext`	`FB2CompetitionContext`
`InteractionBagHistoryCheckTicks`	`integer`
`InteractionBagHistorys`	`table<string, FB2InteractionHistory>`
`InteractionBagRepeatCount`	`integer`
`InteractionOpenedReasons`	`EB1InteractionOpenedReason[]`
`InteractionQueue`	`FB2InteractionQueue[]`
`InteractionQueueIdCounter`	`integer`
`LastAttackBlendOutSec`	`number`
`LastInteractionInfoIndex`	`integer`
`LastInteractionInfoList`	`FB2CacheLastInteractionInfo[]`
`LatestFinishInteractionBagId`	`string`
`MultiFlag`	`boolean`
`PendingCancelQueueIds`	`table<integer, EB1InteractionCancelReason>`
`RecentlyCancelledItems`	`FB1InteractionQueueUIData[]`
`bStructureDirty`	`boolean`

Functions (110)

Function	Parameters	Returns	Description
`AddAndUpdateInteractionQueue`	InRequest: `FB2AddInteractionQueueRequest`	`EB2InteractionResult`	Adds the interaction and updates existing interactions.
`AddInteractionQueueByParam`	InTargetEntityId: `FB1EntityId`, InImpactPoint: `FVector`, InInteractionBagId: `string`, InInteractionPlayReason: `EB1InteractionPlayReason`, bInsertFront: `boolean`, bUseMultiSequence: `boolean`, Reason: `string`, bSendPacket: `boolean`, bIsNextInteraction: `boolean`	`EB1AddInteractionQueueResult`	Adds Interaction Queue By Param.
`AddInteractionQueueByParamWithSubject`	InTargetEntityId: `FB1EntityId`, InImpactPoint: `FVector`, InInteractionBagId: `string`, InInteractionPlayReason: `EB1InteractionPlayReason`, bInsertFront: `boolean`, bUseMultiSequence: `boolean`, Reason: `string`, bSendPacket: `boolean`, bIsNextInteraction: `boolean`, InTalkSubjectEntityId: `FB1EntityId`	`EB1AddInteractionQueueResult`	Adds Interaction Queue By Param With Subject.
`AddInteractionQueueByQueue`	InInteraction: `FB2InteractionQueue`, bUseMultiSequence: `boolean`, Reason: `string`, bSendPacket: `boolean`, bIsNextInteraction: `boolean`, bSkipPickedObjectSelectionSetValidation: `boolean`, InInsertIndex: `integer`	`EB1AddInteractionQueueResult`	Adds Interaction Queue By Queue.
`AddOpenedInteractionPanelReason`	InOpenedReason: `EB1InteractionOpenedReason`	`-`	Adds Opened Interaction Panel Reason.
`ApplyActiveInteractionCooltime`	`-`	`-`	Applies Active Interaction Cooltime.
`CanActiveInteraction`	`-`	`boolean`	Returns whether it can Active Interaction.
`CancelCoopInteractions`	InSchedulerId: `FB1EntityId`	`-`
`CancelScheduleMoveInteractions`	InCancelReason: `EB1InteractionCancelReason`	`-`
`ChangePickedActorEntityId`	InChangedEntityId: `FB1EntityId`	`-`
`ChangeTalkInteractionBagUIData`	InInteractionBagId: `string`, InExecutedTalkCount: `integer`	`-`
`CheckMulti`	InInteractionBagId: `string`, InSelfEntityId: `FB1EntityId`, InTargetEntityId: `FB1EntityId`, InImpactPoint: `FVector`, InPlayReason: `EB1InteractionPlayReason`	`boolean`	Checks Multi.
`ClearCurrentInteraction`	`-`	`-`	Clears Current Interaction.
`ClearInteractionQueue`	InCancelReason: `EB1InteractionCancelReason`, bCancelCurrentInteraction: `boolean`	`-`	Clears Interaction Queue.
`CollectTalkSocialClusterCandidates`	OutSpaceTargetInfoList: `table<FB1FilterTargetInfo, boolean>`, OutIsAnywhere: `boolean`	`-`
`ExpireLastInteractionInfo`	`-`	`-`
`GetActionVectorParameter`	InType: `EB2ActionVectorParamType`, OutValue: `FVector`	`boolean`	Returns Action Vector Parameter.
`GetCurrentAction`	Self: `FB2InteractionComponent`, Type: `EB1ActionType`	`-`	Returns Current Action.
`GetCurrentActionId`	OutActionId: `string`	`-`	Returns Current Action Id.
`GetCurrentActionType`	`-`	`EB1ActionType`	Returns Current Action Type.
`GetCurrentCoopSchedulerId`	`-`	`FB1EntityId`	Returns Current Coop Scheduler Id.
`GetCurrentCoopStartInfo`	`-`	`FB1CoopStartInfo`	Returns Current Coop Start Info.
`GetCurrentInteractionBagId`	`-`	`string`	Returns Current Interaction Bag Id.
`GetCurrentInteractionId`	`-`	`string`	Returns Current Interaction Id.
`GetCurrentInteractionPickedEntityId`	`-`	`FB1EntityId`	Returns Current Interaction Picked Entity Id.
`GetCurrentInteractionPlayReason`	`-`	`EB1InteractionPlayReason`	Returns Current Interaction Play Reason.
`GetCurrentInteractionQueueId`	`-`	`integer`	Returns Current Interaction Queue Id.
`GetCurrentInteractionSequenceIndex`	`-`	`integer`	Returns Current Interaction Sequence Index.
`GetCurrentInteractionTargetEntityId`	`-`	`FB1EntityId`	Returns Current Interaction Target Entity Id.
`GetCurrentSelectedSpaceTargetEntityId`	`-`	`FB1EntityId`	Returns Current Selected Space Target Entity Id.
`GetCurrentStatId`	`-`	`string`	Returns Current Stat Id.
`GetCurrentTargetSlot`	InTargetEntityId: `FB1EntityId`	`FB2TargetSlotParam`	Returns Current Target Slot.
`GetCurrentZoiGroupRotationCoopId`	`-`	`string`	Returns Current Zoi Group Rotation Coop Id.
`GetDefaultCityMoveDataPolicy`	`-`	`EB1CityMoveDataPolicy`	Returns Default City Move Data Policy.
`GetInteractionId`	InQueueId: `B2InteractionQueueId`	`string`	Returns Interaction Id.
`GetInteractionInCurrentStateHint`	`-`	`string[]`	Returns Interaction In Current State Hint.
`GetInteractionPickedEntityId`	InQueueId: `B2InteractionQueueId`	`FB1EntityId`	Returns Interaction Picked Entity Id.
`GetInteractionPlayReason`	InQueueId: `B2InteractionQueueId`	`EB1InteractionPlayReason`	Returns Interaction Play Reason.
`GetInteractionQueueCount`	`-`	`integer`	Returns Interaction Queue Count.
`GetInteractionSequencePlayerState`	`-`	`EB2PlayerState`	Returns Interaction Sequence Player State.
`GetInteractionTargetEntityId`	InQueueId: `B2InteractionQueueId`	`FB1EntityId`	Returns Interaction Target Entity Id.
`GetLastGrabEntityId`	InQueueId: `B2InteractionQueueId`	`FB1EntityId`	Returns Last Grab Entity Id.
`GetLastInteractionInfo`	`-`	`FB2CacheLastInteractionInfo[]`	Returns Last Interaction Info.
`GetMainInteractionId`	InQueueId: `B2InteractionQueueId`	`string`	Returns Main Interaction Id.
`GetPutDownEntityId`	`-`	`FB1EntityId`	Returns Put Down Entity Id.
`GetRemainProgressTime`	`-`	`number`	Returns Remain Progress Time.
`HasCurrentInteractionBagTag`	InTag: `string`	`boolean`	Returns whether it has Current Interaction Bag Tag.
`HasMergedActions`	`-`	`boolean`	Returns whether it has Merged Actions.
`IsAccumulatingProgressTime`	`-`	`boolean`	Returns whether Accumulating Progress Time.
`IsAvailablePosture`	InPostureId: `string`	`boolean`	Returns whether Available Posture.
`IsCurrentActionWalkType`	`-`	`boolean`	Returns whether Current Action Walk Type.
`IsCurrentCancelRestartType`	`-`	`boolean`	Returns whether Current Cancel Restart Type.
`IsCurrentInteractionAlmostFinished`	InThreshold: `number`	`boolean`	Returns whether Current Interaction Almost Finished.
`IsCurrentInteractionAutoFindRepeat`	`-`	`boolean`	Returns whether Current Interaction Auto Find Repeat.
`IsCurrentInteractionCoop`	`-`	`boolean`	Returns whether Current Interaction Coop.
`IsCurrentInteractionHasSpaceTarget`	`-`	`boolean`	Returns whether Current Interaction Has Space Target.
`IsCurrentInteractionInfinite`	`-`	`boolean`	Checks whether any currently running interaction (including multi) is an infinite interaction (bInfiniteInteraction).
`IsCurrentInteractionNeverInterrupt`	`-`	`boolean`	Returns whether Current Interaction Never Interrupt.
`IsCurrentInteractionNonCancelable`	`-`	`boolean`	Returns whether Current Interaction Non Cancelable.
`IsCurrentInteractionScheduleMove`	`-`	`boolean`	Returns whether Current Interaction Schedule Move.
`IsCurrentInteractionTalk`	`-`	`boolean`	Returns whether Current Interaction Talk.
`IsCurrentInteractionUserPlayReason`	`-`	`boolean`	Returns whether Current Interaction User Play Reason.
`IsCurrentSelectedSpaceTargetSit`	`-`	`boolean`	Returns whether Current Selected Space Target Sit.
`IsFullInteractionQueue`	`-`	`boolean`	Returns whether Full Interaction Queue.
`IsInQueue_InteractionBagId`	InteractionBagId: `string`	`boolean`	Returns whether In Queue_Interaction Bag Id.
`IsInQueue_RewardStatId`	StatId: `string`, IncludeCurrentInteraction: `boolean`	`boolean`	Returns whether In Queue_Reward Stat Id.
`IsInteractionEnabled`	`-`	`boolean`	Returns whether Interaction Enabled.
`IsLastInteractionLabel`	`-`	`boolean`	Returns whether Last Interaction Label.
`IsMultiInteractionRunning`	`-`	`boolean`	Returns whether Multi Interaction Running.
`IsMultiSequenceAble`	`-`	`boolean`	Returns whether Multi Sequence Able.
`IsNextActionRabbitHole`	`-`	`boolean`	Checks whether a RabbitholeAction remains among the character's pending actions.
`IsOpenedInteractionPanel`	`-`	`boolean`	Returns whether Opened Interaction Panel.
`IsPendingCoop`	`-`	`boolean`	Returns whether Pending Coop.
`IsPlayAutoPutDownInteraction`	`-`	`boolean`	Returns whether Play Auto Put Down Interaction.
`IsPlayingInteraction`	`-`	`boolean`	Returns whether Playing Interaction.
`IsPlayingLastAction`	`-`	`boolean`	Returns whether Playing Last Action.
`IsPlayingNonTalkInteraction`	`-`	`boolean`	Returns whether Playing Non Talk Interaction.
`IsQueueEmpty`	`-`	`boolean`	Returns whether Queue Empty.
`IsSubActionStartAble`	`-`	`boolean`	Returns whether Sub Action Start Able.
`LinkTalkInteractionToCurrent`	InInteractionId: `string`, InTargetId: `FB1EntityId`, InTalkInstanceId: `FB1TalkInstanceId`	`-`
`OnB2PreBeginPlay`	`-`	`-`	Callback invoked on B2 Pre Begin Play.
`OnCanceledInteractionQueue`	InQueueId: `integer`, InCancelImmediately: `boolean`	`-`	Callback invoked on Canceled Interaction Queue.
`OnChangeGrowthStep`	InPrev: `EB1GrowthStep`, InCurr: `EB1GrowthStep`	`-`	Callback invoked on Change Growth Step.
`OnChangePossess`	`-`	`-`	Callback invoked on Change Possess.
`OnChangeRealTimeSecondsPerGameMinute`	`-`	`-`	Callback invoked on Change Real Time Seconds Per Game Minute.
`OnTalkSpaceParamChanged`	InTalkInstanceId: `FB1TalkInstanceId`, InTalkSpaceEntityId: `FB1EntityId`, InTalkSpacePoint: `FVector`	`-`	Callback invoked on Talk Space Param Changed.
`PostAddMultiSequence`	`-`	`-`
`PreAddMultiSequence`	`-`	`-`
`RemoveInteractionFinishedListener`	Component: `FB2Component`	`-`	Removes all listeners registered by pointer (called from OnDestroy; uses RemoveAll).
`RemoveOpenedInteractionPanelReason`	InOpenedReason: `EB1InteractionOpenedReason`	`-`	Removes Opened Interaction Panel Reason.
`RequestArrive`	`-`	`-`	Requests Arrive.
`RequestDetermineFinishTimer`	InActionKey: `FB2ActionKey`	`-`	Requests Determine Finish Timer.
`ResetOpenedInteractionPanelReason`	`-`	`-`	Resets Opened Interaction Panel Reason.
`SetCurrentCoopSchedulerId`	InSchedulerId: `FB1EntityId`	`-`	Sets Current Coop Scheduler Id.
`SetLastGrabEntityId`	InQueueId: `B2InteractionQueueId`, InEntityId: `FB1EntityId`	`-`	Sets Last Grab Entity Id.
`SetMultiFlag`	InOn: `boolean`	`-`	Sets Multi Flag.
`SetPutDownEntityId`	InOwnerEntity: `FB1EntityId`	`-`	Sets Put Down Entity Id.
`ShouldUseScheduler`	`-`	`boolean`	Returns whether it should Use Scheduler.
`ShowActionPlayerInfoStr`	`-`	`string`
`TickExternal`	`-`	`-`
`TryCancelCurrentInteraction`	InCancelReason: `EB1InteractionCancelReason`	`boolean`
`TryCancelInfiniteInteraction`	InCancelReason: `EB1InteractionCancelReason`	`-`	Cancels the currently running infinite interaction; during a multi-interaction, cancels only that QueueId.
`TryCancelInteraction`	InQueueId: `integer`, InCancelReason: `EB1InteractionCancelReason`, InCancelReasonDetail: `string`	`boolean`
`TryCancelInteractionByBagId`	InInteractionBagId: `string`, InCancelReason: `EB1InteractionCancelReason`, InCancelReasonDetail: `string`	`-`
`TryCancelInteractionByTag`	InInteractionBagTag: `string`, InCancelReason: `EB1InteractionCancelReason`, InCancelReasonDetail: `string`	`-`
`TryCancelInteractionByUserInput`	InInteractionQueue: `FB2InteractionQueue`	`-`
`TryCancelTalkInteractions`	InCancelReason: `EB1InteractionCancelReason`, InCancelReasonDetail: `string`	`-`
`TryInsertPendingCancelQueue`	InQueueId: `integer`, InCancelReason: `EB1InteractionCancelReason`	`-`
`TryMoveInteraction`	InQueueId: `integer`, InNewIndex: `integer`	`boolean`
`TryRunNotifyScript`	InSelfEntityId: `FB1EntityId`, InTargetEntityId: `FB1EntityId`	`-`

Override points (38)

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

Function	Parameters	Returns	Description
`Override_AddOpenedInteractionPanelReason`	InOpenedReason: `EB1InteractionOpenedReason`	`-`	Adds Opened Interaction Panel Reason.
`Override_ApplyActiveInteractionCooltime`	`-`	`-`	Applies Active Interaction Cooltime.
`Override_CanActiveInteraction`	`-`	`boolean`	Returns whether it can Active Interaction.
`Override_CancelCoopInteractions`	InSchedulerId: `FB1EntityId`	`-`
`Override_CancelScheduleMoveInteractions`	InCancelReason: `EB1InteractionCancelReason`	`-`
`Override_ChangePickedActorEntityId`	InChangedEntityId: `FB1EntityId`	`-`
`Override_ChangeTalkInteractionBagUIData`	InInteractionBagId: `string`, InExecutedTalkCount: `integer`	`-`
`Override_CheckMulti`	InInteractionBagId: `string`, InSelfEntityId: `FB1EntityId`, InTargetEntityId: `FB1EntityId`, InImpactPoint: `FVector`, InPlayReason: `EB1InteractionPlayReason`	`boolean`	Checks Multi.
`Override_ClearCurrentInteraction`	`-`	`-`	Clears Current Interaction.
`Override_ClearInteractionQueue`	InCancelReason: `EB1InteractionCancelReason`, bCancelCurrentInteraction: `boolean`	`-`	Clears Interaction Queue.
`Override_ExpireLastInteractionInfo`	`-`	`-`
`Override_HasCurrentInteractionBagTag`	InTag: `string`	`boolean`	Returns whether it has Current Interaction Bag Tag.
`Override_LinkTalkInteractionToCurrent`	InInteractionId: `string`, InTargetId: `FB1EntityId`, InTalkInstanceId: `FB1TalkInstanceId`	`-`
`Override_OnB2PreBeginPlay`	`-`	`-`	Callback invoked on B2 Pre Begin Play.
`Override_OnCanceledInteractionQueue`	InQueueId: `integer`, InCancelImmediately: `boolean`	`-`	Callback invoked on Canceled Interaction Queue.
`Override_OnChangeGrowthStep`	InPrev: `EB1GrowthStep`, InCurr: `EB1GrowthStep`	`-`	Callback invoked on Change Growth Step.
`Override_OnChangePossess`	`-`	`-`	Callback invoked on Change Possess.
`Override_OnChangeRealTimeSecondsPerGameMinute`	`-`	`-`	Callback invoked on Change Real Time Seconds Per Game Minute.
`Override_OnTalkSpaceParamChanged`	InTalkInstanceId: `FB1TalkInstanceId`, InTalkSpaceEntityId: `FB1EntityId`, InTalkSpacePoint: `FVector`	`-`	Callback invoked on Talk Space Param Changed.
`Override_PostAddMultiSequence`	`-`	`-`
`Override_PreAddMultiSequence`	`-`	`-`
`Override_RemoveInteractionFinishedListener`	Component: `FB2Component`	`-`	Removes all listeners registered by pointer (called from OnDestroy; uses RemoveAll).
`Override_RemoveOpenedInteractionPanelReason`	InOpenedReason: `EB1InteractionOpenedReason`	`-`	Removes Opened Interaction Panel Reason.
`Override_RequestArrive`	`-`	`-`	Requests Arrive.
`Override_RequestDetermineFinishTimer`	InActionKey: `FB2ActionKey`	`-`	Requests Determine Finish Timer.
`Override_ResetOpenedInteractionPanelReason`	`-`	`-`	Resets Opened Interaction Panel Reason.
`Override_ShowActionPlayerInfoStr`	`-`	`string`
`Override_TickExternal`	`-`	`-`
`Override_TryCancelCurrentInteraction`	InCancelReason: `EB1InteractionCancelReason`	`boolean`
`Override_TryCancelInfiniteInteraction`	InCancelReason: `EB1InteractionCancelReason`	`-`	Cancels the currently running infinite interaction; during a multi-interaction, cancels only that QueueId.
`Override_TryCancelInteraction`	InQueueId: `integer`, InCancelReason: `EB1InteractionCancelReason`, InCancelReasonDetail: `string`	`boolean`
`Override_TryCancelInteractionByBagId`	InInteractionBagId: `string`, InCancelReason: `EB1InteractionCancelReason`, InCancelReasonDetail: `string`	`-`
`Override_TryCancelInteractionByTag`	InInteractionBagTag: `string`, InCancelReason: `EB1InteractionCancelReason`, InCancelReasonDetail: `string`	`-`
`Override_TryCancelInteractionByUserInput`	InInteractionQueue: `FB2InteractionQueue`	`-`
`Override_TryCancelTalkInteractions`	InCancelReason: `EB1InteractionCancelReason`, InCancelReasonDetail: `string`	`-`
`Override_TryInsertPendingCancelQueue`	InQueueId: `integer`, InCancelReason: `EB1InteractionCancelReason`	`-`
`Override_TryMoveInteraction`	InQueueId: `integer`, InNewIndex: `integer`	`boolean`
`Override_TryRunNotifyScript`	InSelfEntityId: `FB1EntityId`, InTargetEntityId: `FB1EntityId`	`-`