FB2ObjectGroupingComponent

Overview

• Component that manages object grouping.

Metadata

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

Properties (5)

Name	Type	Description
ChildrenEntityIds	table<FB1EntityId, boolean>
GroupingEntityIds	table<FB1EntityId, boolean>
OccupiedSlotName	string
ParentEntityId	FB1EntityId
RootEntityId	FB1EntityId

Functions (11)

Function	Parameters	Returns	Description
GetChildrenEntityIds	-	table<FB1EntityId, boolean>	Returns Children Entity Ids.
GetChildrenObjects	-	FB2GameObject[]	Returns Children Objects.
GetDefaultCityMoveDataPolicy	-	EB1CityMoveDataPolicy	Returns Default City Move Data Policy.
GetGroupingEntityIds	-	table<FB1EntityId, boolean>	Returns Grouping Entity Ids.
GetGroupingObjects	-	FB2GameObject[]	Returns Grouping Objects.
GetOccupiedSlotName	-	string	Returns Occupied Slot Name.
GetParentEntityId	-	FB1EntityId	Returns Parent Entity Id.
GetParentObject	-	FB2GameObject	Returns Parent Object.
GetRootEntityId	-	FB1EntityId	Returns Root Entity Id.
GetRootObject	-	FB2GameObject	Returns Root Object.
SetOccupiedSlotName	InSlotName: string	-	Sets Occupied Slot Name.