Orrery Terrain · OrreryTerrain module · member function
UOrreryTerrainEditPolicy::
CanAddBrushMask
ExperimentalWhether Controller may upload a brush mask the server does not hold, so its brush steps can use it.
Declaration
UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category="Orrery|Terrain|Net")
bool CanAddBrushMask(APlayerController* Controller, const FOrreryTerrainMaskUploadInfo& Mask) const;- Header
#include "Net/OrreryTerrainEditPolicy.h"- Module
PublicDependencyModuleNames.Add("OrreryTerrain");in your module’s Build.cs.- Stability
- Experimental: supported, may change in a minor version, with a changelog line.
- Thread
- Game thread, on the server only.
- Blueprint
- Overridden in a Blueprint (My Blueprint, Functions, Override); no node of its own.
Description
The default refuses: a mask can draw shapes and words into a shared world, so a game opts in by overriding this. Asked once per upload, when the client offers it, after the network settings' size cap (MaxUploadMaskKilobytes) and the player's quota (MaxUploadMasksPerAuthor, MaxUploadKilobytesPerAuthor) passed; a refusal goes back as UploadsDisabled, to the upload and to the steps waiting for it. An accepted mask reaches every player and every later joiner, and stays on the server for the session.
Parameters
| Name | Type | Default | Meaning |
|---|---|---|---|
Controller | APlayer | — | The uploading player's controller on the server; null when the link has none. |
Mask | const FOrrery | — | The mask's id and size, and what the player uploaded before. |
Returns
true to let the bytes come.
Game thread, on the server only.