Home / Edit s&box Wiki

Log in to edit

s&box Wiki

<cat>Play.Intro</cat>
<title>s&box Wiki</title>

<upload src="41122/8d905d3af45832c.jpg" size="56510" name="header_capsule.jpg" />

# Current Status

## Code

The API is 90% stable. No huge globally breaking changes are expected. It could happen, but we're taking care to mark things obsolete and give you time to move to changed APIs where possible.

## Addons

Right now we support top tier addons (games). Addons for games are planned but we want to spend time fleshing out the API before we start layering.

## Mapping and Entities

We're moving the majority of entities and entity IO to addon code. This has two big advantages.. first of all you can look at the code and see exactly how it works, what it should do and what it shouldn't. Secondly it forces us to make a bunch of stuff work in our addon code - meaning a more flexible API for everyone to use.

We're taking this as an opportunity to rename, sort and throw away a bunch of obsolete entities. This is still an ongoing process so if you can't find an entity in Hammer that you used to use, have a look around for a better named alternative - if it's still not there open an issue and we'll sort you out.

## Developer Preview

We are slowly giving out developer preview access to people. You don't need to ask us for a key. Go to the [Dev Backend](https://sbox.facepunch.com/dev/) site for more information.


# Issues

For bugs and feature requests, please visit the [Github Issues Site](https://github.com/Facepunch/sbox-issues/)

# Other Resources

There's a few other sites you should keep an eye on for updates.

+ [Monthly Dev Blogs](https://sbox.facepunch.com/news/)
+ [Development Updates](https://github.com/Facepunch/sbox-issues/discussions)
+ [Dev Backend](https://sbox.facepunch.com/dev/)
+ [API Documentation (Autogenerated)](https://asset.party/api)

S&box Wiki

Playing

Playing Guides 6

Developing

Getting Started 3

UI 8

Hammer 7

ModelDoc 15

Material Editor 5

Sound 3

Particles 5

Dev Site 1

Backend API

Coding

Getting Started 6

Making Games 3

Players 6

Camera 1

CameraMode

Networking 6

Shaders 6

Misc 20

Api Documentation

Globals 10

DebugOverlay
- Axis
- Box
- Circle
- Line
- ScreenText
- Sphere
Global
Log
- Error
- Info
- Trace
- Warning
MathX
- AlmostEqual
- Approach
- CeilToInt
- Clamp
- DegreeToRadian
- Floor
- FloorToInt
- LerpInverse
- LerpTo
- NormalizeDegrees
- RadianToDegree
- SnapToGrid
- UnsignedMod
Noise
Rand
- Color
- Double
- Float
- FromArray
- FromList
- Int
- SetSeed
RealTime
- Delta
- Now
StringX
- Base64Decode
- Base64Encode
- Columnize
- Contains
- FastHash
- GetSha256
- NormalizeFilename
- QuoteSafe
- RemoveBadCharacters
- Snippet
- SplitQuotesStrings
- ToBool
- ToDecimal
- ToFloat
- ToInt
- ToTitleCase
- ToType
- ToUInt
- ToULong
- Truncate
- TruncateFilename
- TryToType
- WildcardMatch
ThreadSafe
Time
- Delta
- Now
- Tick

Classes 2

BaseFileSystem
Html
- INode

Structs 23

Angles
- Zero
- Random
- AngleVector
- ClampAngle
- Lerp
- NormalizeAngle
- Parse
- Read
- Write
- pitch
- roll
- yaw
- Direction
- Length
- LengthSqr
- Normal
- Clamped
- IsNearlyZero
- ToRotation
- WithPitch
- WithRoll
- WithYaw
BBox
- FromHeightAndRadius
- Maxs
- Mins
- Center
- RandomPointInside
- Size
- Volume
- AddPoint
Capsule
Color
- Black
- Blue
- Cyan
- Gray
- Green
- Magenta
- Orange
- Red
- Transparent
- White
- Yellow
- Random
- Average
- FromBytes
- Lerp
- Max
- Min
- Parse
- a
- b
- g
- r
- Hex
- Item
- Luminance
- RGBA
- Read
- ToColor32
- ToHsv
- WithAlpha
- WithBlue
- WithGreen
- WithRed
- Write
Color32
- Black
- Blue
- Cyan
- Gray
- Green
- Magenta
- Red
- Transparent
- White
- Yellow
- Max
- Min
- A
- B
- G
- Hex
- Item
- R
- RGBA
- Read
- ToColor
- Write
ColorHsv
- Alpha
- Hue
- Saturation
- Value
- ToColor
- WithAlpha
- WithHue
- WithSaturation
- WithValue
Frustum
- BottomPlane
- FarPlane
- LeftPlane
- NearPlane
- RightPlane
- TopPlane
- GetBBox
- GetCorner
- IsInside
Length
- Auto
- Contain
- Cover
- Fraction
- Parse
- Percent
- Pixels
- Unit
- Value
- GetPixels
Line
- a
- b
- Center
- Delta
- ClosestPoint
- Distance
- SqrDistance
- Trace
Margin
- bottom
- left
- right
- top
- EdgeSize
- height
- Position
- Size
- width
- WithoutPosition
- EdgeAdd
- EdgeSubtract
Matrix
Plane
- GetIntersection
- Distance
- Normal
- Origin
- GetDistance
- IsInFront
- SnapToPlane
- Trace
Ray
- Direction
- Origin
- Project
RealTimeSince
- Absolute
- Relative
RealTimeUntil
- Absolute
- Relative
Rect
- bottom
- left
- right
- top
- Center
- EdgeSize
- height
- Position
- Size
- width
- WithoutPosition
- Ceiling
- Contract
- Expand
- Floor
- Grow
- IsInside
- Round
- Shrink
- ToVector4
Rotation
- Identity
- Difference
- From
- FromAxis
- FromPitch
- FromRoll
- FromYaw
- Lerp
- LookAt
- Parse
- Slerp
- Backward
- Conjugate
- Down
- Forward
- Inverse
- Left
- Normal
- Right
- Up
- w
- x
- y
- z
- Angle
- Angles
- Clamp
- Distance
- Pitch
- Read
- Roll
- RotateAroundAxis
- Yaw
Sphere
- Center
- Radius
- Trace
TraceResult
- Bone
- EndPos
- Entity
- Hit
- Normal
- StartPos
Transform
- Zero
- Lerp
- Pos
- Position
- Rot
- Rotation
- Scale
- Add
- NormalToLocal
- NormalToWorld
- PointToLocal
- PointToWorld
- RotationToLocal
- RotationToWorld
- ToLocal
- ToWorld
- TransformVector
- WithPosition
- WithRotation
- WithScale
Vector2
- Down
- Left
- One
- Right
- Up
- Zero
- Random
- FromRadian
- GetDistance
- GetDot
- Parse
- IsNearZeroLength
- Length
- LengthSquared
- Normal
- x
- y
Vector3
- Backward
- Down
- Forward
- Left
- One
- OneX
- OneY
- OneZ
- Right
- Up
- Zero
- Random
- DistanceBetween
- GetAngle
- Lerp
- Max
- Min
- Parse
- Reflect
- Sort
- VectorAngle
- VectorPlaneProject
- EulerAngles
- IsNaN
- IsNearZeroLength
- Item
- Length
- LengthSquared
- Normal
- SafeToNormalize
- x
- y
- z
- Abs
- AddClamped
- Angle
- Approach
- ClampLength
- ComponentMax
- ComponentMin
- Cross
- Distance
- Dot
- IsNearlyEqual
- IsNearlyZero
- LerpTo
- ProjectOnNormal
- Read
- SnapToGrid
- SubtractDirection
- WithX
- WithY
- WithZ
- Write
Vector4
- Parse
- w
- x
- y
- z

Attributes 5

ClientDataAttribute
- Help
- Name
- Saved
- TypeId
ClientRpcAttribute
InputAttribute
- Help
- Name
- TypeId
- IsDefaultAttribute
- Match
LibraryAttribute
- Alias
- Description
- Editable
- FullName
- Group
- Icon
- Identifier
- Name
- Properties
- Spawnable
- Title
- TypeId
- Create
- IsDefaultAttribute
- IsNamed
- Match
ReplicatedAttribute
- Help
- Name
- Saved
- TypeId

Entity 8

UI 2

Label
- _text
- ScrollVelocity
- StyleSheet
- Task
- AcceptsFocus
- Add
- AllStyleSheets
- Ancestors
- AncestorsAndSelf
- Box
- ChildCount
- Children
- Class
- Classes
- ClassInfo
- ComputedStyle
- Descendants
- ElementName
- GlobalMatrix
- HasActive
- HasActiveTransitions
- HasChildren
- HasContent
- HasFocus
- HasHovered
- HasIntro
- HasMouseCapture
- HasOutro
- IsDeleting
- IsScrollAtBottom
- IsVisible
- IsVisibleSelf
- LocalMatrix
- MousePosition
- Now
- Parent
- PreferScrollToBottom
- PseudoClass
- ScaleFromScreen
- ScaleToScreen
- ScrollOffset
- ScrollSize
- SelectionEnd
- SelectionStart
- ShouldDrawSelection
- SiblingIndex
- StringValue
- Style
- Text
- Transitions
- UserData
- AddChild
- AddClass
- AddEventListener
- Bind
- Blur
- ChildrenOfType
- CreateEvent
- Delete
- DeleteChildren
- DrawBackground
- DrawContent
- FillPropertySheet
- FinalLayout
- FindRootPanel
- Focus
- GetCaretRect
- GetChild
- GetChildIndex
- GetClipboardValue
- GetLetterAt
- HasClass
- IsAncestor
- IsInside
- OnButtonEvent
- OnButtonTyped
- OnDeleted
- OnHotloaded
- OnKeyTyped
- OnLayout
- OnMouseWheel
- OnParentChanged
- OnPaste
- OnTemplateElement
- PlaySound
- PreLayout
- RemoveClass
- ScreenPositionToPanelDelta
- ScreenPositionToPanelPosition
- SetClass
- SetContent
- SetMouseCapture
- SetProperty
- SetTemplate
- SetText
- SkipTransitions
- SortChildren
- Switch
- Tick
- TryScroll
- UnScale
Panel
- ScrollVelocity
- StyleSheet
- Task
- AcceptsFocus
- Add
- AllStyleSheets
- Ancestors
- AncestorsAndSelf
- Box
- ChildCount
- Children
- Class
- Classes
- ClassInfo
- ComputedStyle
- Descendants
- ElementName
- GlobalMatrix
- HasActive
- HasActiveTransitions
- HasChildren
- HasContent
- HasFocus
- HasHovered
- HasIntro
- HasMouseCapture
- HasOutro
- IsDeleting
- IsScrollAtBottom
- IsVisible
- IsVisibleSelf
- LocalMatrix
- MousePosition
- Now
- Parent
- PreferScrollToBottom
- PseudoClass
- ScaleFromScreen
- ScaleToScreen
- ScrollOffset
- ScrollSize
- SiblingIndex
- StringValue
- Style
- Transitions
- UserData
- AddChild
- AddClass
- AddEventListener
- Bind
- Blur
- ChildrenOfType
- CreateEvent
- Delete
- DeleteChildren
- DrawBackground
- DrawContent
- FillPropertySheet
- FinalLayout
- FindRootPanel
- Focus
- GetChild
- GetChildIndex
- GetClipboardValue
- HasClass
- IsAncestor
- IsInside
- OnButtonEvent
- OnButtonTyped
- OnDeleted
- OnHotloaded
- OnKeyTyped
- OnLayout
- OnMouseWheel
- OnParentChanged
- OnPaste
- OnTemplateElement
- PlaySound
- PreLayout
- RemoveClass
- ScreenPositionToPanelDelta
- ScreenPositionToPanelPosition
- SetClass
- SetContent
- SetMouseCapture
- SetProperty
- SetTemplate
- SkipTransitions
- SortChildren
- Switch
- Tick
- TryScroll
- UnScale

Hammer Markup 14

AutoApplyMaterialAttribute
- TypeId
- AddBody
- AddHeader
- AddMetaData
- AddTags
- IsDefaultAttribute
- Match
DoorHelperAttribute
- TypeId
- AddBody
- AddHeader
- AddMetaData
- AddTags
- IsDefaultAttribute
- Match
DrawAnglesAttribute
- TypeId
- AddBody
- AddHeader
- AddMetaData
- AddTags
- IsDefaultAttribute
- Match
EditorModelAttribute
- TypeId
- AddBody
- AddHeader
- AddMetaData
- AddTags
- IsDefaultAttribute
- Match
EditorSpriteAttribute
- TypeId
- AddBody
- AddHeader
- AddMetaData
- AddTags
- IsDefaultAttribute
- Match
EntityToolAttribute
- TypeId
- AddBody
- AddHeader
- AddMetaData
- AddTags
- IsDefaultAttribute
- Match
MinMaxAttribute
ModelAttribute
- BodyGroup
- MaterialGroup
- Model
- TypeId
- AddBody
- AddHeader
- AddMetaData
- AddTags
- IsDefaultAttribute
- Match
ParticleAttribute
- TypeId
- AddBody
- AddHeader
- AddMetaData
- AddTags
- IsDefaultAttribute
- Match
PathAttribute
RenderFieldsAttribute
- TypeId
- AddBody
- AddHeader
- AddMetaData
- AddTags
- IsDefaultAttribute
- Match
SkipAttribute
SolidAttribute
SupportsSolidAttribute
- TypeId
- AddBody
- AddHeader
- AddMetaData
- AddTags
- IsDefaultAttribute
- Match