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 schoolTutorials
Api
Classes
ClutterGridSystem
chevron_left Classes
class
ClutterGridSystem

Constructors

functionsClutterGridSystem

Properties

data_objectStorage

Methods

functionsClearAllPaintedfunctionsClearComponentfunctionsErasefunctionsFlushfunctionsInvalidateTileAtfunctionsInvalidateTilesInBoundsfunctionsPaint
ClutterGridSystem
Game object system that manages clutter generation. Handles infinite streaming layers and executes generation jobs.
class Sandbox.Clutter .account_tree extends GameObjectSystem
sealedSandbox.Engine

build Constructors 1

ClutterGridSystem (scene)

data_object Properties 1

Storage
ClutterStorage
Storage for painted clutter model instances. Serialized with the scene - this is the source of truth for painted clutter.

functions Methods 7

ClearAllPainted ()
Clears all painted clutter (both model instances from storage and prefab GameObjects). Does not affect clutter owned by ClutterComponent volumes.
ClearComponent (component)
Clears all tiles for a specific component.
Erase (pos, radius)
Erase instances. Rebuilds on next frame update. Erases both model batches and prefab GameObjects.
Flush ()
Flush painted changes and rebuild visual batches immediately.
InvalidateTileAt (component, worldPosition)
Invalidates the tile at the given world position for a component, causing it to regenerate.
InvalidateTilesInBounds (component, bounds)
Invalidates all tiles within the given bounds for a component, causing them to regenerate.
Paint (entry, pos, rot, scale)
Paint instance. Rebuilds on next frame update. Models are batched, Prefabs become GameObjects.

Inheritance

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