1. Epic GamesDeveloper
  3. FPollable

FPollable

Wrapper around a function for cooker tasks that need to be ticked on a schedule.

API > API/Editor > API/Editor/UnrealEd > API/Editor/UnrealEd/UCookOnTheFlyServer

Wrapper around a function for cooker tasks that need to be ticked on a schedule. Includes data to support calling it on a schedule or triggering it manually.

   
Name FPollable
Type struct
Header File /Engine/Source/Editor/UnrealEd/Classes/CookOnTheSide/CookOnTheFlyServer.h
Include Path #include "CookOnTheSide/CookOnTheFlyServer.h"

Syntax

struct FPollable : public FRefCountBase

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FPollable ( const TCHAR* InDebugName,
EManualTrigger,
FPollFunction&& InFunction
)

   CookOnTheSide/CookOnTheFlyServer.h  

FPollable ( const TCHAR* InDebugName,
float InPeriodSeconds,
float InPeriodIdleSeconds,
FPollFunction&& InFunction
)

   CookOnTheSide/CookOnTheFlyServer.h  

Enums

Public

Name Remarks
EManualTrigger  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
DebugName const TCHAR *   CookOnTheSide/CookOnTheFlyServer.h  
NextTimeIdleSeconds double Time when this should be next called, if the cooker is idle. (See also NextTimeSeconds). CookOnTheSide/CookOnTheFlyServer.h  
PeriodIdleSeconds float   CookOnTheSide/CookOnTheFlyServer.h  
PeriodSeconds float   CookOnTheSide/CookOnTheFlyServer.h  
PollFunction FPollFunction   CookOnTheSide/CookOnTheFlyServer.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void RunDuringPump ( UE::Cook::FTickStackData& StackData,
double& OutNewCurrentTime,
double& OutNextTimeSeconds
)

 Run the pollable's callback function, from PumpPollables. CookOnTheSide/CookOnTheFlyServer.h  

void RunNow ( UCookOnTheFlyServer& COTFS
)

 Run the pollable's callback function now. CookOnTheSide/CookOnTheFlyServer.h  

void RunNowInternal ( UCookOnTheFlyServer& COTFS,
double LastTimeRun
)

 Update the position of this in the Pollables queue, called from RunNow or for a deferred RunNow. CookOnTheSide/CookOnTheFlyServer.h  

void Trigger ( UCookOnTheFlyServer& COTFS
)

 Trigger the pollable to execute on the next PumpPollables CookOnTheSide/CookOnTheFlyServer.h  

void TriggerInternal ( UCookOnTheFlyServer& COTFS
)

 Update the position of this in the Pollables queue, called from Trigger or for a deferred Trigger. CookOnTheSide/CookOnTheFlyServer.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page