FSectorCloudResidency
- Module
- Game
- Header
#include "Streaming/SectorCloudResidency.h"- Namespace
Mowo
Constructors
| Signature | Name | Description |
|---|---|---|
FSectorCloudResidency() = default | FSectorCloudResidency | |
~FSectorCloudResidency() | ~FSectorCloudResidency | |
FSectorCloudResidency(const FSectorCloudResidency&) = delete | FSectorCloudResidency |
Public functions
| Returns | Name | Description |
|---|---|---|
FSectorCloudResidency& | operator= | |
void | Bind | |
void | Unbind | |
void | Configure | |
const FSettings& | GetSettings | |
void | OnSectorUnloaded | Both take the cell rectangle from the streaming grid; a chunk belongs to the cell its cloud sector's centre falls in. |
void | OnSectorLoaded | |
void | TickPending | |
uint32_t | FlushForSave | The save barrier: waits for in-flight park IO, then folds every parked chunk back into its accumulator. |
bool | IsSectorParked | |
uint32_t | ParkedSectorCount | |
uint32_t | ParkedPointCount | |
uint32_t | PendingIoCount | |
uint64_t | PointsParked | |
uint64_t | PointsRestored | |
std::string | ParkPathFor | The park file for one cell of one cloud. |
uint32_t | ReclaimOrphanedParks | Park files outlive a process that dies with cells parked, and nothing reads one without the record that named it. |
Function details
FSectorCloudResidency
FSectorCloudResidency() = default~FSectorCloudResidency
~FSectorCloudResidency()FSectorCloudResidency
FSectorCloudResidency(const FSectorCloudResidency&) = deleteoperator=
FSectorCloudResidency& operator=(const FSectorCloudResidency&) = deleteBind
void Bind(Scene* scene)Unbind
void Unbind()Configure
void Configure(const FSettings& settings)GetSettings
const FSettings& GetSettings() constOnSectorUnloaded
void OnSectorUnloaded(const SectorCoord& coord, float sectorSize)Both take the cell rectangle from the streaming grid; a chunk belongs to the cell its cloud sector's centre falls in.
OnSectorLoaded
void OnSectorLoaded(const SectorCoord& coord, float sectorSize)TickPending
void TickPending()FlushForSave
uint32_t FlushForSave()The save barrier: waits for in-flight park IO, then folds every parked chunk back into its accumulator. Returns the number of points folded.
IsSectorParked
bool IsSectorParked(const SectorCoord& coord) constParkedSectorCount
uint32_t ParkedSectorCount() constParkedPointCount
uint32_t ParkedPointCount() constPendingIoCount
uint32_t PendingIoCount() constPointsParked
uint64_t PointsParked() constPointsRestored
uint64_t PointsRestored() constParkPathFor
std::string ParkPathFor(const SectorCoord& coord, EntityID cloud) constThe park file for one cell of one cloud. Public because a park file is a plain .mpcl stream and both the tests and the cook tooling read them.
ReclaimOrphanedParks
static uint32_t ReclaimOrphanedParks(const std::string& baseDirectory)Park files outlive a process that dies with cells parked, and nothing reads one without the record that named it. Every residency therefore parks into "<base>/<pid>-<n>", and this removes the session directories under baseDirectory whose process is gone, plus loose park files from before sessions had directories. A running process's session — another game instance, another residency in this one — is never touched. Runs on the first park of every residency; returns the entries removed.