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 > UE4U4MLSession

Light Theme

Dark Theme

UE4U4MLSession

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UE4U4MLSession

References

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

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)()
class UE4U4MLSession : public UObject

Variables

		Name	Description
	FDelegateHandle	ActorSpawnedDelegateHandle
	FCriticalSectio...	AgentOpCS
	TArray< U4MLAge...	Agents
	TMap< uint32, U...	AvatarToAgent
	TArray< U4MLAge...	AwaitingAvatar
	bool	bActive
	bool	bTickWorldManually
	AGameModeBase &...	CachedGameMode
	UWorld *	CachedWorld
	float	LastTimestamp
	FOnAgentAvatarC...	OnAgentAvatarChanged
	FOnBeginAgentRe...	OnBeginAgentRemove
	E4MLSimState	SimulationState
	TSharedPtr< FWo...	WorldTicker

Functions

	Name	Description
F4ML::FAgent...	AddAgent()	Agent/Avatar management.
F4ML::FAgent...	AddAgent ( const F4MLAgentConfig& InConfig )	Agent/Avatar management.
void	BindAvatar ( U4MLAgent& Agent, AActor& Avatar )
void	ClearAvatar ( U4MLAgent& Agent )
void	Close()
void	ConfigureAsClient()	This is where Session can add Client-side-specific functions by calling U4MLManager::Get().AddClientFunctionBind.
void	ConfigureAsServer()	This is where Session can add Authority-side-specific functions by calling U4MLManager::Get().AddServerFunctionBind
const U4MLAg...	FindAgentByAvatar ( AActor& Avatar )
void	FindAvatars ( UWorld& World )	Finds avatar in given World for every avatar-less agent in AwaitingAvatar
U4MLAgent &#...	GetAgent ( F4ML::FAgentID AgentID )
int32	GetAgentsCount()
UGameInstanc...	GetGameInstance()
F4ML::FAgent...	GetNextAgentID ( F4ML::FAgentID ReferenceAgentID )	That the return value might be equal to ReferenceAgentID if there's only one agent.
FOnAgentAvat...	GetOnAgentAvatarChanged()
FOnBeginAgen...	GetOnBeginAgentRemove()
float	GetTimestamp()
UWorld *	GetWorld()
uint32	HashAvatar ( const AActor& Avatar )
bool	IsAgentReady ( F4ML::FAgentID AgentID )
bool	IsDone()
bool	IsReady()
void	OnActorSpawned ( AActor* InActor )
void	OnGameModeInitialized ( AGameModeBase& GameModeBase )
void	OnGameModeMatchStateSet ( FName InMatchState )
void	OnGameModePostLogin ( AGameModeBase* GameMode, APlayerController* NewPlayer )
void	OnPostWorldInit ( UWorld& World )
void	OnWorldCleanup ( UWorld& World, bool bSessionEnded, bool bCleanupResources )
void	Open()
void	RemoveAgent ( F4ML::FAgentID AgentID )
void	RemoveAvatars ( UWorld* World )	Processes Agents and removes all agent avatars belonging to World.
bool	RequestAvatarForAgent ( F4ML::FAgentID& AgentID, UWorld* InWorld )
bool	RequestAvatarForAgent ( U4MLAgent& Agent, UWorld* InWorld, const bool bForceSearch )	Finds a suitable avatar in InWorld (or CachedWorld, if InWorld is null) for given agent, as specified by F4MLAgentConfig.AvatarClass and confirmed by Agent->IsSuitableAvatar call.
void	ResetWorld ( F4ML::FAgentID AgentID )	Using F4ML::InvalidAgentID for AgentID will reset all agents
void	SetGameMode ( AGameModeBase* GameModeBase )	Debug
void	SetManualWorldTickEnabled ( bool bEnable )
void	SetWorld ( UWorld* NewWorld )	NewWorld might be null
void	Tick ( float DeltaTime )

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.

Classes

	Name	Description
	FWorldTicker

Typedefs

Name	Description
FOnAgentAvatarChangedDelegate
FOnBeginAgentRemove

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

Take our survey

Dismiss