API reference

Mask Class

Extends ScriptableObject
A mask that can be used to filter out objects from the scene.

Methods

Check ( c )
Checks if the candidate is valid for the given mask.
Signature 
abstract bool Check(Candidate c)
Parameters
c: Candidate  Candidate with the information from the distribution
Returns
abstract bool  true if valid
SampleMask ( candidate )
Executes the mask on a candidate and returns the value.
Signature 
abstract float SampleMask(Candidate candidate)
Parameters
candidate: Candidate  Candidate with the information from the distribution
Returns
abstract float  The float depending on the mask
SampleMask ( candidate , scale , offset )
Executes the mask on a candidate with scale and offset and returns the value.
Signature 
float SampleMask(Candidate candidate, float scale, float offset=0f)
Parameters
candidate: Candidate  Candidate with the information from the distribution
scale: float  The scale to apply before the mask is applied. This can be used for example if you want to have a range of values that are all multiplied by 10.
offset: float  The offset to apply before the mask is applied.
Returns
float  A float depending on the mask
SampleMask ( candidate , limitMin , limitMax , scale , offset )
A mask that can be used to filter out objects from the scene.
Signature 
float SampleMask(Candidate candidate, float limitMin, float limitMax, float scale=1f, float offset=0f)
Parameters
candidate: Candidate  Contains the decoration prefab and the values from the distribution algorithm
limitMin: float  Minimum to fullfill from the mask
limitMax: float  Maximum to fullfill from the mask
scale: float  Scale the value from the mask
offset: float  Add offset from the mask
Returns
float
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta