Skip to content
Brass Orrery

Orrery Terrain · OrreryTerrain module · member function

UOrreryTerrainSubsystem::

ApplySculptRequest

Apply a client's sculpt request on the authority, as that author's: each author has one open stroke of its own, and a request names the client's stroke id, which the authority binds to the stroke it opens.

Declaration

EOrreryTerrainSculptResult ApplySculptRequest(uint32 Author, const OrreryTerrain::Native::FSculptCommand& Command);
Header
#include "OrreryTerrainSubsystem.h"
Module
PublicDependencyModuleNames.Add("OrreryTerrain"); in your module’s Build.cs.
Stability
Stable: changes within a major version only add.
Thread
Game thread.

Description

The records go out with the author. The first request switches this terrain to one stroke and one undo history per author (ending the host's open stroke).

Parameters

NameTypeDefaultMeaning
Authoruint32—

The connection's author id; 0 is the server or the listen host.

Commandconst OrreryTerrain::Native::FSculptCommand&—

The decoded request: begin, brush step or end of the client's stroke (named by the client's stroke id), or an undo or redo of that author's history.

Returns

As ApplySculptRecord on the authority; Pending leaves nothing changed (send it again once the ground loaded).

Note.

Game thread. The net hub calls it after its own checks (rate, reach, the edit policy).