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
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
Get s&box
Sign in with Steam
Api
Classes
ClutterEntry
chevron_left
Classes
class
ClutterEntry
Constructors
functions
ClutterEntry
Properties
data_object
AssetName
data_object
CastShadows
data_object
EnablePhysics
data_object
HasAsset
data_object
LocalScale
data_object
Model
data_object
Prefab
data_object
Weight
ClutterEntry
Represents a single weighted entry in a Sandbox.Clutter.ClutterDefinition. Contains either a Prefab or Model reference along with spawn parameters.
class
Sandbox.Clutter
.
Sandbox.Engine
build
Constructors
1
ClutterEntry
(
)
data_object
Properties
8
AssetName
string
Returns the primary asset reference as a string for debugging.
CastShadows
bool
Whether instances of this entry cast shadows.
EnablePhysics
bool
Whether instances of this entry get a physics collision body. Only affects model-based entries - prefab entries bring their own physics via their own components.
HasAsset
bool
Returns whether this entry has a valid asset to spawn.
LocalScale
float
Uniform scale multiplier applied on top of whatever scale the scatterer picks per instance.
Model
Model
Model to spawn as a static prop. Only used if Sandbox.Clutter.ClutterEntry.Prefab is null.
Prefab
GameObject
Prefab to spawn. If set, this takes priority over Sandbox.Clutter.ClutterEntry.Model.
Weight
float
Relative weight for random selection. Higher values = more likely to be chosen.
people
Log in to reply
You can't reply if you're not logged in. That would be crazy.