Skip to main content

FB2InstinctComponent

Overview

  • This component does not Snapshot/Restore, because there is nothing to save: all initially created characters use the same data.

Metadata

FieldValue
Kindcomponent
EnvironmentB2 - Simulation
Categorycomponents
ExtendsFB2Component
Requirerequire('Components.B2InstinctComponent')

Properties (1)

NameTypeDescription
InstinctDataListany[]

Functions (5)

FunctionParametersReturnsDescription
AddInstinct--Adds Instinct.
ExecuteInstinctEntryTriggeredInCheckType: EB1TraitEntryType-
OnInstinctEventTriggeredInTriggerData: FB1TraitEventData-Callback invoked on Instinct Event Triggered.
PrecheckInstinctEntryTriggeredInCheckType: EB1TraitEntryType, InCompletedBagId: string, InCompletedInteractionId: string-Pre-checks the TriggeredBuff condition before an interaction completes.
ShouldUseScheduler-booleanReturns whether it should Use Scheduler.

Override points (4)

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

FunctionParametersReturnsDescription
Override_AddInstinct--Adds Instinct.
Override_ExecuteInstinctEntryTriggeredInCheckType: EB1TraitEntryType-
Override_OnInstinctEventTriggeredInTriggerData: FB1TraitEventData-Callback invoked on Instinct Event Triggered.
Override_PrecheckInstinctEntryTriggeredInCheckType: EB1TraitEntryType, InCompletedBagId: string, InCompletedInteractionId: string-Pre-checks the TriggeredBuff condition before an interaction completes.