Skip to content
Brass Orrery

Orrery Terrain · OrreryTerrain module · member function

UOrreryTerrainSubsystem::

SaveTerrainToBytesWithOptions

Blueprint

SaveTerrainToBytes keeping only some owners' features (the editor's authoring layer).

Declaration

UFUNCTION(BlueprintCallable, Category="Orrery|Terrain|Save", meta=(AutoCreateRefTerm="Options"))
bool SaveTerrainToBytesWithOptions(const FOrreryTerrainSaveOptions& Options, TArray<uint8>& OutBytes) const;
Blueprint Save Terrain to Bytes with Options
The graph as text
  1. Save Terrain to Bytes with Options (pure function; Target is Orrery Terrain Subsystem)
    • In Target (self object): self
    • In Options (OrreryTerrainSaveOptions): not connected
    • Out Out Bytes (array of Byte): not connected
    • Out Return Value (Boolean): not connected
Header
#include "OrreryTerrainSubsystem.h"
Module
PublicDependencyModuleNames.Add("OrreryTerrain"); in your module’s Build.cs.
Stability
Stable: changes within a major version only add.
Thread
Every member function is game thread unless it says otherwise. (the rule of UOrreryTerrainSubsystem)
Blueprint
Save Terrain to Bytes with Options, in Orrery › Terrain › Save

Parameters

NameTypeDefaultMeaning
Optionsconst FOrreryTerrainSaveOptions&——
OutBytesTArray<uint8>&——

Returns

false when there is no terrain, an owner domain is out of range, a paged-out code could not be read back, or the save passes 2 GiB (use SaveTerrainToFile).