s&
API Reference

Structs

287 types

Type Name Description
struct AddedObject Represents an object that needs to be added during patching.
struct AlphaFrame Keyframes times and values should range between 0 and 1
struct AnalogInput Sandbox.VR Represents a VR analog input action (e.g. trigger)
struct AnalogInput2D Sandbox.VR Represents a two-dimensional VR analog input action (e.g. joysticks)
struct Angles Euler angles. Unlike a Rotation, Euler angles can represent multiple revolutions (rotations) around an axis, but suffer
struct AnimParam<T> Sandbox Anim param values contain any value for a limited set of types
struct AnimTagEvent
struct AnyOfType<T> Sandbox A wrapper that holds an instance of any concrete type assignable to . Use this as a property type when you want the insp
struct AsAccessor
struct AssetPickerParameters Passed parameters for the AssetPicker going from engine to addon code
struct AssetTags Represents a collection of tags for an asset. This is only necessary so we can save tags as soon as they are added.
struct Attribute
struct AudioChannel Sandbox.Audio Represents an audio channel, between 0 and 7. This is used to index into buffers. This is used rather than an int to avo
struct AutocompleteEntry
struct AutoCompleteResult
struct BBox An Axis Aligned Bounding Box.
struct BindEntry
struct BindingReference<T> Sandbox.MovieMaker.Properties Used by movie property tracks with GameObject or Component value types to reference other tracks. This value will be res
struct BlitMode
struct Block
struct Body Represents a Rigidbody attached to a specific bone with a local transform.
struct Bone A bone definition for use with ModelBuilder.
struct BoneVelocity
struct Builder Sandbox.Bind A helper to create binds between two properties (or whatever you want) Example usage: set "BoolValue" from value of "St
struct ByteParseOptions
struct ByteStream Sandbox Write and read bytes to a stream. This aims to be as allocation free as possible while also being as fast as possible.
struct CalculatePathRequest Sandbox.Navigation Defines the input for a pathfinding request on the navmesh.
struct Capsule A capsule object, defined by 2 points and a radius. A capsule is a cylinder with round ends (inset half spheres on each
struct CharacterControllerHelper Sandbox
struct Choice
struct CloneConfig Sandbox The low level input of a GameObject.Clone
struct ClutterInstance Sandbox.Clutter Represents a single clutter instance to be spawned.
struct Collision Sandbox
struct CollisionSource Sandbox
struct CollisionStop Sandbox
struct Color Represents a color using 4 floats (rgba), with 0-1 range.
struct Color32 A 32bit color, commonly used by things like vertex buffers. The functionality on this is purposely left min
struct ColorFrame Keyframes times and values should range between 0 and 1
struct ColorHsv A color in Hue-Saturation-Value/Brightness format.
struct ColorIndexRef
struct ColorTextureRef
struct ComboDescription
struct CompactTerrainMaterial Sandbox Compact terrain material encoding with base/overlay texture blending. Packed format (32-bit uint)
struct Cone A tapered shape between two points with a radius at each end. Supports cones and cylinders, with flat ends.
struct Config
struct Configuration
struct ConnectionStats Sandbox.Network
struct Constant Facepunch.ActionGraphs
struct ContextMenuEvent Editor Information about a Widgets context menu event.
struct CreateGameOptions Sandbox.Modals Passed to IModalSystem.CreateGame
struct CreateGameResults Sandbox.Modals
struct CreateSubGraphResult Facepunch.ActionGraphs
struct CurrencyValue Sandbox Describes money, in a certain currency
struct Cursor
struct Curve Sandbox Describes a curve, which can have multiple key frames.
struct CurveRange Sandbox Two curves
struct DataProgress Sandbox.Utility Provides progress information for operations that process blocks of data, such as file uploads, downloads, or large data
struct DepthTextureRef
struct Desc
struct DeserializeOptions
struct DigitalInput Sandbox.VR Represents a VR digital input action (e.g. X button)
struct DisplayInfo Sandbox Collects all the relevant info (such as description, name, icon, etc) from attributes and other sources about a type or
struct DisposeAction Sandbox.Utility A simple IDisposable that invokes an action when disposed. Useful for creating using-blocks with cleanup logic.
struct DspPresetHandle Sandbox.Audio A handle to a DspPreset
struct EmbeddedResource Sandbox.Resources A JSON definition of an embedded resource. This is a resource that can be either standalone (in a .vtex file) or embedd
struct Entry
struct Entry
struct Entry
struct Entry
struct Entry
struct Entry This is a cleaned up version of gameserveritem_t.
struct Entry
struct Entry
struct Enumerator Zero-allocation enumerator for CircularBuffer`1. Returned as a value type so never allocates.
struct Event Describes who pressed it.
struct ExportProgress
struct ExpressionBuilderOptions Facepunch.ActionGraphs.Compilation
struct FastTimer Sandbox.Diagnostics A lightweight, high-resolution timer for performance measurement. More efficient than Stopwatch with a simpler API.
struct File
struct Filter
struct FlagsAccessor
struct FloatSpan Sandbox Provides vectorized operations over a span of floats.
struct FogParamInfo
struct FootstepEvent
struct Frame Keyframes times and values should range between 0 and 1
struct Frame
struct Frame
struct FrameStats Sandbox.Diagnostics Stats returned from the engine each frame describing what was rendered, and how much of it.
struct Friend Sandbox
struct FriendsListModalOptions Sandbox.Modals
struct Frustum Sandbox Represents a frustum.
struct GameObjectSystemData
struct GameSetting Sandbox.DataModel A ConVarAttribute that has been marked with GameSetting This is stored as project metadata so we can set up a game witho
struct GenericEvent
struct GlobalStat
struct GlyphStyle Sandbox
struct GpuTimingEntry Sandbox.Diagnostics GPU timing data for a single render pass/group
struct Gradient Sandbox Describes a gradient between multiple colors
struct GradientColorOffset
struct GradientFogSetup Sandbox.Rendering Setup for defining gradient fog in a view
struct GradientGenerator
struct GraphicsHoverEvent Editor Information about a GraphicsItems mouse hover event.
struct GraphicsMouseEvent Editor Information about a GraphicsItems mouse click event.
struct Group
struct HostStats Sandbox.Network
struct HudPainter Sandbox.Rendering 2D Drawing functions for a CommandList. HudPainter provides a set of methods for drawing shapes, textures, and text onto
struct HullSimplify Settings for simplifying a hull shape.
struct IconSetup
struct ImpactEffectData
struct IndirectDispatchArguments
struct IndirectDrawArguments
struct IndirectDrawIndexedArguments
struct InitialSnapshotResponse Sandbox.Network
struct InputMotionData Sandbox Represents the current state of a device's motion sensor(s).
struct Inputs The input state, allows interaction with Gizmos
struct InsertResult Facepunch.ActionGraphs Elements added by a call to DeserializeInsert.
struct InstalledVoice
struct Instance
struct ItemDragEvent
struct Joint Represents a Joint between two bodies with local frames for each.
struct KeyEvent Editor Information about a Widgets keyboard event.
struct LayoutCascade Sandbox.UI
struct Length Sandbox.UI A variable unit based length. ie, could be a percentage or a pixel length. This is commonly used to express the size of
struct Line Represents a line in 3D space.
struct LinkTraversalData Holds information about the current link the agent is traversing.
struct LoadingProgress Sandbox.Menu
struct LoadingScreenSetup
struct LobbyConfig Sandbox.Network
struct LobbyInformation Sandbox.Network
struct LogEvent Sandbox
struct Margin Sandbox.UI Represents a Rect where each side is the thickness of an edge/padding/margin/border, rather than positions.
struct Matrix Represents a 4x4 matrix.
struct MeshTraceRequest Sandbox.Engine.Utility.RayTrace
struct MixerHandle Sandbox.Audio A handle to a Mixer
struct MixinParameter Sandbox.UI A single parameter in a mixin definition.
struct ModelBreakPiece Sandbox.ModelEditor.Nodes Defines a single breakable prop gib.
struct MountedVPKsResponse Sandbox.Network
struct MountInfo Sandbox.Mounting Information about a single mount
struct MouseEvent Editor Information about a Widgets mouse event.
struct MovedObject Represents an object that should be moved to a new location during patching.
struct MovieTime Sandbox.MovieMaker Represents a duration of time in a movie. Uses fixed point so precision is consistent at any absolute time. Defaults to
struct MovieTimeRange Sandbox.MovieMaker Represents a segment of time, given by Start and End times.
struct NavMeshPath Sandbox.Navigation Contains the result of a pathfinding operation.
struct NavMeshPathPoint Sandbox.Navigation Represents a point in a navmesh path, including its position in 3D space. May be extended in the future to hold more inf
struct NetDictionaryChangeEvent<TKey,TValue> Sandbox Describes a change to a NetDictionary`2 which is passed to OnChanged whenever its contents change.
struct NetListChangeEvent<T> Sandbox Describes a change to a NetListChangeEvent`1 which is passed to OnChanged whenever its contents change.
struct NetworkFile Sandbox.Network
struct NetworkSpawnOptions Sandbox Configurable options when spawning a networked object.
struct Null Facepunch.ActionGraphs Represents a null reference.
struct ObjectEntry Holds key values for the map object
struct ObjectIdentifier Uniquely identifies a tracked object by its type and identifier value.
struct OldSoundData
struct Option
struct Options
struct Outcome
struct Outline
struct PackageInteraction
struct PackageProperty A binary category used to divide into two categories. For example, Work In Progress.
struct PackageUsageStats Statistics for user interactions with this package
struct Pair A pair of case- and order-insensitive tags, used as a key to look up a Result.
struct PanelCreator Sandbox.UI.Construct Used for Add for quick panel creation with certain settings. Other panels types are added via extension methods.
struct PanelTransform Sandbox.UI
struct ParticleControlPoint Sandbox
struct ParticleFloat Sandbox Represents a floating-point value that can change over time with support for various evaluation modes.
struct ParticleGradient Sandbox
struct ParticleVector3 Sandbox
struct PathElement
struct PerChannel<T> Sandbox.Audio Stores a variable per channel
struct PeriodMetric
struct PhysicsContact Sandbox
struct PhysicsIntersection Sandbox
struct PhysicsIntersectionEnd Sandbox
struct PhysicsLock Sandbox
struct PhysicsPoint Sandbox.Physics Used to describe a point on a physics body. This is used for things like joints where you want to pass in just a body, o
struct PhysicsSpring Sandbox.Physics Spring related settings for joints such as FixedJoint.
struct PhysicsTraceBuilder Sandbox
struct PhysicsTraceResult Sandbox
struct Plane Sandbox Represents a plane.
struct PlayerStat
struct Point Point that defines part of the spline. Two consecutive points define a segment of the spline. The Position, In/Out Hand
struct PrefabBuildScope Sandbox.Mounting Disposable scope that manages a temporary scene for PrefabBuilder.
struct PrefabVariableTarget Targets a property in a component or gameobject.
struct PropertyOverride Represents a property change to apply during patching.
struct RangedFloat A float between two values, which can be randomized or fixed.
struct Ray A struct describing an origin and direction
struct Reader Context for reading binary blob data. Wraps ByteStream for allocation-free deserialization.
struct RealTimeSince Sandbox A convenience struct to easily measure time since an event last happened, based on GlobalNow. Typical usage would see yo
struct RealTimeUntil Sandbox A convenience struct to easily manage a time countdown, based on GlobalNow. Typical usage would see you assigning to a v
struct ReconnectMsg Sandbox.Network Sent to the server to tell clients to reconnect. This is sent when the server is changing games, or maps, and wants the
struct Rect Sandbox Represents a rectangle.
struct RectInt Sandbox Represents a rectangle but with whole numbers
struct ReflectionSetup Sandbox.Rendering Allows special setup for reflections, such as offsetting the reflection plane
struct RefractionSetup Sandbox.Rendering Allows special setup for refraction, such as offsetting the clip plane
struct RemovedObject Represents an object that should be removed during patching.
struct RendererSetup Sandbox.Rendering When manually rendering a Renderer this will let you override specific elements of that render. This means you can use m
struct RenderState Sandbox.UI Describes panel's position and size for rendering operations.
struct RenderTargetHandle Sandbox.Rendering A render target handle used with CommandLists
struct Result
struct Result
struct Results
struct ReviewStats
struct Rgba16
struct Rotation Represents a Quaternion rotation. Can be interpreted as a direction unit vector (x,y,z) + rotation around the direction
struct Sample Information about the spline at a specific distance.
struct SamplerState Sandbox.Rendering Represents a sampler state used to control how textures are sampled in shaders. Example usage: SamplerState mySampler
struct SceneReferenceNode Sandbox.ActionGraphs An Node from an ActionGraph that references a GameObject or Component.
struct SceneReferenceTriggeredEvent Sandbox.ActionGraphs
struct SceneTrace Sandbox
struct SceneTraceResult Sandbox
struct SceneVolume Sandbox.Volumes A generic way to represent volumes in a scene. If we all end up using this instead of defining our own version in everyt
struct Scope Defines a scope of text, all using the same style.
struct ScopeSection This exists to allow the creation of performance scopes without
struct ScrapeEffectData
struct SerializationOptionsScope
struct ServerListConfig Sandbox.Modals
struct ShaderCompileOptions Sandbox.Engine.Shaders Options used when compiling a shader
struct Shadow Sandbox.UI Shadow style settings
struct Shadow
struct SimpleVertex Sandbox
struct SizeHandle
struct SkyLightInfo
struct SmoothDamped Everything you need to smooth damp a Vector3. Just call Update every frame.
struct SnapshotMsg Sandbox.Network
struct SortOrder Describes a sort order which can be used with the package/find api
struct SoundEvent
struct SpeechRecognitionResult Sandbox.Speech A result from speech recognition.
struct Sphere Sandbox Represents a sphere.
struct SpringDamped Everything you need to create a springy Vector3
struct SteamId Sandbox Represents a Steam ID (64-bit unique identifier for Steam accounts). Provides type-safe storage and conversion between l
struct StreamChannel Sandbox
struct StreamChatMessage Sandbox
struct StreamClip Sandbox
struct StreamPoll Sandbox
struct StreamPrediction Sandbox
struct StreamUser Sandbox
struct StreamUserFollow Sandbox
struct StringToken Sandbox Strings are commonly converted to tokens in engine, to save space and speed up things like comparisons. We wrap this fun
struct StyleProperty
struct StyleSheetCollection Sandbox.UI A collection of StyleSheet objects applied directly to a panel. See StyleSheet.
struct SurfacePrefabCollection Holds a dictionary of common prefabs associated with a surface
struct SurfaceSoundCollection Holds a dictionary of common sounds associated with a surface. This allows you to pick and choose an appropriate sound.
struct SyncTask Sandbox.Tasks
struct TagDefinition
struct TagEntry Represents a tag along with the count of items it contains
struct Target
struct TaskSource Sandbox Provides a way for us to cancel tasks after common async shit is executed.
struct TerrainMaterialInfo Information about terrain materials at a specific position
struct Texture2DBuilder Sandbox
struct Texture3DBuilder Sandbox
struct TextureArrayBuilder Sandbox
struct TextureBuilder Sandbox
struct TextureCubeBuilder Sandbox
struct TextureResidencyInfo Editor Provides information about currently resident textures on the GPU
struct ThumbnailOptions
struct TimeSince Sandbox A convenience struct to easily measure time since an event last happened, based on Now. Typical usage would see you assi
struct TimeUntil Sandbox A convenience struct to easily manage a time countdown, based on Now. Typical usage would see you assigning to a variabl
struct Tooltip A tooltip to show when looking at this pressable
struct Trace Editor Trace for tools, not to be confused with SceneTrace
struct TraceResult Editor
struct TrailTextureConfig Sandbox Defines how a trail is going to be textured. Used by TrailRenderer.
struct Transform A struct containing a position, rotation and scale. This is commonly used in engine to describe entity position, bone po
struct TransitionDesc Sandbox.UI Describes transition of a single CSS property, a.k.a. the values of a transition CSS property. Utility to create a trans
struct Triangle Sandbox
struct ValidationMessage Facepunch.ActionGraphs A message generated during validation with a context, level, and value.
struct ValidationMessage A message generated when attempting to bind a set of named property values and input types. Becomes a ValidationMessage
struct VariableDescription
struct Variant Sandbox A Variant is a type that can hold any value, and also keeps track of the type of the value it holds. It's useful for cas
struct Vector2 A 2-dimensional vector. Typically represents a position, size, or direction in 2D space.
struct Vector2Int
struct Vector3 A 3-dimentional vector. Typically represents a position, size, or direction in 3D space.
struct Vector3Int
struct Vector4 A 4-dimensional vector/point.
struct Vertex A vertex to update a particle snapshot with.
struct Vertex Sandbox
struct VertexAttribute Sandbox
struct VertexDetail
struct VideoDisplayMode
struct ViewSetup Sandbox.Rendering When manually rendering a camera this will let you override specific elements of that render. This means you can use mos
struct VRHandJointData Sandbox.VR
struct WheelEvent Editor Information about a mouse wheel scroll event of a Widget.
struct WorkshopItemMetaData Sandbox Some metadata we'll pack into a workshop submission when publishing.
struct WorkshopPublishOptions Sandbox.Modals Passed to IModalSystem.WorkshopPublish
struct WrappedMethod Sandbox Provides data about a wrapped method in a CodeGeneratorAttribute callback.
struct WrappedMethod<T> Sandbox Provides data about a wrapped method in a CodeGeneratorAttribute callback.
struct WrappedPropertyGet<T> Sandbox Provides data about a wrapped property getter in a CodeGeneratorAttribute callback.
struct WrappedPropertySet<T> Sandbox Provides data about a wrapped property setter in a CodeGeneratorAttribute callback.
struct Writer Context for writing binary blob data. Wraps ByteStream for allocation-free serialization.