infoAbout
infoAbout s&box newspaperLatest News published_with_changesChanges mapRoadmap monitoringMetrics
gamesGames
sports_esportsBrowse Games exploreDiscover Games
categoryWorkshop
sports_esportsGames landscapeMaps view_in_arModels textureMaterials apparelClothing constructionMore..
forumForum menu_bookLearn
docsDocumentation apiApi Reference schoolTutorials manage_searchCode Search
Docs
🪑 Scene
🧩 Components
extension Reference
🚀Getting Started
📥Download & Install
💻System Requirements
🚀Your First Project
🔍Explore the Engine
📂Project Types
🧩Addon Project
🕹️Game Project
💸Monetization
🚨Reporting Errors
ℹ️FAQ
🧪Staging Branch
🟠Status
🪑Scene
🧩Components
📄Advanced Topics
🔢Component Versioning
🧵Async
🧸Component Interfaces
auto_awesomeITemporaryEffect
👷Component Methods
🛜Events
🚪IGameObjectNetworkEvents
🚪ISceneStartup
🔃Execution Order
extensionReference
buildHammer Mesh
🏃‍♀️Player Controller
💨TemporaryEffect
📦GameObject
⚙️GameObjectSystem
🗺️Maps
📂Loading Maps
🏗️Map Entities
🌐Networking
📦Prefabs
💱Instance Overrides
📝Prefab Templates
🌍Scenes
📋Scene Metadata
💼Code
🎓Advanced Topics
🧞Code Generation
🥵Hotloading
🧪Unit Tests
👶Code Basics
🛡️Api Whitelist
🐏Cheat Sheet
🔣Console Variables
✅IsValid
📐Math Types
⏱️Time
📗Libraries
🔩Editor
🧊Asset Previews
🔧Custom Editors
📱Editor Apps
📅Editor Events
📂Editor Project
⌨️Editor Shortcuts
🪛Editor Tools
📚Component Editor Tools
⚙️Editor Widgets
🔨Mapping
🩳Shortcuts
📦Model Editor
design_servicesProperty Attributes
🖍️Texture Generators
↩️Undo System
🧍Exporting Standalone
🔓Standalone Code
🎎Assets
🩲Clothing
🔧First Time Setup
📖Guidelines & Quality Bar
🧅Layering Clothing
🎩Making a Hat
🌭Morphing to Humans
📩Publishing Clothing
storageFile System
✨Ready-to-use Assets
🌭Citizen Characters
🔫First-Person Weapons
📦Resources
🔟Binary Serialization
☁️Cloud Assets
🧊Custom Assets
🔧GameResource Extensions
📂Storage (UGC)
📝Naming Conventions
🎨Rendering
✨Effects
⚡Beams
〰️BeamEffect
🔫Tracers
🔣Decals
🏃‍♂️Animated Effects
✴️Decal Component
📄DecalDefinition
👶Lifetime
sunIndirect Light Volumes
🎆Particle Effect
🎮Custom Particle Controller
🖼️Post Processing
🔧Creating PostProcesses
📁Effects
📽️FilmGrain
☀️Tonemapping
📦PostProcessVolume
📈Shader Graph
🆕Custom Nodes
⌨️C# Shader Nodes
📦Creating a Subgraph
🌱Getting Started
🔧Properties
💾Variables
🎨Shaders
📥Attributes and Variables
🍎Classes
🌥️AmbientLight
🔗Bindless API
👀Depth
🪩Dynamic Reflections
🌁Fog
notepadG-Buffer
💡Light
🚝Motion
🥢Screen Space Tracing
🕳️SSAO
✂️Texture Sheets
📋Command Lists
🆕Getting Started
⚡GPU Instancing
💎Material
📋Modes
📚Reference
🔏Default Vertex and Pixel Shader Inputs
🔢Global Variables
🪞Screen-Space Reflections
🕸️Vertex Helpers
⚙️Render States
🎨Sampler States
🔦Shading Model
🧑‍🤝‍🧑Networking & Multiplayer
🔑Connection Permissions
albumCustom Snapshot Data
📦Dedicated Servers
📂Running Local Projects
👾Serverside Code
🔒User Permissions
lanHttp Requests
📆Network Events
🔌Network Helper
👁️Network Visibility
👾Networked Objects
🛍️Ownership
📩RPC Messages
🔄Sync Properties
🧪Testing Multiplayer
🌐WebSockets
💬Platform Chat
⚡Physics
🎯Tracing
🚪Triggers
🚪IScenePhysicsEvents
🖥️UI
🎨HudPainter
🖱️UI Interactions
💬Localization
⬜Razor Panels
📝Razor Components
🖌️Styling Panels
🎨Style Properties
👨‍👩‍👧‍👦VirtualGrid
🎮Game Mounts
🛠️Creating Mounts
🍝ActionGraph
🌱Getting Started
🧩Component Actions
💾Variables
🛠️Using With C#
📖Examples
🆕Custom Nodes
📦Action Resources
⌨️C# Method Nodes
🎬Movie Maker
🌱Getting Started
🗺️Editor Map
🔑Keyframe Editing
🖌️Motion Editing
🦴Skeletal Animation
🎥Recording
🎞️Sequences
📼Exporting Video
codePlayback API
codeRecording API
💿Media
🎥Video
🔊Audio
🔊Sound
🔊Playing Sounds
🎮Gameplay
🍃Clutter
🕹️Input
🎮Controller Input
🎨Glyphs
⌨️Raw Input
🤖Navigation
🛞NavMesh Agent
⏹️NavMesh Areas
🚦Costs & Filters
🚫Obstacles
🔗NavMesh Links
⛰️Terrain
📄Creating Terrain
📄Terrain Materials
🥽VR
💽Services
🏅Achievements
🔑Auth Tokens
🏆Leaderboards
📄Web Api
📉Stats
🕺Animation

Reference

Reference documentation for some of the built-in components.






Created 30 Oct 2024
Updated 15 Jun 2025