Orrery Terrain · OrreryTerrainCore module · member function
Native::FSculptReplayer::
Pump
ExperimentalApply queued records in order until the queue is empty, one answers Pending, or MaxRecords were consumed.
Declaration
uint32_t Pump(uint32_t MaxRecords);- Header
#include "Native/SculptReplay.h"- Module
PublicDependencyModuleNames.Add("OrreryTerrainCore");in your module’s Build.cs.- Stability
- Experimental: supported, may change in a minor version, with a changelog line.
- Thread
- Game thread only, like every FTerrainWorld write. (the rule of FSculptReplayer)
Description
Consecutive brush steps of one stroke go to the world as one FTerrainWorld::ApplyBrushes run and publish once; the result is the same bytes as applying them one by one.
Parameters
| Name | Type | Default | Meaning |
|---|---|---|---|
MaxRecords | uint32_ | — | — |
Returns
Records consumed (applied or dropped); a Pending record is not consumed.