FB2AppearanceComponent

Overview

Component that manages appearance (simulation-side appearance data).

Metadata

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

Properties (12)

Name	Type	Description
`AppearanceSetting`	`FB1AppearanceSetting`
`CurrentWeatheringIntensity`	`number`
`EffectedBuffIdList`	`table<string, boolean>`
`OverrideSkin`	`FB2OverrideSkinData`
`PendingActiveOutfitList`	`FB2PendingOutfitList[]`	Not applied while an interaction is in progress; applied after the interaction ends.
`PendingBaseOutfitCategory`	`EB1OutfitCategory`
`PendingRemovalOutfitList`	`FB2PendingOutfitList[]`
`SiteOutfitSourceEntityId`	`FB1EntityId`
`TemporaryAppearanceDataList`	`FB2TemporaryAppearanceData[]`
`TemporaryAppearanceTimeTaskIds`	`table<EB1TemporaryChangeAppearanceType, FB1TimeTaskId>`	TimeTask ID mapping per temporary-appearance type (no serialization needed since it is transient).
`TryOnTimeTaskId`	`FB1TimeTaskId`	Mannequin try-on TimeTask (transient).
`bCharacterCustomization`	`boolean`

Functions (62)

Function	Parameters	Returns	Description
`AddMuscleValue`	InMuscleValue: `integer`	`-`	Adds Muscle Value.
`AddObesityValue`	InObesityValue: `integer`	`-`	Adds Obesity Value.
`AddOverrideAppearanceHair`	InPart: `string`, InColorHex: `string`, DurationTime: `number`	`-`	Adds Override Appearance Hair.
`AddTemporaryAppearanceDataList`	InType: `EB1TemporaryChangeAppearanceType`, InMaxTime: `number`	`-`	Adds Temporary Appearance Data List.
`AllResetOverrideAppearance`	`-`	`-`
`AppendCostume`	CostumeId: `string`, InReason: `EB1ChangeOutfitReason`	`-`
`CancelTryOnTimeTask`	`-`	`-`
`ChangeBaseOutfitCategory`	InOutfitCategory: `EB1OutfitCategory`, InReason: `EB1ChangeOutfitReason`	`-`
`ChangeCostumeByCostumeId`	InCostumeId: `string`, InReason: `EB1ChangeOutfitReason`	`-`
`EmplaceActiveOutfit`	InStyle: `FB1StyleSetting`, InCostumeId: `string`, InReason: `EB1ChangeOutfitReason`	`-`
`ForceAddMuscleImmediate`	InMuscleValue: `integer`	`-`
`ForceAddObesityImmediate`	InObesityValue: `integer`	`-`
`GetActiveCostumeIdByReason`	InReason: `EB1ChangeOutfitReason`	`string`	Returns the outfit currently active for a specific Reason (NAME_None / EB1OutfitCategory::None if none).
`GetActiveOutfitCategoryByReason`	InReason: `EB1ChangeOutfitReason`	`EB1OutfitCategory`	Returns Active Outfit Category By Reason.
`GetAppearanceSetting`	`-`	`FB1AppearanceSetting`	Returns Appearance Setting.
`GetBaseMuscle`	`-`	`integer`	Returns Base Muscle.
`GetBaseMuscleRatio`	`-`	`number`	Returns Base Muscle Ratio.
`GetBaseObesity`	`-`	`integer`	Returns Base Obesity.
`GetBaseObesityRatio`	`-`	`number`	Returns Base Obesity Ratio.
`GetCityMovePolicyMap`	InCityMoveDataPolicyType: `EB1CityMoveDataPolicyType`	`table<string, EB1CityMoveDataPolicy>`	Returns City Move Policy Map.
`GetCurrentMuscle`	`-`	`integer`	Returns Current Muscle.
`GetCurrentMuscleRatio`	`-`	`number`	Returns Current Muscle Ratio.
`GetCurrentObesity`	`-`	`integer`	Returns Current Obesity.
`GetCurrentObesityRatio`	`-`	`number`	Returns Current Obesity Ratio.
`GetDefaultCityMoveDataPolicy`	`-`	`EB1CityMoveDataPolicy`	Returns Default City Move Data Policy.
`GetOverrideSkin`	`-`	`string`	Returns Override Skin.
`GetOverrideSkinColor`	`-`	`string`	Returns Override Skin Color.
`GetWeatheringIntensity`	`-`	`number`	Returns Weathering Intensity.
`HasSiteOutfitSource`	`-`	`boolean`	Returns whether it has Site Outfit Source.
`IsWearingRaincoat`	`-`	`boolean`	Returns whether Wearing Raincoat.
`OnChangeAppearanceAge`	InCurrentAge: `integer`, InCurrentGrowthStep: `EB1GrowthStep`	`-`	Callback invoked on Change Appearance Age.
`OnFinishInteractionSequence`	`-`	`-`	Callback invoked on Finish Interaction Sequence.
`OnLeavedSiteArea`	InLeavedSiteType: `EB1SiteType`	`-`	Callback invoked on Leaved Site Area.
`PendingRemoveCostumeByCostumeId`	InCostumeId: `string`, InExpireTicks: `integer`, InReason: `EB1ChangeOutfitReason`	`-`
`PendingRemoveCostumeByOutfitCategory`	InOutfitCategory: `EB1OutfitCategory`, InExpireTicks: `integer`, InReason: `EB1ChangeOutfitReason`	`-`
`ProcessPendingRemovalOutfit`	InImmediately: `boolean`	`-`
`ReapplyOverrideSkin`	`-`	`boolean`
`ReapplyWeatheringIntensity`	`-`	`-`
`RefreshAppearance`	`-`	`-`
`RefreshMuscleValue`	`-`	`-`
`RefreshObesityValue`	`-`	`-`
`RefreshOutfitBuff`	bAddBuffImmediately: `boolean`	`-`
`RefreshOverrideSkin`	`-`	`-`
`RegisterTemporaryAppearanceTimeTask`	InType: `EB1TemporaryChangeAppearanceType`, InExpireTime: `FDateTime`	`-`	Registers Temporary Appearance Time Task.
`RemoveCostumeByCostumeId`	InCostumeId: `string`, InReason: `EB1ChangeOutfitReason`	`-`	Removes Costume By Costume Id.
`RemoveCostumeByCostumeTag`	InCostumeId: `string`, InReason: `EB1ChangeOutfitReason`	`-`	Removes Costume By Costume Tag.
`RemoveCostumeByOutfitCategory`	InOutfitCategory: `EB1OutfitCategory`, InReason: `EB1ChangeOutfitReason`, bInForceEvenIfRuleBased: `boolean`	`-`	Removes Costume By Outfit Category.
`RemoveCostumeByReason`	InReason: `EB1ChangeOutfitReason`	`-`	Removes Costume By Reason.
`ReserveDeleteTemporaryAppearanceData`	InType: `EB1TemporaryChangeAppearanceType`	`-`
`ResetOverrideAppearance`	InType: `EB1TemporaryChangeAppearanceType`, bSendPacket: `boolean`	`-`	Resets Override Appearance.
`SetAppearanceSetting`	InAppearanceSetting: `FB1AppearanceSetting`	`-`	Sets Appearance Setting.
`SetCategorizedStyles`	InCategorizedStyles: `table<EB1OutfitCategory, FB1CategorizedStyleData>`, InBaseStyleCategory: `EB1OutfitCategory`	`-`	Sets Categorized Styles.
`SetOverrideAppearance`	InType: `EB1TemporaryChangeAppearanceType`, InValueStr: `string`, DurationTime: `number`	`-`	Sets Override Appearance.
`SetOverrideSkin`	InOverrideSkinId: `string`, InForceOriginUpdate: `boolean`	`-`	Sets Override Skin.
`SetOverrideSkinColor`	InOverrideSkinColorId: `string`, InForceOriginUpdate: `boolean`	`-`	Sets Override Skin Color.
`SetSiteOutfitSource`	InSiteEntityId: `FB1EntityId`	`-`	Sets Site Outfit Source.
`SetTryOnTimeTaskId`	InId: `FB1TimeTaskId`	`-`	Manages the mannequin try-on TimeTask.
`SetWeatheringIntensity`	InNewIntensity: `number`	`-`	Sets weathering intensity. (Hair-salon temporary hair data is not stored on the component, per BL-57370: the picked PoolId goes to the co-op scope FB2CoopScheduler::CoopExtraData[SalonHair_PoolId]; the picker category goes to SelectOrRandomSalonHair's S2; and the ApplyFail fallback category is derived from the picked PoolId.)
`ShouldUseScheduler`	`-`	`boolean`	Returns whether it should Use Scheduler.
`TemporarilyRevertOverrideSkin`	`-`	`-`
`UnregisterTemporaryAppearanceTimeTask`	InType: `EB1TemporaryChangeAppearanceType`	`-`	Unregisters Temporary Appearance Time Task.
`UpdatePregnancyBodyMorph`	InGroupName: `string`, InAlpha: `number`	`-`	Updates Pregnancy Body Morph.

Override points (30)

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

Function	Parameters	Returns	Description
`Override_AddMuscleValue`	InMuscleValue: `integer`	`-`	Adds Muscle Value.
`Override_AddObesityValue`	InObesityValue: `integer`	`-`	Adds Obesity Value.
`Override_AddOverrideAppearanceHair`	InPart: `string`, InColorHex: `string`, DurationTime: `number`	`-`	Adds Override Appearance Hair.
`Override_AddTemporaryAppearanceDataList`	InType: `EB1TemporaryChangeAppearanceType`, InMaxTime: `number`	`-`	Adds Temporary Appearance Data List.
`Override_AllResetOverrideAppearance`	`-`	`-`
`Override_AppendCostume`	CostumeId: `string`, InReason: `EB1ChangeOutfitReason`	`-`
`Override_CancelTryOnTimeTask`	`-`	`-`
`Override_ChangeBaseOutfitCategory`	InOutfitCategory: `EB1OutfitCategory`, InReason: `EB1ChangeOutfitReason`	`-`
`Override_EmplaceActiveOutfit`	InStyle: `FB1StyleSetting`, InCostumeId: `string`, InReason: `EB1ChangeOutfitReason`	`-`
`Override_ForceAddMuscleImmediate`	InMuscleValue: `integer`	`-`
`Override_ForceAddObesityImmediate`	InObesityValue: `integer`	`-`
`Override_OnChangeAppearanceAge`	InCurrentAge: `integer`, InCurrentGrowthStep: `EB1GrowthStep`	`-`	Callback invoked on Change Appearance Age.
`Override_OnFinishInteractionSequence`	`-`	`-`	Callback invoked on Finish Interaction Sequence.
`Override_OnLeavedSiteArea`	InLeavedSiteType: `EB1SiteType`	`-`	Callback invoked on Leaved Site Area.
`Override_ProcessPendingRemovalOutfit`	InImmediately: `boolean`	`-`
`Override_ReapplyOverrideSkin`	`-`	`boolean`
`Override_ReapplyWeatheringIntensity`	`-`	`-`
`Override_RefreshAppearance`	`-`	`-`
`Override_RefreshMuscleValue`	`-`	`-`
`Override_RefreshObesityValue`	`-`	`-`
`Override_RefreshOutfitBuff`	bAddBuffImmediately: `boolean`	`-`
`Override_RefreshOverrideSkin`	`-`	`-`
`Override_RegisterTemporaryAppearanceTimeTask`	InType: `EB1TemporaryChangeAppearanceType`, InExpireTime: `FDateTime`	`-`	Registers Temporary Appearance Time Task.
`Override_RemoveCostumeByCostumeTag`	InCostumeTag: `string`, InReason: `EB1ChangeOutfitReason`	`-`	Removes Costume By Costume Tag.
`Override_RemoveCostumeByReason`	InReason: `EB1ChangeOutfitReason`	`-`	Removes Costume By Reason.
`Override_ReserveDeleteTemporaryAppearanceData`	InType: `EB1TemporaryChangeAppearanceType`	`-`
`Override_ResetOverrideAppearance`	InType: `EB1TemporaryChangeAppearanceType`, bSendPacket: `boolean`	`-`	Resets Override Appearance.
`Override_TemporarilyRevertOverrideSkin`	`-`	`-`
`Override_UnregisterTemporaryAppearanceTimeTask`	InType: `EB1TemporaryChangeAppearanceType`	`-`	Unregisters Temporary Appearance Time Task.
`Override_UpdatePregnancyBodyMorph`	InGroupName: `string`, InAlpha: `number`	`-`	Updates Pregnancy Body Morph.