Skip to main content

FB2CrimeComponent

Overview

  • Component that manages crime-related state.

Metadata

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

Properties (5)

NameTypeDescription
CrimeScorestable<string, number>
CriminalBehaviorHistoryFB1CriminalBehaviorHistory
ImprisonmentHistoryFB1ImprisonmentHistory
PendingImprisonmentFB1PendingImprisonment
TrialHistoryFB1TrialHistory

Functions (20)

FunctionParametersReturnsDescription
AddCrimeScoreCrimeId: string, ScoreToAdd: number-Adds Crime Score.
ClearPendingImprisonment--Clears Pending Imprisonment.
GetCrimeScoreCrimeId: stringnumberReturns Crime Score.
GetCriminalBehaviorCountCrimeId: stringintegerReturns Criminal Behavior Count.
GetCriminalBehaviorCounts-table<string, integer>Returns Criminal Behavior Counts.
GetCriminalBehaviorHistory-FB1CriminalBehaviorHistoryReturns Criminal Behavior History.
GetImprisonmentCount-integerReturns Imprisonment Count.
GetPendingImprisonment-FB1PendingImprisonmentReturns Pending Imprisonment.
GetTrialCount-integerReturns Trial Count.
HasPendingImprisonment-booleanReturns whether it has Pending Imprisonment.
HasTrialToday-booleanReturns whether it has Trial Today.
IncreaseTrialCount--
IsInPrison-booleanReturns whether In Prison.
OnInteractionFinishedInteractionId: string, TargetEntityId: FB1EntityId, InteractionTags: string[]-Callback invoked on Interaction Finished.
OnInteractionSequenceFinishedInteractionBagId: string, TargetEntityId: FB1EntityId, bIsTalk: boolean-Callback invoked on Interaction Sequence Finished.
OnMobileMessageSentMessageTags: string[], TargetEntityId: FB1EntityId-Callback invoked on Mobile Message Sent.
OnVehicleAccidentCausedVehicleAccidentId: string, TargetEntityId: FB1EntityId-Callback invoked on Vehicle Accident Caused.
ResetAllCrimeScores--Resets All Crime Scores.
ResetCrimeScoreCrimeId: string-Resets Crime Score.
SetPendingImprisonmentInPendingImprisonment: FB1PendingImprisonment-Sets Pending Imprisonment.

Override points (9)

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

FunctionParametersReturnsDescription
Override_AddCrimeScoreCrimeId: string, ScoreToAdd: number-Adds Crime Score.
Override_HasTrialToday-booleanReturns whether it has Trial Today.
Override_IncreaseTrialCount--
Override_OnInteractionFinishedInteractionId: string, TargetEntityId: FB1EntityId, InteractionTags: string[]-Callback invoked on Interaction Finished.
Override_OnInteractionSequenceFinishedInteractionBagId: string, TargetEntityId: FB1EntityId, bIsTalk: boolean-Callback invoked on Interaction Sequence Finished.
Override_OnMobileMessageSentMessageTags: string[], TargetEntityId: FB1EntityId-Callback invoked on Mobile Message Sent.
Override_OnVehicleAccidentCausedVehicleAccidentId: string, TargetEntityId: FB1EntityId-Callback invoked on Vehicle Accident Caused.
Override_ResetAllCrimeScores--Resets All Crime Scores.
Override_ResetCrimeScoreCrimeId: string-Resets Crime Score.