1. Epic GamesDeveloper
  3. UMassCrowdSubsystem

UMassCrowdSubsystem

Subsystem that tracks mass entities that are wandering on the zone graph.

API > API/Plugins > API/Plugins/MassCrowd

Inheritance Hierarchy

References

   
Module MassCrowd
Header /Engine/Plugins/AI/MassCrowd/Source/MassCrowd/Public/MassCrowdSubsystem.h
Include #include "MassCrowdSubsystem.h"

Syntax

UCLASS ()  
class UMassCrowdSubsystem : public UMassSubsystemBase

Remarks

Subsystem that tracks mass entities that are wandering on the zone graph. It will create custom runtime lane data to allow branching decisions.

Variables

  Type Name Description
Public variable FDebugOnMassCrowdLaneStateChanged DebugOnMassCrowdLaneStateChanged  
Protected variable FZoneGraphTagMask DensityMask Tag mask that represents all possible lane density tags. Built from MassCrowdSettings.
Protected variable UProperty Transient TObjectPtr< const UMassCrowdSettings > MassCrowdSettings  
Protected variable FDelegateHandle OnMassCrowdSettingsChangedHandle  
Protected variable FDelegateHandle OnPostZoneGraphDataAddedHandle  
Protected variable FDelegateHandle OnPreZoneGraphDataRemovedHandle  
Protected variable FDelegateHandle OnZoneGraphDataBuildDoneHandle  
Protected variable TArray< FRegisteredCrowdLaneData > RegisteredLaneData Per lane data for all registered ZoneGraph data.
Protected variable UProperty Transient TObjectPtr< UZoneGraphAnnotationSubsystem > ZoneGraphAnnotationSubsystem  
Protected variable UProperty Transient TObjectPtr< UZoneGraphSubsystem > ZoneGraphSubsystem  

Functions

  Type Name Description
Public function int32

AcquireWaitingSlot ( const FMassEntityHandle Entity,
const FVector& EntityPosition,
const FZoneGraphLaneHandle LaneHandle,
FVector& OutSlotPosition,
FVector& OutSlotDirection
)

 Acquires a slot from a specified waiting lane. Nearest vacant slot to EntityPosition is returned.
Protected function void Populates the crowd lane data array with all existing lane in the zone graph.
Protected function FCrowdBranchingLaneData &

CreateBranchingData ( const int32 LaneIndex,
const FZoneGraphStorage& ZoneGraphStorage
)

 Creates dedicated structure to hold data of a branching lane.
Protected function FCrowdTrackingLaneData &

CreateTrackingData ( const int32 LaneIndex,
const FZoneGraphStorage& ZoneGraphStorage
)

 Creates and initializes the occupancy data of a lane.
Protected function void

CreateWaitSlots ( const int32 CrossingLaneIndex,
FCrowdWaitAreaData& WaitArea,
const FZoneGraphStorage& ZoneGraphStorage
)

  
Public function Const const FCrowdBranchingLaneData * Returns the branching data associated to a given zone graph lane.
Public function Const const FRegisteredCrowdLaneData *

GetCrowdData ( const FZoneGraphDataHandle DataHandle
)

 Returns the readonly runtime data associated to a given zone graph.
Public function Const TOptional< FZoneGraphCrowdLaneData >

GetCrowdLaneData ( const FZoneGraphLaneHandle LaneHandle
)

 Returns the readonly runtime data associated to a given zone graph lane.
Public function Const const FCrowdTrackingLaneData * Returns the entity tracking runtime data associated to a given zone graph lane.
Public function Const const FCrowdWaitAreaData * Returns the waiting area runtime data associated to a given zone graph lane.
Public function Const FZoneGraphTagMask  
Public function Const float

GetDensityWeight ( const FZoneGraphLaneHandle LaneHandle,
const FZoneGraphTagMask LaneTagMask
)

 Returns the weight for lane selection that is associated to the given lane based on its density tag.
Public function Const ECrowdLaneState

GetLaneState ( const FZoneGraphLaneHandle LaneHandle
)

 Return the current state of a lane.
Protected function FZoneGraphCrowdLaneData * Returns the modifiable runtime data associated to a given zone graph lane.
Public function Const bool  
Protected function void

OnEnterTrackedLane ( const FMassEntityHandle Entity,
const int32 LaneIndex,
FCrowdTrackingLaneData& TrackingData
)

 Callback to keep count of entities currently on a given lane.
Public function void

OnEntityLaneChanged ( const FMassEntityHandle Entity,
const FZoneGraphLaneHandle PreviousLaneHandle,
const FZoneGraphLaneHandle CurrentLaneHandle
)

 Callback from the lane tracker processor to indicates a mass entity changing lane.
Protected function void

OnExitTrackedLane ( const FMassEntityHandle Entity,
const int32 LaneIndex,
FCrowdTrackingLaneData& TrackingData
)

 Callback to keep count of entities currently on a given lane.
Protected function void

PostZoneGraphDataAdded ( const AZoneGraphData* ZoneGraphData
)

  
Protected function void

PreZoneGraphDataRemoved ( const AZoneGraphData* ZoneGraphData
)

  
Public function void Clears and rebuilds all lane and intersection data for registered zone graphs using the current settings.
Public function void

ReleaseWaitingSlot ( const FMassEntityHandle Entity,
const FZoneGraphLaneHandle LaneHandle,
const int32 SlotIndex
)

 Releases previously acquired slot from a specified waiting lane.
Public function bool

SetLaneState ( const FZoneGraphLaneHandle LaneHandle,
ECrowdLaneState NewState
)

 Changes the state of a lane.
Protected function void  

Overridden from UMassSubsystemBase

  Type Name Description
Protected function Virtual void  
Protected function Virtual void USubsystem BEGIN.
Protected function Virtual void  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page