newspaperAbout
infoAbout s&box newspaperLatest News published_with_changesChanges mapRoadmap monitoringMetrics
gamesGames
sports_esportsBrowse Games rocketDiscover Games
business_centerWorkshop
sports_esportsGames landscapeMaps chairModels textureMaterials apparelClothing constructionMore..
forumForum docsDocs
docsDocumentation dashboardApi Reference
Api
Components
ClutterComponent
chevron_left Components
class
ClutterComponent

Constructors

functionsClutterComponent

Properties

data_objectBoundsdata_objectClutterdata_objectInfinitedata_objectModedata_objectSeeddata_objectStorage

Methods

functionsClearfunctionsClearInfinitefunctionsGeneratefunctionsInvalidateTileAtfunctionsInvalidateTilesInBounds
menu
ClutterComponent
Clutter scattering component supporting both infinite and volumes.
class Sandbox.Clutter .account_tree extends Component
sealedSandbox.Engine

build Constructors 1

ClutterComponent ()

data_object Properties 6

Bounds
BBox
Clutter
ClutterDefinition
The clutter containing objects to scatter and scatter settings.
Infinite
bool
Returns true if in infinite streaming mode.
Mode
ClutterMode
Clutter generation mode - Volume or Infinite streaming.
Seed
int
Seed for deterministic generation. Change to get different variations.
Storage
ClutterStorage
Storage for volume model instances. Serialized with component.

functions Methods 5

Clear ()
ClearInfinite ()
Clears all infinite mode tiles for this component.
Generate ()
InvalidateTileAt (worldPosition)
Invalidates the tile at the given world position, causing it to regenerate.
InvalidateTilesInBounds (bounds)
Invalidates all tiles within the given bounds, causing them to regenerate.

Inheritance

Component
ClutterComponent
people
Log in to reply
You can't reply if you're not logged in. That would be crazy.