Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > UE4ML > UE4U4MLManager

Light Theme

Dark Theme

UE4U4MLManager

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UE4U4MLManager

References

Module	UE4ML
Header	/Engine/Plugins/AI/UE4ML/Source/UE4ML/Public/4MLManager.h
Include	#include "4MLManager.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Transient)
class UE4U4MLManager :
    public UObject,
    public FTickableGameObject,
    public FSelfRegisteringExec

Variables

	Name	Description
uint32: 1	bCommonFunctionsAdded
uint32: 1	bTickWorldManually
EUE4MLServerMod...	CurrentFunctionMode
uint16	CurrentPort
uint16	CurrentServerThreads
TArray< uint8 >	Data
UWorld *	LastActiveWorld
F4MLLibrarian	Librarian
FOnGenericRPCSe...	OnAddClientFunctions
FOnGenericRPCSe...	OnAddServerFunctions
FOnGenericEvent	OnCurrentSessionChanged
EUE4MLServerMod...	RequestedFunctionMode
U4MLSession ...	Session
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
float	WorldFPS

Functions

	Name	Description
void	AddCommonFunctions ( FRPCServer& Server )
void	BindToDelegates()
void	CloseSession ( U4MLSession& InSession )
void	ConfigureAsClient ( FRPCServer& Server )	"Client" in this context means UE4 game client, not RPC client
void	ConfigureAsServer ( FRPCServer& Server )
void	ConfigureAsStandalone ( FRPCServer& Server )	Essentially calls both the server and client versions
U4MLSession ...	CreateNewSession()
void	EnsureAISystemPresence ( UWorld& World )	If given World doesn't have an AI system this call results in creating one
void	EnsureNavigationSystemPresence ( UWorld& World )	If given World doesn't have a Navigation system instance this call results in creating one
U4MLManager ...	Get()
const F4MLLi...	GetLibrarian()
FOnGenericRP...	GetOnAddClientFunctions()
FOnGenericRP...	GetOnAddServerFunctions()
FOnGenericEv...	GetOnCurrentSessionChanged()
U4MLSession ...	GetSession()	Returns current sesison. If one doesn't exist, it gets created.
bool	HasSession()
bool	IsReady()
bool	IsRunning()
bool	IsWorldRealTime()
void	OnBeginPIE ( const bool bIsSimulating )
void	OnEndPIE ( const bool bIsSimulating )
void	OnGameModeInitialized ( AGameModeBase* GameMode )
void	OnGameModeMatchStateSet ( FName MatchState )	@note that this might not get called at all if the project's game mode doesn't extend AGameMode
void	OnGameModePostLogin ( AGameModeBase* GameMode, APlayerController* NewPlayer )
void	OnPostWorldInit ( UWorld* World, const UWorld::InitializationValues )
void	OnWorldCleanup ( UWorld* World, bool bSessionEnded, bool bCleanupResources )
void	RegisterActuatorClass ( const TSubclassOf< U4MLActuator >&... )
void	RegisterAgentClass ( const TSubclassOf< U4MLAgent >& Cl... )
void	RegisterSensorClass ( const TSubclassOf< U4MLSensor >& C... )
void	ResetWorld()
void	SetManualWorldTickEnabled ( bool bEnable )
void	SetSession ( U4MLSession* NewSession )
void	StartServer ( uint16 Port, EUE4MLServerMode InMode, uint16 ServerThreads )	If a server is already running it will be shut down before the new instance gets created
void	StopServer()
	U4MLManager ( const FObjectInitializer& ObjectIn... )

Overridden from UObject

		Name	Description
	void	BeginDestroy()	Called before destroying the object.
	void	PostInitProperties()	Called after the C++ constructor and after the properties have been initialized, including those loaded from config.

Overridden from FTickableGameObject

		Name	Description
	bool	IsTickableInEditor()	Used to determine whether the object should be ticked in the editor.
	bool	IsTickableWhenPaused()	Used to determine if an object should be ticked when the game is paused.

Overridden from FTickableObjectBase

	Name	Description
TStatId	GetStatId()	Return the stat id to use for this tickable
ETickableTic...	GetTickableTickType()	Virtual that can be overloaded by the inheriting class.
bool	IsTickable()	Virtual that can be overloaded by the inheriting class.
void	Tick ( float DeltaTime )	FTickableGameObject begin.

Overridden from FExec

		Name	Description
	bool	Exec ( UWorld* InWorld, const TCHAR* Cmd, FOutputDevice& Ar )	FExec begin.

Typedefs

Name	Description
FOnGenericEvent
FOnGenericRPCServerDelegate
FRPCFunctionBind

Constants

Name	Description
ManagerInstance
OnPostInit

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss