API Reference

Globals

118 types

Type Name Description
class <M>$52C342ECC3A503D4879A4C578EED277E
class Account
class Achievements Sandbox.Services Allows access to stats for the current game. Stats are defined by the game's author and can be used to track anything fr
class ActionGraphEditorExtensions Sandbox.ActionGraphs Helper methods for action graph editor tools. Mostly workaround for GameObjectReference and ComponentReference being int
class ActionGraphExtensions Sandbox.ActionGraphs
class ActionGraphExtensions Facepunch.ActionGraphs Extension methods for action graphs.
class Allocations Sandbox.Diagnostics Tools for diagnosing heap allocations
class Application Sandbox
class AssemblyMetadata
class Assert Sandbox.Diagnostics
class Auth Sandbox.Services
class BindingReference Sandbox.MovieMaker.Properties Helper methods for working with BindingReference`1.
class Clipboard Sandbox.UI
class Clipboard
class ClipExtensions Sandbox.MovieMaker Helper methods for working with IMovieClip and ITrack.
class Cloud Sandbox For accessing assets from the cloud - from code
class Colors Using pure primary colors is horrible. Lets make it easier to avoid.
class CompiledClipExtensions Sandbox.MovieMaker.Compiled Helper methods for working with MovieClip, ICompiledTrack, or ICompiledBlock.
class CompilerExtensions Sandbox
class ConsoleSystem Sandbox A library to interact with the Console System.
class ControlFlow Facepunch.ActionGraphs.Nodes Nodes providing basic control flow structures like branches and loops.
class Crc32 Sandbox.Utility Generates 32-bit Cyclic Redundancy Check (CRC32) checksums. Used for data integrity verification and fast hashing.
class Crc64 Sandbox.Utility Generate 64-bit Cyclic Redundancy Check (CRC64) checksums.
class DelegateExtensions Facepunch.ActionGraphs
class Directory Sandbox.Mounting
class Easing Sandbox.Utility Easing functions used for transitions. See https://easings.net/ for examples.
class EditorTools Sandbox.Utility Functions to interact with the tools system. Does nothing if tools aren't enabled.
class Either Facepunch.ActionGraphs
class Emoji Sandbox.UI Helper class for working with Unicode emoji.
class FileSystem Sandbox A filesystem that can be accessed by the game.
class Game Sandbox Provides global access to core game state, utilities, and operations for S&amp;box. The Game class exposes static prope
class GameTask Sandbox A generic TaskSource.
class Gizmo Sandbox
class Global Sandbox Utility info for tools usage.
class GlobalGameNamespace Sandbox.Internal
class GlobalSystemNamespace Sandbox.Internal
class GlobalToolsNamespace Sandbox.Internal
class GpuProfilerStats Sandbox.Diagnostics GPU profiler stats collected from the scene system timestamp manager
class Graphics Sandbox Used to render to the screen using your Graphics Card, or whatever you kids are using in your crazy future computers. Wh
class Http Sandbox Lets your game make async HTTP requests.
class IconPanelConstructor Sandbox.UI.Construct
class ImageConstructor Sandbox.UI.Construct
class Input Sandbox Allows querying of player button presses and other inputs.
class Interpolator Sandbox.MovieMaker Helper for accessing IInterpolator`1 implementations, for interpolating between two values of the same type
class Inventory Sandbox.Services Allows access to the Steam Inventory system
class Json Sandbox A convenience JSON helper that handles Resource types for you.
class JsonExtensions Facepunch.ActionGraphs Extension methods for Json types.
class Keyboard Keyboard related glyph methods.
class LabelConstructor Sandbox.UI.Construct
class Language Sandbox Allows access to translated phrases, allowing the translation of gamemodes etc
class Languages Sandbox.Localization A list of supported languages and metadata surrounding them
class LaunchArguments Sandbox These are arguments that were set when launching the current game. This is used to pre-configure the game from the menu
class Leaderboards Sandbox.Services
class LengthUnitExtension Sandbox.UI
class LoadingScreen Sandbox Holds metadata and raw data relating to a Saved Game.
class LZ4 Sandbox.Compression Encode and decode LZ4 compressed data.
class MainThread Sandbox Utility functions that revolve around the main thread
class Map Stats for the current map
class Map Stats for the current map
class MapEditor Events that happen within the map editor.
class Math Facepunch.ActionGraphs.Nodes Nodes relating to numbers and geometry.
class MathX Sandbox A class to add functionality to the math library that System.Math and System.MathF don't provide. A lot of these methods
class Messaging Sandbox.Services
class Mounting
class MountUtility Sandbox.Mounting
class Mouse Sandbox Gives access to mouse position etc
class NavigationExtensions Sandbox.UI.Navigation
class Network
class Networking Sandbox Global manager to hold and tick the singleton instance of NetworkSystem.
class Networking Sandbox.Debug
class NodeExpressionBuilderExtensions Facepunch.ActionGraphs.Compilation
class Noise Sandbox.Utility Provides access to coherent noise utilities. All of these functions should return between 0 and 1.
class Parallel Sandbox.Utility Wrappers of the parallel class.
class ParameterDefinitionExtensions Facepunch.ActionGraphs
class ParameterNames Facepunch.ActionGraphs Special names for parameters of built-in node types.
class Performance Sandbox.Diagnostics
class PerformanceStats Sandbox.Diagnostics
class PhysicsJointBuilderExtensions Sandbox
class Prefabs
class Preferences Sandbox Holds information about the current user's preferences.
class Pressed Access to the currently pressed path information
class Projects
class Protocol Sandbox.Engine A centralized place to access the protocols
class RazorExtensions Microsoft.AspNetCore.Components
class RealTime Sandbox Access to time.
class Recognition Sandbox.Speech
class ReflectionExtensions Facepunch.ActionGraphs
class ResourceLibrary Sandbox Keeps a library of all available Resource.
class Rpc Sandbox
class SandboxBaseExtensions Sandbox Extensions for Surfaces
class SandboxGameExtensions Sandbox
class SandboxSystemExtensions
class SandboxSystemExtensions Sandbox
class SandboxSystemExtensions
class SandboxToolExtensions Sandbox
class SceneConstructor Sandbox.UI.Construct
class SceneExtensions Sandbox
class SceneUtility Sandbox
class Screen Sandbox Access screen dimension etc.
class Screenshots Sandbox.Services Implements Steamscreenshots
class ShaderCompile Sandbox.Engine.Shaders
class Signal Facepunch.ActionGraphs Node inputs and outputs of this type will transmit signals rather than values.
class Sound Sandbox Single source for creating sounds
class Standalone Sandbox
class Stats Sandbox.Services Allows access to stats for the current game. Stats are defined by the game's author and can be used to track anything fr
class Steam Sandbox.Utility
class Storage Sandbox
class Streamer Sandbox
class SystemInfo Sandbox.Engine
class TextRendering Sandbox
class TextureLoader Sandbox.Mounting
class TextureStreaming Sandbox.Rendering Gives global access to the texture streaming system.
class ThreadSafe Sandbox Provides utilities for working with threads, particularly for identifying and asserting code is running on the main thre
class TrackProperty Sandbox.MovieMaker.Properties
class UI Static materials for UI rendering purposes.
class ValidationExtensions Facepunch.ActionGraphs Extension methods related to validation and validation messages.
class VertexLayout Sandbox Allows for the definition of custom vertex layouts
class VoiceRecording