Struct FTryllLocalizedAgentSet¶

ClassList > FTryllLocalizedAgentSet

#include <TryllTextResolve.h>

Public Types¶

Type	Name
typedef TFunction< void(uint64 AgentId, const FString &AssetName)>	FApplied
typedef TFunction< void(uint64 AgentId, const FString &AssetName, const FTryllError &Error)>	FFail
typedef TFunction< void( const TSharedPtr< FTryllAgent > &Agent, const FString &NodeName, UTryllNodeParamsBase Params, TFunction< void(const FTryllError* &)> OnComplete)>	FSend

Public Functions¶

Type	Name
	FTryllLocalizedAgentSet ()
	FTryllLocalizedAgentSet (const FTryllLocalizedAgentSet &) = delete
void	Forget (uint64 AgentId)
void	ForgetAll ()
bool	HasPending (uint64 AgentId) const
bool	IsTracked (uint64 AgentId) const
void	MarkDirty (uint64 AgentId)
int32	NoteTurnEnded (uint64 AgentId, UTryllTextProvider * Provider, const FSend & Send, const FFail & Fail, const FApplied & Applied=FApplied())
int32	Num () const
int32	Refresh (UTryllTextProvider * Provider, const FSend & Send, const FFail & Fail, const FApplied & Applied=FApplied())
int32	RefreshAgent (uint64 AgentId, UTryllTextProvider * Provider, const FSend & Send, const FFail & Fail, const FApplied & Applied=FApplied())
void	Track (const TSharedPtr< FTryllAgent > & Agent, FName Table, const FString & AssetName)
FTryllLocalizedAgentSet &	operator= (const FTryllLocalizedAgentSet &) = delete

Detailed Description¶

Live agents created with ticked Text IDs. On a language change each agent is refreshed from its current params baseline (so runtime ChangeParams survive): ticked non-structural fields are re-resolved on a clone and only nodes whose text changed are sent. One failed field sends nothing for that agent. An AgentBusy reply marks the agent dirty; the refresh is redone when its turn ends. Applied fires once the latest refresh of an agent is fully acknowledged, or at once when no text changed. A refresh started later makes the replies of an earlier one stale.

Public Types Documentation¶

typedef FApplied¶

using FTryllLocalizedAgentSet::FApplied = TFunction<void(uint64 AgentId, const FString& AssetName)>;

typedef FFail¶

using FTryllLocalizedAgentSet::FFail = TFunction<void(uint64 AgentId, const FString& AssetName, const FTryllError& Error)>;

typedef FSend¶

using FTryllLocalizedAgentSet::FSend = TFunction<void(
       const TSharedPtr<FTryllAgent>& Agent,
       const FString& NodeName,
       UTryllNodeParamsBase* Params,
       TFunction<void(const FTryllError&)> OnComplete)>;

Public Functions Documentation¶

function FTryllLocalizedAgentSet [1/2]¶

FTryllLocalizedAgentSet::FTryllLocalizedAgentSet ()

function FTryllLocalizedAgentSet [2/2]¶

FTryllLocalizedAgentSet::FTryllLocalizedAgentSet (
    const FTryllLocalizedAgentSet &
) = delete

function Forget¶

void FTryllLocalizedAgentSet::Forget (
    uint64 AgentId
)

function ForgetAll¶

void FTryllLocalizedAgentSet::ForgetAll ()

function HasPending¶

bool FTryllLocalizedAgentSet::HasPending (
    uint64 AgentId
) const

function IsTracked¶

bool FTryllLocalizedAgentSet::IsTracked (
    uint64 AgentId
) const

function MarkDirty¶

void FTryllLocalizedAgentSet::MarkDirty (
    uint64 AgentId
)

function NoteTurnEnded¶

int32 FTryllLocalizedAgentSet::NoteTurnEnded (
    uint64 AgentId,
    UTryllTextProvider * Provider,
    const FSend & Send,
    const FFail & Fail,
    const FApplied & Applied=FApplied()
)

The agent's turn ended: redo the refresh when an earlier send came back AgentBusy.

function Num¶

inline int32 FTryllLocalizedAgentSet::Num () const

function Refresh¶

int32 FTryllLocalizedAgentSet::Refresh (
    UTryllTextProvider * Provider,
    const FSend & Send,
    const FFail & Fail,
    const FApplied & Applied=FApplied()
)

Refresh every tracked agent. Returns the number of node sends.

function RefreshAgent¶

int32 FTryllLocalizedAgentSet::RefreshAgent (
    uint64 AgentId,
    UTryllTextProvider * Provider,
    const FSend & Send,
    const FFail & Fail,
    const FApplied & Applied=FApplied()
)

Refresh one agent from its current baseline. Returns the number of node sends.

function Track¶

void FTryllLocalizedAgentSet::Track (
    const TSharedPtr< FTryllAgent > & Agent,
    FName Table,
    const FString & AssetName
)

function operator=¶

FTryllLocalizedAgentSet & FTryllLocalizedAgentSet::operator= (
    const FTryllLocalizedAgentSet &
) = delete

The documentation for this class was generated from the following file C:/_tryll/_monorepo3/tryll/clients/unreal/Source/TryllClient/Public/TryllTextResolve.h