s&
newspaper
About
info
About s&box
newspaper
Latest News
published_with_changes
Changes
map
Roadmap
monitoring
Metrics
games
Games
sports_esports
Browse Games
rocket
Discover Games
business_center
Workshop
sports_esports
Games
landscape
Maps
chair
Models
texture
Materials
apparel
Clothing
construction
More..
forum
Forum
docs
Docs
docs
Documentation
dashboard
Api Reference
school
Tutorials
input
Log in with Steam
chevron_left
Change Language
简体中文
English
Русский
Español
Português-Brasil
Deutsch
日本語
Français
Polski
Türkçe
한국어
Pirate
Italiano
ไทย
繁體中文
Українська
Čeština
Nederlands
Magyar
Dansk
Suomi
Svenska
Norsk
Ελληνικά
Română
Български
Tiếng Việt
Bahasa Indonesia
Español-Latinoamérica
العربية
Api
Enums
chevron_left
API Reference
category
Enums
search
data_object
AccountTypes
data_object
ActivateMode
data_object
Align
data_object
AnimatorSitPose
data_object
AnimTagStatus
data_object
AssetTypeFlags
data_object
AttachmentMode
data_object
AudioCodec
data_object
AudioSurface
data_object
AutoScale
data_object
Axis
data_object
BackgroundRepeat
data_object
BevelEdgesMode
data_object
BillboardAlignment
data_object
BillboardMode
data_object
BlendMode
data_object
BlendMode
data_object
BloomMode
data_object
BodyGroups
data_object
BooleanOperation
data_object
BorderImageFill
data_object
BorderImageRepeat
data_object
BridgeUVMode
data_object
BroadcastEventType
data_object
BuildStep
data_object
ButtonMode
data_object
CableTextureOrientation
data_object
CapStyle
data_object
CheckState
data_object
ClearFlags
data_object
ClothingCategory
data_object
ClothingSource
data_object
ClutterMode
data_object
Codec
data_object
CodeGeneratorFlags
data_object
ColliderFlags
data_object
CollisionMode
data_object
CollisionType
data_object
ColorSpaceEnum
data_object
ComponentConnectivityType
data_object
ComponentFlags
data_object
ComputeBufferType
data_object
Container
data_object
ControlPointValueInput
data_object
ConVarFlags
data_object
CubemapDynamicUpdate
data_object
CubemapResolution
data_object
CullMode
data_object
CursorShape
data_object
DenoiseModes
data_object
DisplayMode
data_object
DissolveRemoveVertexCondition
data_object
DockArea
data_object
DockProperty
data_object
DoorMode
data_object
DoorState
data_object
DownsampleMethod
data_object
DragDropTarget
data_object
DragTypes
data_object
DropAction
data_object
EdgeSmoothMode
data_object
EditorTint
data_object
ElideMode
data_object
EncodingPreset
data_object
EntryType
data_object
EnvmapProbeMode
data_object
EvaluationType
data_object
EvaluationType
data_object
ExposureColorSpaceEnum
data_object
ExtentType
data_object
FaceMode
data_object
FilterMode
data_object
FilterMode
data_object
FilterType
data_object
FindMode
data_object
FingerValue
data_object
Flag
data_object
FlexDirection
data_object
FocusChangeReason
data_object
FocusMode
data_object
FogInfluence
data_object
FogLightingMode
data_object
FogType
data_object
FontSmooth
data_object
FontStyle
data_object
FontVariantNumeric
data_object
Fsr3UpscalerQuality
data_object
GameLoadingFlags
data_object
GameObjectFlags
data_object
GameObjectUndoFlags
data_object
GamepadCode
data_object
GradingType
data_object
GridAxis
data_object
HAlignment
data_object
HAlignment
data_object
Hand
data_object
HandleMode
data_object
HandleMode
data_object
HandSources
data_object
HapticTarget
data_object
HitboxShape
data_object
HoldTypes
data_object
IconModes
data_object
ImageFormat
data_object
ImageRendering
data_object
InputAnalog
data_object
InputGlyphSize
data_object
InputOutputType
data_object
InsertMode
data_object
InsideGeometryBehavior
data_object
InvokeType
data_object
ItemEdge
data_object
JointMotion
data_object
JointType
data_object
Justify
data_object
KeyboardModifiers
data_object
KeyCode
data_object
LengthUnit
data_object
LightShape
data_object
LobbyPrivacy
data_object
LogLevel
data_object
LoopMode
data_object
MaskMode
data_object
MaskScope
data_object
MeshPrimitiveType
data_object
ModelArchetype
data_object
ModelSources
data_object
MotionRange
data_object
MotorMode
data_object
MotorMode
data_object
MouseButtons
data_object
MouseVisibility
data_object
MoveStyles
data_object
MultisampleAmount
data_object
NavMeshPathStatus
data_object
NegativeTags
data_object
NetFlags
data_object
NetPermission
data_object
NetworkFlags
data_object
NetworkMode
data_object
NetworkOrphaned
data_object
NoiseType
data_object
NotificationLevel
data_object
ObjectFit
data_object
Orientation
data_object
OverflowMode
data_object
OwnerJoinState
data_object
OwnerTransfer
data_object
PanelInputType
data_object
ParticleSortMode
data_object
ParticleSortMode
data_object
PathArcSize
data_object
PathDirection
data_object
PathFillType
data_object
PenStyle
data_object
PhysicsBodyType
data_object
PhysicsMotionType
data_object
PhysicsSimulationMode
data_object
PointerEvents
data_object
PoseSources
data_object
PoseTypes
data_object
PositionMode
data_object
PositionMode
data_object
PositiveTags
data_object
PostProcessQuality
data_object
PrimitiveType
data_object
PrimitiveType
data_object
ProjectionMode
data_object
PropertyAccessor
data_object
PseudoClass
data_object
QueuedFileState
data_object
RangeType
data_object
Reason
data_object
ReleaseMode
data_object
RenderMode
data_object
RenderValue
data_object
ResourceState
data_object
Result
data_object
ReviewScore
data_object
RigidbodyFlags
data_object
SampleQuality
data_object
SceneCameraDebugMode
data_object
SceneLayerType
data_object
SceneRenderLayer
data_object
ScrollbarMode
data_object
SelectMode
data_object
ShadowQuality
data_object
ShadowRenderType
data_object
ShortcutContext
data_object
ShortcutType
data_object
SimplifyMethod
data_object
SimulationSpace
data_object
SittingStyle
data_object
SizeConstraint
data_object
SizeMode
data_object
SizeType
data_object
Slots
data_object
SortOrder
data_object
SoundFormat
data_object
SoundSelectionMode
data_object
SpecialMoveStyle
data_object
SpringForceMode
data_object
Stage
data_object
Stage
data_object
StereoTargetEye
data_object
StreamService
data_object
SyncFlags
data_object
SyncFlags
data_object
TargetType
data_object
TerrainFlags
data_object
TextAlign
data_object
TextDecoration
data_object
TextDecorationStyle
data_object
TextFlag
data_object
TextOverflow
data_object
TextSkipInk
data_object
TextTransform
data_object
TextureAddressMode
data_object
TextureDimension
data_object
TextureFlags
data_object
TextureJustification
data_object
TextureQuality
data_object
TileSizeOption
data_object
TimingMode
data_object
TonemappingMode
data_object
ToolbarPosition
data_object
ToolButtonStyle
data_object
TrackedDeviceRole
data_object
TrackedDeviceType
data_object
TrackingTypes
data_object
TriggerType
data_object
Type
data_object
UpscalerMode
data_object
UsageFlags
data_object
VAlignment
data_object
VAlignment
data_object
ValueType
data_object
ValueType
data_object
VertexAttributeFormat
data_object
VertexAttributeType
data_object
VfxCompileTarget_t
data_object
ViewportAnchorType
data_object
Visibility
data_object
VoiceMode
data_object
VolumetricFogQuality
data_object
VolumeTypes
data_object
VRHandJoint
data_object
WhiteSpace
data_object
WindowFlags
data_object
WordBreak
data_object
Wrap
Enums
search
list
(global)
1
GameObjectUndoFlags
enum
list
Editor
20
CheckState
enum
Check state of a Editor.Checkbox.
CursorShape
enum
TODO: Make this match whatever we do in game
DockArea
enum
DropAction
enum
Used to tell the user what kind of action will happen during a drag and drop event on mouse release. In Windows, these actions will also display text near cursor to let the user know what will happen if they release their mouse button.
ElideMode
enum
FocusChangeReason
enum
Describes why a Editor.Widgets' keyboard focus has changed via Editor.Widget.OnFocus(Editor.FocusChangeReason) and Editor.Widget.OnBlur(Editor.FocusChangeReason) callbacks.
FocusMode
enum
InputOutputType
enum
KeyCode
enum
Orientation
enum
PenStyle
enum
RenderMode
enum
ScrollbarMode
enum
ShortcutContext
enum
Scope of the shortcut. Requires focus at this level for the shortcut to be active. Defaults to Editor.ShortcutContext.WindowShortcut.
ShortcutType
enum
SizeConstraint
enum
SizeMode
enum
ToolbarPosition
enum
ToolButtonStyle
enum
WindowFlags
enum
list
Editor.BaseItemWidget
2
DragDropTarget
enum
ItemEdge
enum
list
Editor.ComboBox
1
InsertMode
enum
list
Editor.CreateModelFromMeshDialog
1
CollisionMode
enum
list
Editor.DockManager
1
DockProperty
enum
list
Editor.EditorPreferences
1
NotificationLevel
enum
list
Editor.GraphicsView
2
DragTypes
enum
ViewportAnchorType
enum
list
Editor.MapEditor
1
SelectMode
enum
list
Editor.StandaloneExporter
2
BuildStep
enum
QueuedFileState
enum
list
Editor.TextureResidencyInfo
1
TextureDimension
enum
list
HalfEdgeMesh
1
ComponentConnectivityType
enum
list
NativeEngine
1
VfxCompileTarget_t
enum
list
RangedFloat
1
RangeType
enum
Range type of RangedFloat.
list
Sandbox
49
AssetTypeFlags
enum
Flags for Sandbox.AssetTypeAttribute
AudioSurface
enum
Defines acoustic properties of a surface, which defines how sound will bounce
BlendMode
enum
Blend modes used by the UI system
ClearFlags
enum
Flags for clearing a RT before rendering a scene using a SceneCamera
CodeGeneratorFlags
enum
Used to specify what type of code generation to perform.
ColliderFlags
enum
ComponentFlags
enum
ComputeBufferType
obsolete
enum
ConVarFlags
enum
EditorTint
enum
FindMode
enum
Flags to search for Components. I've named this something generic because I think we can re-use it to search for GameObjects too.
GameObjectFlags
enum
GamepadCode
enum
Game controller codes, driven from SDL.
HapticTarget
enum
Places you can trigger haptics on
ImageFormat
enum
Format used when creating textures.
InputAnalog
enum
An analog input, when fetched, is between -1 and 1 (0 being default)
InputGlyphSize
enum
JointMotion
enum
KeyboardModifiers
enum
LogLevel
enum
MeshPrimitiveType
enum
Possible primitive types of a Sandbox.Mesh.
ModelArchetype
enum
Default model archetypes. These types are defined in "tools/model_archetypes.txt".
MouseButtons
enum
State of mouse buttons being pressed or not.
MouseVisibility
enum
The visibility state of the mouse cursor.
MultisampleAmount
enum
NetFlags
enum
NetPermission
obsolete
enum
Specifies who can invoke an action over the network.
NetworkFlags
enum
Describes the behavior of network objects.
NetworkMode
enum
Specifies how a Sandbox.GameObject should be networked.
NetworkOrphaned
enum
Specifies what happens when the owner of a networked object disconnects.
OwnerTransfer
enum
Specifies who can control ownership of a networked object.
PhysicsBodyType
enum
PhysicsMotionType
enum
Represents
Physics body's
motion type.
PhysicsSimulationMode
enum
Physics simulation mode. For use with Sandbox.PhysicsWorld.SimulationMode.
PropertyAccessor
enum
RigidbodyFlags
enum
SceneCameraDebugMode
enum
SceneLayerType
enum
SceneRenderLayer
enum
SceneObjects can be rendered on layers other than the main game layer. This is useful if, for example, you want to render on top of everything without applying post processing.
SoundFormat
enum
StereoTargetEye
enum
StreamService
enum
Streamer integration services
SyncFlags
enum
Describes the behaviour of network synchronization.
TerrainFlags
enum
TextFlag
enum
Flags dictating position of text (and other elements). Default alignment on each axis is Top, Left. Values for each axis can be combined into a single value, conflicting values have undefined behavior.
TextureFlags
enum
Flags providing hints about a texture
VertexAttributeFormat
enum
VertexAttributeType
enum
VoiceMode
enum
Voice chat activation mode preference.
list
Sandbox.AmbientOcclusion
2
DenoiseModes
enum
SampleQuality
obsolete
enum
list
Sandbox.BallJoint
1
MotorMode
enum
list
Sandbox.BaseChair
1
AnimatorSitPose
enum
list
Sandbox.Bloom
1
FilterMode
enum
list
Sandbox.CableComponent
1
CableTextureOrientation
enum
list
Sandbox.CameraComponent
1
Axis
enum
list
Sandbox.Citizen.CitizenAnimationHelper
5
Hand
enum
HoldTypes
enum
MoveStyles
enum
SittingStyle
enum
SpecialMoveStyle
enum
list
Sandbox.Clothing
3
BodyGroups
enum
ClothingCategory
enum
Slots
enum
list
Sandbox.Clothing.IconSetup
1
IconModes
enum
list
Sandbox.Clutter.ClutterComponent
1
ClutterMode
enum
Clutter generation mode.
list
Sandbox.Clutter.ClutterDefinition
1
TileSizeOption
enum
Tile size options for streaming mode.
list
Sandbox.ColorGrading
2
ColorSpaceEnum
enum
GradingType
enum
list
Sandbox.Compiler
1
ReleaseMode
enum
list
Sandbox.Connection.Filter
1
FilterType
enum
list
Sandbox.Curve
1
HandleMode
enum
Describes how the line should behave when entering/leaving a frame
list
Sandbox.Doo
1
InvokeType
enum
Determines how an invoke block resolves its target method.
list
Sandbox.Doo.TargetComponent
1
TargetType
enum
list
Sandbox.Dresser
1
ClothingSource
enum
list
Sandbox.Engine
1
GameLoadingFlags
enum
list
Sandbox.Engine.Settings
6
Fsr3UpscalerQuality
enum
Controls the upscaler quality preset which determines the internal render resolution. Higher quality = higher resolution = better image but lower performance.
PostProcessQuality
enum
Controls the quality level of post processing effects such as: ambient occlusion, depth of field, motion blur and more
ShadowQuality
enum
TextureQuality
enum
UpscalerMode
enum
Selects which upscaler is used to take a lower-resolution scene render and upscale it back to display resolution. Mirrors the
r_upscaling
ConVar.
VolumetricFogQuality
enum
list
Sandbox.EnvmapProbe
3
CubemapDynamicUpdate
enum
CubemapResolution
enum
EnvmapProbeMode
enum
list
Sandbox.GameObjectSystem
1
Stage
enum
A list of stages in the scene tick in which we can hook
list
Sandbox.Gizmo
1
GridAxis
enum
list
Sandbox.GpuBuffer
1
UsageFlags
enum
You can combine these e.g UsageFlags.Index | UsageFlags.ByteAddress for a buffer that can be used as an index buffer and in a compute shader.
list
Sandbox.Gradient
1
BlendMode
enum
Describes how the line should behave when entering/leaving a frame
list
Sandbox.Graphics
2
DownsampleMethod
enum
Which method to use when downsampling a texture
PrimitiveType
enum
list
Sandbox.HingeJoint
1
MotorMode
enum
list
Sandbox.HullCollider
1
PrimitiveType
enum
list
Sandbox.IndirectLightVolume
1
InsideGeometryBehavior
enum
Behavior when a probe is detected inside geometry. Relocation moves the probe out of geometry to reduce artifacts, while Deactivate simply disables the occluded probe, sealing leaks entirely.
list
Sandbox.Joint
1
AttachmentMode
enum
list
Sandbox.Light
1
FogInfluence
enum
list
Sandbox.ManualHitbox
1
HitboxShape
enum
list
Sandbox.Mapping.Button
1
ButtonMode
enum
The button's behavior mode.
list
Sandbox.Mapping.Door
2
DoorMode
enum
DoorState
enum
The door's state
list
Sandbox.MeshComponent
1
CollisionType
enum
list
Sandbox.ModelRenderer
1
ShadowRenderType
enum
list
Sandbox.Navigation
1
NavMeshPathStatus
enum
list
Sandbox.Network
1
LobbyPrivacy
enum
list
Sandbox.Package
1
Type
enum
list
Sandbox.ParticleControlPoint
1
ControlPointValueInput
obsolete
enum
list
Sandbox.ParticleEffect
2
SimulationSpace
enum
TimingMode
enum
list
Sandbox.ParticleFloat
2
EvaluationType
enum
ValueType
enum
list
Sandbox.ParticleGradient
2
EvaluationType
enum
ValueType
enum
list
Sandbox.ParticleSpriteRenderer
2
BillboardAlignment
enum
ParticleSortMode
enum
list
Sandbox.ParticleTextRenderer
1
ParticleSortMode
enum
list
Sandbox.PartyRoom
1
OwnerJoinState
enum
Used by party members to know when to preload the game package, and when to connect to the party leader's server.
list
Sandbox.Physics.CollisionRules
1
Result
enum
Result of a collision between
two objects
.
list
Sandbox.PhysicsBodyBuilder
1
SimplifyMethod
enum
The method used to simplify a hull.
list
Sandbox.PhysicsGroupDescription
1
JointType
enum
list
Sandbox.PolygonMesh
7
BevelEdgesMode
enum
BooleanOperation
enum
BridgeUVMode
enum
DissolveRemoveVertexCondition
enum
EdgeSmoothMode
enum
ExtentType
enum
TextureJustification
enum
list
Sandbox.Rendering
5
FilterMode
enum
Represents filtering modes for texture sampling in the rendering pipeline.
RenderValue
enum
ResourceState
enum
Used to describe a GPU resources state for barrier transitions.
Stage
enum
TextureAddressMode
enum
Specifies how texture coordinates outside the [0.0, 1.0] range are handled.
list
Sandbox.Rendering.CommandList
1
Flag
enum
Command buffer flags allow us to skip command buffers if the camera doesn't want a particular thing. Like post processing.
list
Sandbox.Resources.RandomTextureGenerator
1
NoiseType
enum
list
Sandbox.SceneCamera.BloomAccessor
1
BloomMode
enum
list
Sandbox.SceneCubemap
1
ProjectionMode
enum
list
Sandbox.SceneCullingBox
1
CullMode
enum
Cull mode, either inside or outside
list
Sandbox.SceneLight
2
FogLightingMode
enum
LightShape
enum
list
Sandbox.SceneLineObject
2
CapStyle
enum
FaceMode
enum
list
Sandbox.SceneModel
1
AnimTagStatus
enum
Enumeration that describes how the AnimGraph tag state changed. Used in Sandbox.SceneModel.AnimTagEvent.
list
Sandbox.SceneSkyBox
1
FogType
enum
list
Sandbox.ScreenPanel
1
AutoScale
enum
list
Sandbox.Services.Reports
1
Reason
enum
list
Sandbox.Services.Review
3
NegativeTags
enum
PositiveTags
enum
ReviewScore
enum
list
Sandbox.SoundEvent
1
SoundSelectionMode
enum
list
Sandbox.SoundscapeTrigger
1
TriggerType
enum
list
Sandbox.Spline
1
HandleMode
enum
Describes how the spline should behave when entering/leaving a point.
list
Sandbox.SpringJoint
1
SpringForceMode
enum
list
Sandbox.Sprite
2
BroadcastEventType
enum
LoopMode
enum
The different loop modes for sprite animation.
list
Sandbox.SpriteRenderer
1
BillboardMode
enum
list
Sandbox.SteamId
1
AccountTypes
enum
The different types of Steam accounts.
list
Sandbox.Storage
2
SortOrder
enum
Visibility
enum
This matches ERemoteStoragePublishedFileVisibility in native
list
Sandbox.Terrain
1
SyncFlags
enum
list
Sandbox.TextRenderer
2
HAlignment
enum
Represents the horizontal alignment of the text.
VAlignment
enum
Represents the vertical alignment of the text.
list
Sandbox.Tonemapping
2
ExposureColorSpaceEnum
enum
TonemappingMode
enum
Options to select a tonemapping algorithm to use for color grading.
list
Sandbox.UI
29
Align
enum
Possible values for
align-items
CSS property.
BackgroundRepeat
enum
Possible values for
background-repeat
CSS property.
BorderImageFill
enum
State of
fill
setting of
border-image-slice
(
border-image
) CSS property.
BorderImageRepeat
enum
Possible values for
border-image-repeat
(
border-image
) CSS property.
DisplayMode
enum
Possible values for
display
CSS property.
FlexDirection
enum
Possible values for
flex-direction
CSS property.
FontSmooth
enum
Possible values for
font-smooth
CSS property.
FontStyle
enum
Possible values for
font-style
CSS property.
FontVariantNumeric
enum
Possible values for
font-variant-numeric
CSS property.
ImageRendering
enum
Possible values for
image-rendering
CSS property.
Justify
enum
Possible values for
justify-content
CSS property.
LengthUnit
enum
Possible units for various CSS properties that require length, used by Sandbox.UI.Length struct.
MaskMode
enum
Possible values for
mask-mode
CSS property.
MaskScope
enum
Possible values for
mask-scope
CSS property.
ObjectFit
enum
OverflowMode
enum
Possible values for the "overflow" CSS rule, dictating what to do with content that is outside of a panels bounds.
PanelInputType
enum
PointerEvents
enum
Possible values for
pointer-events
CSS property.
PositionMode
enum
Possible values for
position
CSS property.
PseudoClass
enum
List of CSS pseudo-classes used by the styling system for hover, active, etc. This acts as a bit-flag.
TextAlign
enum
Possible values for
text-align
CSS property.
TextDecoration
enum
Possible values for
text-decoration
CSS property.
TextDecorationStyle
enum
Possible values for
text-decoration-style
CSS property.
TextOverflow
enum
Possible values for
text-overflow
CSS property.
TextSkipInk
enum
Possible values for
text-decoration-skip-ink
CSS property.
TextTransform
enum
Possible values for
text-transform
CSS property.
WhiteSpace
enum
Possible values for
white-space
CSS property.
WordBreak
enum
Possible values for
word-break
CSS property.
Wrap
enum
Possible values for
flex-wrap
CSS property.
list
Sandbox.UI.PackageCard
1
SizeType
enum
list
Sandbox.UI.PanelTransform
1
EntryType
enum
list
Sandbox.UI.Popup
1
PositionMode
enum
list
Sandbox.Utility.Svg
3
PathArcSize
enum
Controls arc size in Sandbox.Utility.Svg.ArcToPathCommand.
PathDirection
enum
Controls arc direction in Sandbox.Utility.Svg.ArcToPathCommand.
PathFillType
enum
How to determine which sections of the path are filled.
list
Sandbox.VideoWriter
4
AudioCodec
enum
Audio codec to use for encoding.
Codec
enum
Container
enum
EncodingPreset
enum
Controls the speed/quality tradeoff of video encoding.
list
Sandbox.Voice
1
ActivateMode
enum
list
Sandbox.Volumes.SceneVolume
1
VolumeTypes
enum
list
Sandbox.VR
5
FingerValue
enum
Accessors for Sandbox.VR.VRController.GetFingerValue(Sandbox.VR.FingerValue)
MotionRange
enum
TrackedDeviceRole
enum
TrackedDeviceType
enum
VRHandJoint
enum
list
Sandbox.VR.VRHand
1
HandSources
enum
Represents a controller to use when fetching skeletal data (finger curl/splay values)
list
Sandbox.VR.VRModelRenderer
1
ModelSources
enum
Represents a controller to use when fetching the model (which device)
list
Sandbox.VR.VRTrackedObject
3
PoseSources
enum
Represents tracked devices to use when updating
PoseTypes
enum
The type of pose to track from the controller
TrackingTypes
enum
Represents transform values to update
list
Sandbox.WorldPanel
2
HAlignment
enum
VAlignment
enum