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
Surface
chevron_left Classes
class
Surface

Constructors

functionsSurface

Properties

data_objectAudioSurfacedata_objectBaseSurfacedata_objectBounceThresholdremove_circleDampeningdata_objectDensitydata_objectDescriptiondata_objectElasticitydata_objectFluidAngularDragdata_objectFluidLinearDragdata_objectFrictionremove_circleImpactEffectsdata_objectIndexdata_objectNameHashdata_objectPrefabCollectiondata_objectRollingResistanceremove_circleScrapeEffectsdata_objectSoundCollectionremove_circleSoundsdata_objectTags

Methods

lockCreateAssetTypeIconfunctionsGetBaseSurfacefunctionsHasAllTagsfunctionsHasAnyTagsfunctionsHasTaglockOnDestroyfunctionsPlayCollisionSoundlockPostLoadlockPostReloadfunctionsSetBaseSurface

Static Methods

functionsFindByName
Surface
A physics surface. This is applied to each <see cref="T:Sandbox.PhysicsShape">PhysicsShape</see> and controls its physical properties and physics related sounds.
class Sandbox .account_tree extends GameResource
Sandbox.Engine

build Constructors 1

Surface ()

data_object Properties 19

AudioSurface
AudioSurface
Defines the audio properties of this surface for Steam Audio
BaseSurface
string
Filepath of the base surface. Use SetBaseSurface and GetBaseSurface.
BounceThreshold
float
Velocity threshold, below which objects will not bounce due to their elasticity.
Dampening
obsoletefloat
Density
float
Density of this surface material. This affects things like automatic mass calculation. Density is in kg/m^3.
Description
string
A concise description explaining what this surface property should be used for.
Elasticity
float
Controls bounciness.
FluidAngularDrag
float
Angular drag applied when submerged.
FluidLinearDrag
float
Linear drag applied when submerged.
Friction
float
Friction of this surface material.
ImpactEffects
obsoleteImpactEffectData
Impact effects of this surface material.
Index
int
NameHash
UInt32
PrefabCollection
SurfacePrefabCollection
Common prefabs for this surface material
RollingResistance
float
Controls how easily rolling shapes (sphere, capsule) roll on surfaces.
ScrapeEffects
obsoleteScrapeEffectData
Scrape effects of this surface material.
SoundCollection
SurfaceSoundCollection
Sounds for this surface material
Sounds
obsoleteOldSoundData
Sounds associated with this surface material.
Tags
string
A list of tags as one string.

functions Methods 10

CreateAssetTypeIcon (width, height)
Bitmap
GetBaseSurface ()
Surface
Returns the base surface of this surface, or null if we are the default surface.
HasAllTags (tags)
bool
Do we have all the tags on this hitbox?
HasAnyTags (tags)
bool
Do we have all the tags on this hitbox?
HasTag (tag)
bool
Do we have a tag?
OnDestroy ()
PlayCollisionSound (position, speed)
SoundHandle
Play a collision sound based on this shape's surface. Can return null if sound is invalid, or too quiet to play.
PostLoad ()
PostReload ()
SetBaseSurface (name)
Sets the base surface by name.

functions Static Methods 1

FindByName (name)
Surface
Returns a Surface from its name, or null

Inheritance

Resource
GameResource
Surface
people
Log in to reply
You can't reply if you're not logged in. That would be crazy.