1. Epic GamesDeveloper
  3. UMLAdapterSession

UMLAdapterSession

Container for agents that exist in the world. Ticks the agents. Finds avatars for the agents.

API > API/Plugins > API/Plugins/MLAdapter > API/Plugins/MLAdapter/Sessions

Inheritance Hierarchy

References

   
Module MLAdapter
Header /Engine/Plugins/AI/MLAdapter/Source/MLAdapter/Public/Sessions/MLAdapterSession.h
Include #include "Sessions/MLAdapterSession.h"

Syntax

UCLASS ()  
class UMLAdapterSession : public UObject

Remarks

Container for agents that exist in the world. Ticks the agents. Finds avatars for the agents.

Variables

  Type Name Description
Protected variable FDelegateHandle ActorSpawnedDelegateHandle  
Protected variable FCriticalSection AgentOpCS  
Protected variable UProperty TArray< TObjectPtr< UMLAdapterAgent > > Agents  
Protected variable UProperty TMap< uint32, TObjectPtr< UMLAdapterAgent > > AvatarToAgent  
Protected variable UProperty TArray< TObjectPtr< UMLAdapterAgent > > AwaitingAvatar  
Protected variable bool bActive  
Protected variable bool bTickWorldManually  
Protected variable UProperty TObjectPtr< AGameModeBase > CachedGameMode  
Protected variable UProperty TObjectPtr< UWorld > CachedWorld  
Protected variable float LastTimestamp  
Protected variable FOnAgentAvatarChangedDelegate OnAgentAvatarChanged  
Protected variable FOnBeginAgentRemove OnBeginAgentRemove  
Protected variable EMLAdapterSimState SimulationState  
Protected variable TSharedPtr< FWorldTicker > WorldTicker  

Functions

  Type Name Description
Public function FMLAdapter::FAgentID Agent/Avatar management.
Public function FMLAdapter::FAgentID

AddAgent ( const FMLAdapterAgentConfig& InConfig
)

 Add an agent using the specified config.
Public function void

BindAvatar ( UMLAdapterAgent& Agent,
AActor& Avatar
)

 Sets a new avatar on the agent after clearing any existing avatar.
Public function void Remove the existing avatar from the given agent.
Public function Virtual void

Close ()

 Mark the session as inactive and cleanup all agents.
Public function Virtual void This is where Session can add Client-side-specific functions by calling UMLAdapterManager::Get().AddClientFunctionBind.
Public function Virtual void This is where Session can add Authority-side-specific functions by calling UMLAdapterManager::Get().AddServerFunctionBind
Public function void

EnableActionDuration ( FMLAdapter::FAgentID AgentID,
bool bEnable,
float DurationSeconds
)

 Enable/disable the action durations with the specified time duration in seconds.
Public function Const const UMLAdapterAgent * Find an agent that is controlling the given avatar if one exists. Returns nullptr if not.
Public function void

FindAvatars ( UWorld& World
)

 Finds avatar in given World for every avatar-less agent in AwaitingAvatar
Public function UMLAdapterAgent * Returns the agent corresponding to the given ID. Returns nullptr if the ID is invalid.
Public function Const int32  
Public function Const UGameInstance *  
Public function Const FMLAdapter::FAgentID

GetNextAgentID ( FMLAdapter::FAgentID ReferenceAgentID
)

  
Public function FOnAgentAvatarChangedDelegate  
Public function FOnBeginAgentRemove  
Public function Const float Get the world time in seconds at the most recent time this session ticked.
Public function Virtual Const UWorld * Get this session's cached world.
Protected function Static uint32

HashAvatar ( const AActor& Avatar
)

  
Public function Const bool Returns true if the agent with the given ID has a valid avatar assigned.
Public function Const bool

IsDone ()

 A session is done if the SimulationState == Finished or the game mode's match has ended.
Public function Const bool

IsReady ()

 A session is ready if the SimulationState == InProgress or the game mode's match has started but not ended.
Public function Virtual void

OnActorSpawned ( AActor* InActor
)

 If there are agents waiting for an avatar, then check if a newly spawned actor fits the agent.
Public function Virtual void  
Public function Virtual void

OnGameModeMatchStateSet ( FName InMatchState
)

  
Public function Virtual void  
Public function Virtual void

OnPostWorldInit ( UWorld& World
)

  
Public function Virtual void

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

  
Public function Virtual void

Open ()

 Mark the session as active.
Public function void Remove the agent with the given ID from this session.
Public function void

RemoveAvatars ( UWorld* World
)

 Processes Agents and removes all agent avatars belonging to World.
Public function bool Calls RequestAvatarForAgent(UMLAdapterAgent& Agent, ...) after looking up the agent by its ID.
Public function Virtual bool

RequestAvatarForAgent ( UMLAdapterAgent& Agent,
UWorld* InWorld,
const bool bForceSearch
)

 Finds a suitable avatar in InWorld (or CachedWorld, if InWorld is null) for given agent, as specified by FMLAdapterAgentConfig.AvatarClass and confirmed by Agent->IsSuitableAvatar call.
Public function Virtual void Using FMLAdapter::InvalidAgentID for AgentID will reset all agents.
Protected function Virtual void

SetGameMode ( AGameModeBase* GameModeBase
)

 Debug
Public function void

SetManualWorldTickEnabled ( bool bEnable
)

 If true, the world's ticking will be controlled by the remote client.
Public function Virtual void

SetWorld ( UWorld* NewWorld
)

 Sets the world that this session will use to find avatars for agents
Public function Virtual void

Tick ( float DeltaTime
)

 Call all agents' Sense(), Think(), and Act() methods.
Public function bool Resets the action duration flag if it has elapsed.

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.

Classes

  Type Name Description
Protected struct FWorldTicker    

Typedefs

Name Description
FOnAgentAvatarChangedDelegate  
FOnBeginAgentRemove  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page