FB2SitePathFindingComponent

Overview

Component that handles pathfinding within a site.

Metadata

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

Properties (18)

Name	Type	Description
`ExecutingPathFollowingCharacters`	`FB1EntityId[]`
`GiftBoxPoints`	`FVector[]`
`GridMaxX`	`integer`
`GridMaxY`	`integer`
`MaxFloor`	`integer`
`MinFloor`	`integer`
`OutermostInsideCityGraphLocations`	`FVector[]`
`OutlineInfos`	`FB1SitePathFindOutlineInfo[]`
`PathfindingGrid2`	`table<integer, FB1FloorPathFindGrid>`
`ReplacingOutlinePoints`	`FVector[]`
`SubZoneGraph`	`FB2SubZoneGraph`
`VehiclePoint`	`FVector`
`XCollisionBitArrayMap`	`table<integer, FB1PathFindGridBitArray>`
`YCollisionBitArrayMap`	`table<integer, FB1PathFindGridBitArray>`
`ZoneGraphNodeArray`	`FB1ZoneGraphNode[]`
`ZoneGraphZoneInfoMap`	`table<integer, FB1ZoneGraphZoneInfo>`
`bOnlyReachableByWarp`	`boolean`
`bUseVehiclePoint`	`boolean`

Functions (23)

Function	Parameters	Returns	Description
`GetCenterToOBBLength2D`	CenterToTarget: `FVector`, BoxHalfExtents: `FVector`	`number`	Returns Center To OBBLength2 D.
`GetExecutingPathFollowingCharacters`	`-`	`FB1EntityId[]`	Returns Executing Path Following Characters.
`GetFloorFromWorldLocation`	InScopeLock: `FRWScopeLock`, InWorldLocation: `FVector`	`integer`	Returns Floor From World Location.
`GetGridData`	InScopeLock: `FRWScopeLock`, InLocation: `FVector`, OutGridData: `FB1PathFindGridData`	`boolean`	Returns Grid Data.
`GetMemoryUsage`	`-`	`SIZE_T`	Returns Memory Usage.
`GetMoveWithVehicleSitePoint`	OutMoveWithVehicleSitePoint: `FVector`	`boolean`	Returns Move With Vehicle Site Point.
`GetNearGridHeight`	InScopeLock: `FRWScopeLock`, InFindWorldLocation: `FVector`	`number`	Returns Near Grid Height.
`GetNearestOutlineLocation`	InScopeLock: `FRWScopeLock`, InCharacterId: `FB1EntityId`, InFindStartWorldLocation: `FVector`, InDestinationWorldLocation: `FVector`, OutNearestOutlineLocation: `FVector`, bUseReplacingOutlinePoints: `boolean`	`boolean`	Returns Nearest Outline Location.
`GetOutermostInsideCityGraphPoint`	InScopeLock: `FRWScopeLock`, InStartWorldLocation: `FVector`, OutCityGraphLocation: `FVector`	`boolean`	Returns Outermost Inside City Graph Point.
`GetRandomWalkAroundSiteLocation`	InRequesterId: `FB1EntityId`, InStartLoc: `FVector`, OutGoalLocation: `FVector`, InOption: `string`	`boolean`	Returns Random Walk Around Site Location.
`GetReplacingOutlinePoints`	`-`	`FVector[]`	Returns Replacing Outline Points.
`GetWalkToSitePoint`	InScopeLock: `FRWScopeLock`, InRequesterId: `FB1EntityId`, InStartLoc: `FVector`, OutGoalLocation: `FVector`	`boolean`	Returns Walk To Site Point.
`HasReplacingOutlinePoint`	`-`	`boolean`	Returns whether it has Replacing Outline Point.
`IsExistMovePath`	InScopeLock: `FRWScopeLock`, InEntityId: `FB1EntityId`, InStartLocation: `FVector`, InTargetLocation: `FVector`, CachedInformation: `FB2CachedPathfindInformation`	`boolean`	Returns whether Exist Move Path.
`IsOnlyReachableByWarp`	`-`	`boolean`	Returns whether Only Reachable By Warp.
`IsSafetyLocation`	InScopeLock: `FRWScopeLock`, InWorldLocation: `FVector`	`boolean`	Returns whether Safety Location.
`IsSafetySquarePoint`	InScopeLock: `FRWScopeLock`, InPoint: `FVector`	`boolean`	Returns whether Safety Square Point.
`IsWalkablePoint`	InScopeLock: `FRWScopeLock`, InPoint: `FVector`, InWithUnusable: `boolean`	`boolean`	Returns whether Walkable Point.
`OnFinishPathFollowing`	InExecutingCharacterId: `FB1EntityId`	`-`	Callback invoked on Finish Path Following.
`OnStartPathFollowing`	InExecutingCharacterId: `FB1EntityId`	`-`	Callback invoked on Start Path Following.
`TestOutermostInsideCityGraphPoint`	OutInvalidLocations: `FVector[]`	`-`
`ToRelativeLocation`	InWorldLocation: `FVector`	`FVector`
`ToWorldLocation`	InRelativeLocation: `FVector`	`FVector`

Override points (5)

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

Function	Parameters	Returns	Description
`Override_HasReplacingOutlinePoint`	`-`	`boolean`	Returns whether it has Replacing Outline Point.
`Override_OnFinishPathFollowing`	InExecutingCharacterId: `FB1EntityId`	`-`	Callback invoked on Finish Path Following.
`Override_OnStartPathFollowing`	InExecutingCharacterId: `FB1EntityId`	`-`	Callback invoked on Start Path Following.
`Override_ToRelativeLocation`	InWorldLocation: `FVector`	`FVector`
`Override_ToWorldLocation`	InRelativeLocation: `FVector`	`FVector`