1. Epic GamesDeveloper
  3. UMLAdapterManager

UMLAdapterManager

The manager of the MLAdapter system.

API > API/Plugins > API/Plugins/MLAdapter > API/Plugins/MLAdapter/Managers

Inheritance Hierarchy

References

   
Module MLAdapter
Header /Engine/Plugins/AI/MLAdapter/Source/MLAdapter/Public/Managers/MLAdapterManager.h
Include #include "Managers/MLAdapterManager.h"

Syntax

UCLASS&40;Transient&41;  
class UMLAdapterManager :  
    public UObject,  
    public FTickableGameObject,  
    public FSelfRegisteringExec

Remarks

The manager of the MLAdapter system. Sets up the RPC server for communication with remote client. Based on settings, creates and ticks the UMLAdapterSession. Tells the UMLAdapterLibrarian to gather its classes. A singleton instance is setup automatically during OnPostEngineInit if this plugin is included.

Variables

  Type Name Description
Protected variable uint32: 1 bCommonFunctionsAdded  
Protected variable FDelegateHandle BeginPIEHandle  
Protected variable uint32: 1 bTickWorldManually  
Protected variable EMLAdapterServerMode CurrentFunctionMode  
Protected variable uint16 CurrentPort  
Protected variable uint16 CurrentServerThreads  
Protected variable TArray< uint8 > Data  
Protected variable FDelegateHandle EndPIEHandle  
Protected variable UProperty TObjectPtr< UWorld > LastActiveWorld  
Protected variable UProperty FMLAdapterLibrarian Librarian  
Protected variable FOnGenericRPCServerDelegate OnAddClientFunctions  
Protected variable FOnGenericRPCServerDelegate OnAddServerFunctions  
Protected variable FOnGenericEvent OnCurrentSessionChanged  
Protected variable FDelegateHandle OnGameModeInitializedHandle  
Protected variable FDelegateHandle OnGameModeMatchStateSetHandle  
Protected variable FDelegateHandle OnGameModePostLoginHandle  
Protected variable FDelegateHandle OnPostWorldInitializationHandle  
Protected variable FDelegateHandle OnWorldCleanupHandle  
Protected variable EMLAdapterServerMode RequestedFunctionMode  
Protected variable UProperty TObjectPtr< UMLAdapterSession > Session  
Protected variable int32 StepsRequested Is the manager is in 'manual ticking mode' (where external client is responsible for progressing the world sim by calling 'request_world_tick' function) the simulation will progress by StepsRequested ticks before pausing
Protected variable float WorldFPS  

Constructors

  Type Name Description
Public function  

UMLAdapterManager ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Protected function void  
Public function Virtual void Binds the manager's world, game mode, and editor delegates - called during PostInitProperties.
Public function Virtual void Cleans up all the manager's delegates - called during BeginDestroy.
Public function Virtual void  
Public function Virtual void "Client" in this context means UnrealEngine game client, not RPC client.
Public function Virtual void "Server" in this context means UnrealEngine game server, not RPC server.
Public function Virtual void Essentially calls both the server and client versions.
Public function Virtual UMLAdapterSession *  
Public function Virtual void If given World doesn't have an AI system, this call results in creating one.
Public function Virtual void If given World doesn't have a Navigation system instance, this call results in creating one.
Public function Static UMLAdapterManager &

Get ()

 Inlines
Public function Const const FMLAdapterLibrarian & Get this manager's librarian.
Public function FOnGenericRPCServerDelegate &  
Public function FOnGenericRPCServerDelegate &  
Public function FOnGenericEvent &  
Public function Virtual UMLAdapterSession & Returns the current session. If one doesn't exist, it gets created.
Public function Const bool  
Public function Static bool

IsReady ()

 Returns true if the manager instance exists.
Public function Virtual Const bool True if there is an RPC server currently running.
Public function Const bool Returns true if this manager is not being ticked manually by the remote client.
Public function Virtual void

OnBeginPIE ( const bool bIsSimulating
)

  
Public function Virtual void

OnEndPIE ( const bool bIsSimulating
)

  
Public function Virtual void Notifies the session that the game mode has initialized.
Public function Virtual void This might not get called at all if the project's game mode doesn't extend AGameMode.
Public function Virtual void Notifies the session a player has connected.
Public function Virtual void Starts the RPC server if the world is a game world
Public function Virtual void

OnWorldCleanup ( UWorld* World,
bool bSessionEnded,
bool bCleanupResources
)

 Closes the current session.
Public function Static void  
Public function void Register an actuator class with this manager's librarian.
Public function void Register an agent class with this manager's librarian.
Public function void Register a sensor class with this manager's librarian.
Public function Virtual void  
Public function void

SetManualWorldTickEnabled ( bool bEnable
)

  
Public function Virtual void

SetSession ( UMLAdapterSession* NewSession
)

  
Protected function Virtual Const bool

ShouldInitForWorld ( const UWorld& World
)

  
Public function Virtual void

StartServer ( uint16 Port,
EMLAdapterServerMode InMode,
uint16 ServerThreads
)

 Starts a new RPC server.
Public function Virtual void Stop the RPC server.

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.
Public function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.

Overridden from FTickableGameObject

  Type Name Description
Public function Virtual Const bool Used to determine whether the object should be ticked in the editor.
Public function Virtual Const bool Used to determine if an object should be ticked when the game is paused.

Overridden from FTickableObjectBase

  Type Name Description
Public function Virtual Const TStatId Return the stat id to use for this tickable
Public function Virtual Const ETickableTickType Virtual that can be overloaded by the inheriting class.
Public function Virtual Const bool Virtual that can be overloaded by the inheriting class.
Public function Virtual void

Tick ( float DeltaTime
)

 FTickableGameObject begin.

Overridden from FExec

  Type Name Description
Public function Virtual bool

Exec ( UWorld* InWorld,
const TCHAR* Cmd,
FOutputDevice& Ar
)

 FExec begin.

Typedefs

Name Description
FOnGenericEvent  
FOnGenericRPCServerDelegate  
FRPCFunctionBind  

Constants

Name Description
ManagerInstance  
OnPostInit  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page