s&
About
The Project
info
About s&box
map
Roadmap
monitoring
Metrics
Engine startup and usage numbers
Updates
newspaper
Latest News
published_with_changes
Changes
Release-by-release changelog
Games
Browse Games
Discover Games
gamejams
live now
Game Jam III
Ends
Fri 25 Sep
Theme
One More Round
The jam is running. Build something, or play the entries.
£
50,000
prizepool
View the jam
Workshop
Playable
sports_esports
Games
Standalone games and gamemodes
Assets
landscape
Maps
view_in_ar
Models
texture
Materials
apparel
Clothing
apps
Everything
Every asset type in one list
Forum
Learn
Documentation
rocket_launch
Getting Started
docs
Documentation
api
API Reference
Resources
school
Tutorials
manage_search
Code Search
input
Log in with Steam
Api
Classes
ClutterGridSystem
chevron_left
Classes
class
ClutterGridSystem
Constructors
functions
ClutterGridSystem
Properties
data_object
Storage
Methods
functions
ClearAllPainted
functions
ClearComponent
functions
Dispose
functions
Erase
functions
Flush
functions
InvalidateTileAt
functions
InvalidateTilesInBounds
functions
Paint
ClutterGridSystem
Game object system that manages clutter generation. Handles infinite streaming layers and executes generation jobs.
class
Sandbox.Clutter
.
account_tree
extends
GameObjectSystem
sealed
Sandbox.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
8
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.
Dispose
(
)
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.