API reference
Mask Class
Extends ScriptableObject
A mask that can be used to filter out objects from the scene.
Member Functions
abstract float SampleMask
( Candidate candidate )
Executes the mask on a candidate and returns the value.
Parameters
candidate
Candidate with the information from the distribution
Returns
The float depending on the mask
abstract bool Check
( Candidate c )
Checks if the candidate is valid for the given mask.
Parameters
c
Candidate with the information from the distribution
Returns
true if valid
float SampleMask
( Candidate candidate,
float scale,
float offset )
Executes the mask on a candidate with scale and offset and returns the value.
Parameters
candidate
Candidate with the information from the distribution
scale
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
The offset to apply before the mask is applied.
Returns
A float depending on the mask
float SampleMask
( Candidate candidate,
float limitMin,
float limitMax,
float scale,
float offset )
A mask that can be used to filter out objects from the scene.
Parameters
candidate
Contains the decoration prefab and the values from the distribution algorithm
limitMin
Minimum to fullfill from the mask
limitMax
Maximum to fullfill from the mask
scale
Scale the value from the mask
offset
Add offset from the mask
Returns
Did you find this page helpful?
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
English (US)
© 2025 Meta