Skip to main content

FB2CurrencyComponent

Overview

Component that manages currency (money).

Metadata

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

Properties (2)

Name	Type	Description
`CurrencyHistoryMap`	`table<string, FB1DailyTransactionMap>`
`CurrencyMap`	`table<string, integer>`

Functions (14)

Function	Parameters	Returns	Description
`AddCurrency`	InValue: `integer`, InReason: `EB1TransactionReason`, InPlayWidgetEffectEntity: `FB1EntityId`, bForced: `boolean`, InOwnerId: `FB1EntityId`, InCareerDtId: `string`, InBizId: `FB1EntityId`, InFormatArgs: `table<string, string>`	`boolean`	Adds Currency.
`AddCurrencyByCurrencyId`	InCurrencyId: `string`, InValue: `integer`, InReason: `EB1TransactionReason`, InPlayWidgetEffectEntity: `FB1EntityId`, bForced: `boolean`, InOwnerId: `FB1EntityId`, bIsSellInBuildMode: `boolean`, InEffectLocation: `FVector`, InCareerDtId: `string`, InBizId: `FB1EntityId`, InFormatArgs: `table<string, string>`	`boolean`	Adds Currency By Currency Id.
`GetCurrency`	OutValue: `integer`, InOwnerId: `FB1EntityId`	`boolean`	Returns Currency.
`GetCurrencyAmount`	InCurrencyId: `string`, InOwnerId: `FB1EntityId`	`integer`	Returns Currency Amount.
`GetCurrencyByCurrencyId`	InCurrencyId: `string`, OutValue: `integer`, InOwnerId: `FB1EntityId`	`boolean`	Returns Currency By Currency Id.
`GetCurrencyMap`	`-`	`table<string, integer>`	Returns Currency Map.
`GetDefaultCityMoveDataPolicy`	`-`	`EB1CityMoveDataPolicy`	Returns Default City Move Data Policy.
`GetTransactionsByDaysAgo`	CurrencyId: `string`, DaysAgo: `integer`	`FB1TransactionRecordArray`	Returns Transactions By Days Ago.
`HasEnoughCurrency`	InCurrencyId: `string`, InConsumeCurrencyValue: `integer`, InOwnerId: `FB1EntityId`	`boolean`	Returns whether it has Enough Currency.
`InitCurrency`	InCurrencyMap: `table<string, integer>`	`-`	Initializes Currency.
`OnDayChanged`	`-`	`-`	Callback invoked on Day Changed.
`SetCurrency`	InCurrencyId: `string`, InValue: `integer`, InReason: `EB1TransactionReason`, InPlayWidgetEffectEntity: `FB1EntityId`, bForced: `boolean`, InOwnerId: `FB1EntityId`	`boolean`	Sets Currency.
`SetDefaultCurrencyMap`	`-`	`-`	Sets Default Currency Map.
`TrySubtractCurrency`	InValue: `integer`	`boolean`

Override points (3)

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

Function	Parameters	Returns	Description
`Override_HasEnoughCurrency`	InCurrencyId: `string`, InConsumeCurrencyValue: `integer`, InOwnerId: `FB1EntityId`	`boolean`	Returns whether it has Enough Currency.
`Override_OnDayChanged`	`-`	`-`	Callback invoked on Day Changed.
`Override_TrySubtractCurrency`	InValue: `integer`	`boolean`