FSculptLimits

What the authority accepts from a player's brush.

Declaration

struct FSculptLimits

Header: #include "Native/SculptCommand.h"
Module: PublicDependencyModuleNames.Add("OrreryTerrainCore"); in your module’s Build.cs.
Stability: Experimental: supported, may change in a minor version, with a changelog line.

Description

Server-side rules, so a client cannot send a 10 km radius or paint holes. The defaults are design choices, not measured figures; a game sets its own.

Note.

Tier 1, plain data. The shell fills it from FOrreryTerrainSculptLimits.

Properties

Name	Type	Default	Meaning
`MaxRadius_mm`	`uint32_t`	`100000`	100 m: the largest brush.
`MaxStrength_mm`	`int32_t`	`2000`	2 m of height change at the centre per step.
`KeepOutMargin_mm`	`uint32_t`	`2000`	Posts within this of a corridor's keep-out band are never sculpted.
`MaxPaintLayer`	`uint8_t`	`255`	Highest layer id the Paint brush may paint: the layer set's count minus 1 in a game; 255, every id, by default.
`bPaintGroundClass`	`bool`	`false`	Whether players may paint `Channels::GroundClass` (values below kGroundClasses only, never the hole). Off by default: the class is geology, and it chooses the batter row, so a player who paints rock under a cutting would buy a steeper, cheaper one.
`bPaintHoles`	`bool`	`false`	Whether kHoleClass may be painted into `Channels::GroundClass` (cut a hole), whatever bPaintGroundClass says. Authors only: the shell sets it for an editor session (FOrreryTerrainEditorSession::bPaintHoles) and never from a player's limits, so a player can never cut a hole.
`MaxStampRadius_mm`	`uint32_t`	`1000000`	Largest Stamp radius (`EBrushKind::Stamp`): 1 km, a stamp 2 km across. Every other brush, masked or not, keeps MaxRadius_mm.
`MaxStampHeight_mm`	`int32_t`	`1000000`	Largest \|Strength_mm\| of a Stamp, its peak height over its base: 1 km. Every other brush keeps MaxStrength_mm.
`MaxStampTiles`	`uint32_t`	`1024`	Most edit tiles one Stamp may touch (BrushTileCount), the real bound on its cost: 1,024. Checked when CheckSculptCommand has the grid.
`bStamps`	`bool`	`true`	Whether the authority accepts Stamps at all.