FB2AttachMeshComponent

Overview

• Component that manages attached meshes (props, etc.).

Metadata

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

Properties (6)

Name	Type	Description
AttachMeshIdList	string[]
CachedTemporaryMeshId	string
OutfitHiddenAttachMeshIds	string[]
SchoolScheduleAttachMeshId	string	School schedule AttachMesh state (BL-47796)
bArrivedSchoolScheduleDest	boolean
bScheduleMeshAttached	boolean

Functions (16)

Function	Parameters	Returns	Description
AttachMesh	InAttachMeshId: string	-
CacheTemporaryMeshId	InCacheMeshId: string	-
ClearSchoolScheduleAttachMeshId	-	-	Clears School Schedule Attach Mesh Id.
DetachMesh	InAttachMeshId: string	-
GetAttachMeshIdList	-	string[]	Returns Attach Mesh Id List.
GetDefaultCityMoveDataPolicy	-	EB1CityMoveDataPolicy	Returns Default City Move Data Policy.
GetSchoolScheduleAttachMeshId	-	string	Returns School Schedule Attach Mesh Id.
IsCurrentOutfitAllowSchoolBag	-	boolean	Checks whether the current outfit category allows a schoolbag.
IsScheduleMeshAttached	-	boolean	Returns whether Schedule Mesh Attached.
OnCostumeChange	-	-	Called when the AppearanceComponent changes the costume; decides the schoolbag per category.
OnDespawn	-	-	Called on despawn; directly clears AttachMeshIdList from the outside.
OnFinishInteractionSequence	-	-	Callback invoked on Finish Interaction Sequence.
OnPostureChanged	InPrevPostureId: string, InCurrentPostureId: string	-	Called by the PostureComponent when the posture changes; re-evaluates the attach condition only when entering or leaving a water posture category (swim/dive/board).
SetSchoolScheduleAttachMeshId	InMeshId: string	-	School schedule-based AttachMesh management (BL-47796)
UpdateOutfitHiddenAttachMeshes	-	-	Updates Outfit Hidden Attach Meshes.
UpdateScheduleAttachMeshVisibility	bForceIdle: boolean	-	Updates schedule attach-mesh visibility. bForceIdle: treats the state as Idle when IsPlayingInteraction() is still true (e.g. at the OnFinishInteractionSequence callback).

Override points (10)

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

Function	Parameters	Returns	Description
Override_AttachMesh	InAttachMeshId: string	-
Override_CacheTemporaryMeshId	InCacheMeshId: string	-
Override_ClearSchoolScheduleAttachMeshId	-	-	Clears School Schedule Attach Mesh Id.
Override_DetachMesh	InAttachMeshId: string	-
Override_OnCostumeChange	-	-	Called when the AppearanceComponent changes the costume; decides the schoolbag per category.
Override_OnDespawn	-	-	Called on despawn; directly clears AttachMeshIdList from the outside.
Override_OnFinishInteractionSequence	-	-	Callback invoked on Finish Interaction Sequence.
Override_OnPostureChanged	InPrevPostureId: string, InCurrentPostureId: string	-	Called by the PostureComponent when the posture changes; re-evaluates the attach condition only when entering or leaving a water posture category (swim/dive/board).
Override_UpdateOutfitHiddenAttachMeshes	-	-	Updates Outfit Hidden Attach Meshes.
Override_UpdateScheduleAttachMeshVisibility	bForceIdle: boolean	-	Updates schedule attach-mesh visibility. bForceIdle: treats the state as Idle when IsPlayingInteraction() is still true.