Skip to content
Brass Orrery

Orrery Terrain · OrreryTerrainRenderer module · class

FTerrainGrassLoader

Experimental

Loads the grass types of a layer set asynchronously, on clients that render only.

Declaration

class FTerrainGrassLoader
Header
#include "Grass/TerrainGrassVarieties.h"
Module
PublicDependencyModuleNames.Add("OrreryTerrainRenderer"); in your module’s Build.cs.
Stability
Experimental: supported, may change in a minor version, with a changelog line.
Thread
Game thread.

Description

Owns its FStreamableManager and the load's handle; the handle keeps the types, and through them their meshes and materials, alive until Cancel or destruction. No hard reference to a grass type is stored anywhere in the layer set.

Note.

Game thread. Not copyable.

Functions

  • FTerrainGrassLoader (2 overloads)
  • operator=
  • Request

    Start loading the layer set's grass types, replacing (cancelling) any earlier request.

  • Cancel

    Cancel the pending load (OnLoaded is dropped) and release the types.

  • IsLoading

    True from Request until the types have loaded, or Cancel.

  • IsLoaded

    True when a request completed (polled: true as soon as the load has, before OnLoaded runs).

  • Wait

    Block until the pending load completes.