1. Epic GamesDeveloper
  3. UZoneGraphSubsystem

UZoneGraphSubsystem

API > API/Plugins > API/Plugins/ZoneGraph

Inheritance Hierarchy

References

   
Module ZoneGraph
Header /Engine/Plugins/Runtime/ZoneGraph/Source/ZoneGraph/Public/ZoneGraphSubsystem.h
Include #include "ZoneGraphSubsystem.h"

Syntax

UCLASS&40;&41;  
class UZoneGraphSubsystem : public UTickableWorldSubsystem

Variables

  Type Name Description
Protected variable bool bInitialized  
Protected variable FZoneGraphBuilder Builder  
Protected variable FCriticalSection DataRegistrationSection  
Protected variable FDelegateHandle OnActorMovedHandle  
Protected variable FDelegateHandle OnRequestRebuildHandle  
Protected variable UProperty TArray< FRegisteredZoneGraphData > RegisteredZoneGraphData  
Protected variable TArray< int32 > ZoneGraphDataFreeList  

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Const bool

AdvanceLaneLocation ( const FZoneGraphLaneLocation& InLaneLocation,
const float AdvanceDistance,
FZoneGraphLaneLocation& OutLaneLocation
)

 Moves LaneLocation along a lane.
Public function Const bool

CalculateLocationAlongLane ( const FZoneGraphLaneHandle LaneHandle,
const float Distance,
FZoneGraphLaneLocation& OutLaneLocation
)

 Returns point at a distance along a specific lane.
Public function Const bool

FindLaneOverlaps ( const FVector& Center,
const float Radius,
const FZoneGraphTagFilter TagFilter,
TArray< FZoneGraphLaneSection >& OutLaneSections
)

 Find sections of lanes fully overlapping (including lane width). Finds results from all registered ZoneGraph data.
Public function Const bool

FindNearestLane ( const FBox& QueryBounds,
const FZoneGraphTagFilter TagFilter,
FZoneGraphLaneLocation& OutLaneLocation,
float& OutDistanceSqr
)

 Find nearest lane that touches the query bounds. Finds results from all registered ZoneGraph data.
Public function Const bool

FindNearestLocationOnLane ( const FZoneGraphLaneHandle LaneHandle,
const FBox& Bounds,
FZoneGraphLaneLocation& OutLaneLocation,
float& OutDistanceSqr
)

 Find nearest location on a specific lane.
Public function Const bool

FindNearestLocationOnLane ( const FZoneGraphLaneHandle LaneHandle,
const FVector& Center,
const float Range,
FZoneGraphLaneLocation& OutLaneLocation,
float& OutDistanceSqr
)

 Find nearest location on a specific lane.
Public function Const bool

FindOverlappingLanes ( const FBox& QueryBounds,
const FZoneGraphTagFilter TagFilter,
TArray< FZoneGraphLaneHandle >& OutLanes
)

 Find overlapping lanes that touches the query bounds. Finds results from all registered ZoneGraph data.
Public function FZoneGraphBuilder &  
Public function Const FBox Returns bounds of all ZoneGraph data.
Public function Const bool

GetFirstLinkedLane ( const FZoneGraphLaneHandle LaneHandle,
const EZoneLaneLinkType Types,
const EZoneLaneLinkFlags IncludeFlags,
const EZoneLaneLinkFlags ExcludeFlags,
FZoneGraphLinkedLane& OutLinkedLane
)

 Returns handle to first linked lane matching the connection type and flags.
Public function Const bool

GetLaneLength ( const FZoneGraphLaneHandle LaneHandle,
float& OutLength
)

 Returns the length of a specific lane.
Public function Const bool

GetLaneTags ( const FZoneGraphLaneHandle LaneHandle,
FZoneGraphTagMask& OutTags
)

 Returns the Tags of a specific lane.
Public function Const bool

GetLaneWidth ( const FZoneGraphLaneHandle LaneHandle,
float& OutWidth
)

 Returns the width of a specific lane.
Public function Const bool

GetLinkedLanes ( const FZoneGraphLaneHandle LaneHandle,
const EZoneLaneLinkType Types,
const EZoneLaneLinkFlags IncludeFlags,
const EZoneLaneLinkFlags ExcludeFlags,
TArray< FZoneGraphLinkedLane >& OutLinkedLanes
)

 Returns all links to connected lanes of a specific lane.
Public function Const TConstArrayView< FRegisteredZoneGraphData >  
Public function Const FZoneGraphTag

GetTagByName ( FName TagName
)

 Returns tag based on name.
Public function Const const FZoneGraphTagInfo * Returns info about a specific tag.
Public function Const TConstArrayView< FZoneGraphTagInfo > Returns all tag infos.
Public function Const FName Returns the name of a specific tag.
Public function Const const AZoneGraphData *

GetZoneGraphData ( const FZoneGraphDataHandle DataHandle
)

 Returns Zone Graph data associated with specified handle.
Public function Const const FZoneGraphStorage * Returns Zone Graph data storage associated with specified handle, or nullptr if not found.
Public function Const bool

IsLaneValid ( const FZoneGraphLaneHandle LaneHandle
)

 Returns true if lane handle is valid.
Protected function void

OnActorMoved ( AActor* Actor
)

  
Protected function void  
Protected function void

RebuildGraph ( const bool bForceRebuild
)

 Rebuilds the graph.
Public function FZoneGraphDataHandle

RegisterZoneGraphData ( AZoneGraphData& InZoneGraphData
)

  
Protected function void  
Protected function void

RemoveRegisteredDataItem ( const int32 Index
)

  
Protected function void  
Protected function void  
Public function void  

Overridden from UWorldSubsystem

  Type Name Description
Protected function Virtual void Called once all UWorldSubsystems have been initialized

Overridden from USubsystem

  Type Name Description
Protected function Virtual void Implement this for deinitialization of instances of the system
Protected function Virtual void USubsystem implementation Begin.

Overridden from FTickableGameObject

  Type Name Description
Public function Virtual Const bool Used to determine whether the object should be ticked in the editor.

Overridden from FTickableObjectBase

  Type Name Description
Protected function Virtual Const TStatId Return the stat id to use for this tickable
Protected function Virtual void

Tick ( float DeltaTime
)

 Pure virtual that must be overloaded by the inheriting class.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page