1. Epic GamesDeveloper
  3. UMassEQSSubsystem

UMassEQSSubsystem

Subsystem for sending UMassEQSGenerator and UMassEQSTest requests to Mass Processors, and for returning the results back to EQS.

API > API/Plugins > API/Plugins/MassEQS

Inheritance Hierarchy

References

   
Module MassEQS
Header /Engine/Plugins/Runtime/MassGameplay/Source/MassEQS/Public/MassEQSSubsystem.h
Include #include "MassEQSSubsystem.h"

Syntax

UCLASS ()  
class UMassEQSSubsystem : public UMassSubsystemBase

Remarks

Subsystem for sending UMassEQSGenerator and UMassEQSTest requests to Mass Processors, and for returning the results back to EQS.

Variables

  Type Name Description
Protected variable bool bIsInitialized Used to ignore request cancellation after subsystem is De-Initialized
Protected variable TArray< FMassEQSRequestHandle > CancelledRequests Holds all RequestHandles of requests who have been canceled, and not yet submitted.
Protected variable FIndexedHandleManagerBase< FMassEQSRequestHandle, int32, uint32, true > HandleManager  
Protected variable TMap< TSubclassOf< UEnvQueryNode >, int32 > RequestQueueLookup Mapping from Class of requester, to index into RequestQueues.
Protected variable TArray< FRequestQueue > RequestQueues Array of Queues holding each Request.
Protected variable TMap< FMassEQSRequestHandle, TUniquePtr< FMassEQSRequestData > > Results Holds results for finished Query

Functions

  Type Name Description
Public function void If Request in RequestQueue -> Remove from Queue If Result in Results -> Remove from Results Otherwise, Request is currently being processed -> Log this ID as Cancelled, and ignore result when submitted.
Public function void Finalization step for Handle Management
Public function int32

GetRequestQueueIndex ( TSubclassOf< UEnvQueryNode > RequestClass
)

 Returns the index into RequestQueues for the input class
Public function TUniquePtr< FMassEQSRequestData >

PopRequest ( const int32 RequestQueueIndex
)

 Dequeue next Request off the RequestQueue, removing it from the queue, and transferring ownership of UniquePtr
Public function FMassEQSRequestHandle

PushRequest ( const FEnvQueryInstance& QueryInstance,
const int32 RequestQueueIndex,
TUniquePtr< FMassEQSRequestData >&& Request
)

 Push new Request into RequestQueue
Public function void

SubmitResults ( FMassEQSRequestHandle RequestHandle,
TUniquePtr< FMassEQSRequestData >&& Result
)

 Send results from a finished/processed request to be stored in this subsystem
Public function TUniquePtr< FMassEQSRequestData > Try to Acquire the results from a request from the QueryInstance, if it is available.
Protected function  

UE_MT_DECLARE_RW_ACCESS_DETECTOR ( RequestAccessDetector
)

 The detector only guards the extension of RequestQueues array.
Protected function  

UE_MT_DECLARE_RW_ACCESS_DETECTOR ( ResultAccessDetector
)

  

Overridden from UMassSubsystemBase

  Type Name Description
Public function Virtual void  
Public function Virtual void

Initialize ( FSubsystemCollectionBase& Collection
)

  

Typedefs

Name Description
FRequestQueue Queue holding UniquePtrs to the data required for each Request

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page