s&box API Reference

https://sbox.game/api
Admin
s&box is a game development platform, and this documentation provides the API reference for its...
Tokens:1,403,431
Snippets:25,199
Trust Score:8.3
Update:1 month ago
Show doc for...
Tokens:
Raw
### void Start ()

Source: https://sbox.game/api/Sandbox.Diagnostics.FastTimer/Start

Starts or restarts the timer instance.

```APIDOC
## void Start ()

### Description
Starts or restarts the timer. This method is part of the Sandbox.Diagnostics.FastTimer class.

### Signature
`void Start ()`
```

--------------------------------

### Implement a global PerformanceLogger with GameTask

Source: https://sbox.game/api/Sandbox.GameTask

This example demonstrates a global logger that starts when the game begins and runs for the duration of the session, independent of any specific entity.

```csharp
public static class PerformanceLogger
{
    public static void Start()
    {
        _ = Run();
    }

    static async Task Run()
    {
        while ( true )
        {
            await GameTask.DelaySeconds(1);
            Log.Info($"FPS: {HostStats.Fps}");
        }
    }
}
```

--------------------------------

### static Task<bool> Install (string windowTitle, IEnumerable<string> packages)

Source: https://sbox.game/api/Editor.CloudAsset/Install

Installs a list of packages into the editor, identified by the specified window title.

```APIDOC
## static Task<bool> Install (string windowTitle, IEnumerable<string> packages)

### Description
Installs a specified list of packages into the editor environment. This operation is asynchronous and returns a boolean indicating success.

### Parameters
- **windowTitle** (string) - The title of the window associated with the installation process.
- **packages** (IEnumerable<string>) - A collection of package identifiers to be installed.

### Returns
- **Task<bool>** - A task that completes with true if the installation was successful, or false otherwise.
```

--------------------------------

### Install(token)

Source: https://sbox.game/api/Sandbox.Storage.QueryItem

Installs the UGC item. Returns a Task containing the result, or null if the item format is invalid.

```APIDOC
## Install(token)

### Description
Installs the UGC item. This method can return null if the item is not of the right format.

### Method
Method

### Parameters
- **token** (object) - Required - The authentication or installation token required for the operation.

### Returns
- **Task<T>** - A task representing the asynchronous installation process.
```

--------------------------------

### LoopStart Property

Source: https://sbox.game/api/Sandbox.SoundFile.LoadOptions/LoopStart

Gets or sets the start sample of the loop region. Use -1 to default to the file's internal declaration.

```APIDOC
## Property: LoopStart

### Description
Gets or sets the start sample of the loop region for a sound file. A value of -1 indicates that the system should use the value declared within the file.

### Signature
`int LoopStart { get; set; }`

### Namespace
`Sandbox.SoundFile.LoadOptions`
```

--------------------------------

### void SetStartPoint (SceneAnchor start)

Source: https://sbox.game/api/Sandbox.TracerEffect/SetStartPoint

Sets the starting point for the tracer effect.

```APIDOC
## void SetStartPoint (SceneAnchor start)

### Description
Sets the starting point for the tracer effect, defining where the line originates.

### Parameters
- **start** (SceneAnchor) - Required - The anchor point from which the tracer effect starts.
```

--------------------------------

### long StartTick

Source: https://sbox.game/api/Sandbox.Diagnostics.FastTimer/StartTick

Gets or sets the timestamp when the timer was started.

```APIDOC
## Property: StartTick

### Description
Gets or sets the timestamp representing the moment the timer was started.

### Signature
`long StartTick { get; set; }`

### Namespace
`Sandbox.Diagnostics.FastTimer`

### Assembly
`Sandbox.System`
```

--------------------------------

### static void StartHosting ()

Source: https://sbox.game/api/Editor.EditorUtility.Network/StartHosting

Starts hosting a lobby. If the editor is not currently in play mode, it will automatically enter play mode before hosting.

```APIDOC
## static void StartHosting ()

### Description
Starts hosting a lobby. If the editor is not currently in play mode, it will automatically enter play mode before hosting.

### Signature
`static void StartHosting ()`

### Namespace
Editor.EditorUtility.Network

### Assembly
Sandbox.Tools
```

--------------------------------

### Start()

Source: https://sbox.game/api/Sandbox.Services.BenchmarkSystem

Initializes a new benchmark session.

```APIDOC
## Start()

### Description
Called to start a benchmark.
```

--------------------------------

### SelectionStart

Source: https://sbox.game/api/Editor.TextCursor/SelectionStart

Gets or sets the starting index of the text selection.

```APIDOC
## Property: SelectionStart

### Description
Gets or sets the starting position of the text selection in the editor.

### Signature
`int SelectionStart { get; set; }`

### Namespace
`Editor.TextCursor`

### Assembly
`Sandbox.Tools`
```

--------------------------------

### void Start(string name)

Source: https://sbox.game/api/Sandbox.Services.BenchmarkSystem/Start

Initiates a benchmark session identified by the provided name.

```APIDOC
## void Start(string name)

### Description
Starts a benchmark process with the specified name.

### Parameters
- **name** (string) - Required - The identifier for the benchmark session.
```

--------------------------------

### StartDistance Property

Source: https://sbox.game/api/Sandbox.Rendering.GradientFogSetup/StartDistance

Allows getting and setting the start distance of the fog.

```APIDOC
## StartDistance

### Description

Start distance of the fog.

### Property

- **StartDistance** (float) - Read/Write

### Declaration

Declared in Sandbox.Rendering.GradientFogSetup
```

--------------------------------

### void SetStartPoint(SceneAnchor start)

Source: https://sbox.game/api/Sandbox.BeamEffect/SetStartPoint

Sets the starting point of the beam effect.

```APIDOC
## void SetStartPoint(SceneAnchor start)

### Description
Sets the starting point for the beam effect.

### Parameters
- **start** (SceneAnchor) - Required - The anchor point where the beam starts from.
```

--------------------------------

### void OnInitialize ()

Source: https://sbox.game/api/Sandbox.Network.GameNetworkSystem/OnInitialize

Initializes the network system. This method is called when the network system should perform its setup procedures.

```APIDOC
## void OnInitialize ()

### Description
Called when the network system should handle initialization. This method is part of the `Sandbox.Network.GameNetworkSystem` class in the `Sandbox.Engine` assembly.

### Signature
`void OnInitialize ()`
```

--------------------------------

### bool Enabled

Source: https://sbox.game/api/Sandbox.CameraComponent.AutoExposureSetup/Enabled

Gets or sets the enabled state of the auto-exposure setup.

```APIDOC
## Property: Enabled

### Description
Gets or sets a value indicating whether the auto-exposure feature is enabled for the camera component.

### Signature
`bool Enabled { get; set; }`

### Namespace
`Sandbox.CameraComponent.AutoExposureSetup`

### Assembly
`Sandbox.Engine`
```

--------------------------------

### bool StartAsleep

Source: https://sbox.game/api/Sandbox.Rigidbody/StartAsleep

Gets or sets whether the Rigidbody starts in a sleeping state.

```APIDOC
## Property: StartAsleep

### Description
Gets or sets a boolean value indicating whether the Rigidbody component should start in a sleeping state when initialized.

### Signature
`bool StartAsleep { get; set; }`

### Namespace
`Sandbox.Rigidbody`

### Assembly
`Sandbox.Engine`
```

--------------------------------

### void StartEditing ()

Source: https://sbox.game/api/Editor.ControlWidget/StartEditing

Selects the widget and starts the editing process.

```APIDOC
## void StartEditing ()

### Description
Selects this widget and starts editing. This method is used when the system needs to focus on the widget in the inspector, such as when a user double-clicks an item in a graph editor that maps to this widget.

### Signature
`void StartEditing ()`

### Declaration
Declared in Editor.ControlWidget · Assembly `Sandbox.Tools`
```

--------------------------------

### void StartLoading ()

Source: https://sbox.game/api/Sandbox.Scene/StartLoading

Initiates the loading sequence for the current scene.

```APIDOC
## void StartLoading ()

### Description
Initiates the loading process for the scene. This method is part of the Sandbox.Scene class within the Sandbox.Engine assembly.

### Signature
`void StartLoading ()`
```

--------------------------------

### float StartDistance

Source: https://sbox.game/api/Sandbox.GradientFog/StartDistance

Gets or sets the starting distance for the gradient fog effect.

```APIDOC
## Property: StartDistance

### Description
Gets or sets the distance from the camera where the gradient fog effect begins.

### Signature
`float StartDistance { get; set; }`

### Namespace
`Sandbox.GradientFog`

### Assembly
`Sandbox.Engine`
```

--------------------------------

### FastTimer.Elapsed

Source: https://sbox.game/api/Sandbox.Diagnostics.FastTimer/Elapsed

Gets or sets the time elapsed since the timer was started as a TimeSpan.

```APIDOC
## Property: Elapsed

### Description
Gets or sets the time elapsed since the timer was started as a TimeSpan.

### Signature
`System.TimeSpan Elapsed { get; set; }`

### Namespace
`Sandbox.Diagnostics`

### Assembly
`Sandbox.System`
```

--------------------------------

### static void OpenSolution()

Source: https://sbox.game/api/Editor.CodeEditor/OpenSolution

Opens the solution containing all s&box projects.

```APIDOC
## static void OpenSolution()

### Description
Opens the solution for all s&box projects within the editor.

### Signature
`static void OpenSolution()`

### Assembly
`Sandbox.Tools`
```

--------------------------------

### float StartDistance

Source: https://sbox.game/api/Sandbox.CubemapFogController/StartDistance

Gets or sets the distance from the player at which the fog will start to fade in.

```APIDOC
## Property: StartDistance

### Description
The distance from the player at which the fog will start to fade in.

### Signature
`float StartDistance { get; set; }`

### Assembly
`Sandbox.Engine`
```

--------------------------------

### float StartDistance

Source: https://sbox.game/api/Sandbox.CubemapFog/StartDistance

Gets or sets the starting distance for the cubemap fog effect.

```APIDOC
## Property: StartDistance

### Description
Gets or sets the distance from the camera at which the cubemap fog effect begins to be applied.

### Signature
`float StartDistance { get; set; }`

### Namespace
`Sandbox.CubemapFog`

### Assembly
`Sandbox.Engine`
```

--------------------------------

### Editor.AssetSystem.InstallAsync(Package, bool, Action<float>, CancellationToken)

Source: https://sbox.game/api/Editor.AssetSystem/InstallAsync

Installs an asset using a Package object.

```APIDOC
## static Task<Asset> InstallAsync(Package package, bool skipIfInstalled = True, Action<float> loading = null, CancellationToken token = null)

### Parameters
- **package** (Package) - Required - The package object to install.
- **skipIfInstalled** (bool) - Optional - Whether to skip installation if the asset is already installed. Defaults to True.
- **loading** (System.Action<float>) - Optional - A callback to track loading progress. Defaults to null.
- **token** (System.Threading.CancellationToken) - Optional - A cancellation token for the operation. Defaults to null.

### Returns
- **Task<Asset>** - A task representing the asynchronous installation, returning the installed Asset.
```

--------------------------------

### void Start ()

Source: https://sbox.game/api/Sandbox.Diagnostics.Allocations.Scope/Start

Initiates a new allocation scope for diagnostic tracking.

```APIDOC
## void Start ()

### Description
Initiates a new allocation scope for diagnostic tracking within the Sandbox engine.

### Method
void

### Signature
void Start ()
```

--------------------------------

### float HeightStart

Source: https://sbox.game/api/Sandbox.CubemapFog/HeightStart

Gets or sets the starting height for the cubemap fog effect.

```APIDOC
## Property: HeightStart

### Description
Gets or sets the starting height for the cubemap fog effect. This property is part of the `Sandbox.CubemapFog` class.

### Signature
`float HeightStart { get; set; }`

### Assembly
`Sandbox.Engine`
```

--------------------------------

### FadeInStart Property

Source: https://sbox.game/api/Sandbox.VolumetricFogParameters/FadeInStart

Gets or sets the start distance where the volumetric fog fading begins.

```APIDOC
## FadeInStart

### Description
Gets or sets the distance from the camera where the volumetric fog begins to fade in.

### Signature
`float FadeInStart { get; set; }`

### Type
float

### Namespace
Sandbox.VolumetricFogParameters
```

--------------------------------

### void OnStart ()

Source: https://sbox.game/api/Sandbox.BaseInventoryComponent/OnStart

Initializes the inventory component. This method is called when the component is started.

```APIDOC
## void OnStart ()

### Description
Called when the BaseInventoryComponent starts. This is a lifecycle method used for initialization logic.

### Signature
`void OnStart ()`

### Assembly
`Sandbox.Engine`
```

--------------------------------

### Start()

Source: https://sbox.game/api/Sandbox.MovieMaker.MovieRecorder

Begins automatic recording of the scene.

```APIDOC
## Method: Start()

### Description
Starts the automatic recording process. Recording continues until Stop() is called or the returned IDisposable object is disposed.

### Returns
- **IDisposable** - An object that can be disposed to stop the recording.
```

--------------------------------

### Sandbox.LaunchArguments.Map

Source: https://sbox.game/api/Sandbox.LaunchArguments/Map

A static property used to get or set the starting map for the game session.

```APIDOC
## Sandbox.LaunchArguments.Map

### Description
Gets or sets the map to start with. The implementation and usage of this property are determined by the game logic.

### Signature
`static string Map { get; set; }`

### Assembly
`Sandbox.Engine`
```

--------------------------------

### Check cloud installation by package object

Source: https://sbox.game/api/Editor.AssetSystem/IsCloudInstalled

Verifies if a version of the specified package is installed in the cloud directory, with an optional parameter to enforce an exact version match.

```csharp
static bool IsCloudInstalled(Package package, bool exactVersion = False)
```

--------------------------------

### long ElapsedTicks

Source: https://sbox.game/api/Sandbox.Diagnostics.FastTimer/ElapsedTicks

Gets or sets the number of ticks elapsed since the timer was started.

```APIDOC
## Property: ElapsedTicks

### Description
Gets or sets the number of ticks elapsed since the timer was started.

### Signature
`long ElapsedTicks { get; set; }`

### Namespace
`Sandbox.Diagnostics.FastTimer`

### Assembly
`Sandbox.System`
```

--------------------------------

### ElapsedSeconds Property

Source: https://sbox.game/api/Sandbox.Diagnostics.FastTimer/ElapsedSeconds

Gets or sets the number of seconds elapsed since the timer was started.

```APIDOC
## Property: ElapsedSeconds

### Description
Gets or sets the number of seconds elapsed since the timer was started.

### Signature
`System.Double ElapsedSeconds { get; set; }`

### Namespace
`Sandbox.Diagnostics.FastTimer`

### Assembly
`Sandbox.System`
```

--------------------------------

### void StartSound ()

Source: https://sbox.game/api/Sandbox.BaseSoundComponent/StartSound

Initiates the sound playback for the component.

```APIDOC
## void StartSound ()

### Description
Starts the sound associated with the BaseSoundComponent.

### Signature
`void StartSound ()`

### Declared in
Sandbox.BaseSoundComponent (Assembly: Sandbox.Engine)
```

--------------------------------

### Editor.AssetSystem.InstallAsync(string, bool, Action<float>, CancellationToken)

Source: https://sbox.game/api/Editor.AssetSystem/InstallAsync

Installs an asset using a package identifier.

```APIDOC
## static Task<Asset> InstallAsync(string packageIdent, bool skipIfInstalled = True, Action<float> loading = null, CancellationToken token = null)

### Parameters
- **packageIdent** (string) - Required - The identifier of the package to install.
- **skipIfInstalled** (bool) - Optional - Whether to skip installation if the asset is already installed. Defaults to True.
- **loading** (System.Action<float>) - Optional - A callback to track loading progress. Defaults to null.
- **token** (System.Threading.CancellationToken) - Optional - A cancellation token for the operation. Defaults to null.

### Returns
- **Task<Asset>** - A task representing the asynchronous installation, returning the installed Asset.
```

--------------------------------

### ElapsedMilliSeconds Property

Source: https://sbox.game/api/Sandbox.Diagnostics.FastTimer/ElapsedMilliSeconds

Gets or sets the number of milliseconds elapsed since the timer was started.

```APIDOC
## Property: ElapsedMilliSeconds

### Description
Gets or sets the number of milliseconds elapsed since the timer was started.

### Signature
`System.Double ElapsedMilliSeconds { get; set; }`

### Namespace
Sandbox.Diagnostics.FastTimer
```

--------------------------------

### ElapsedMicroSeconds Property

Source: https://sbox.game/api/Sandbox.Diagnostics.FastTimer/ElapsedMicroSeconds

Gets or sets the number of microseconds elapsed since the timer was started.

```APIDOC
## Property: ElapsedMicroSeconds

### Description
Gets or sets the number of microseconds elapsed since the timer was started.

### Signature
`System.Double ElapsedMicroSeconds { get; set; }`

### Namespace
`Sandbox.Diagnostics.FastTimer`

### Assembly
`Sandbox.System`
```

--------------------------------

### static Task<bool> Install (string ident, long versionId, CancellationToken token)

Source: https://sbox.game/api/Editor.LibrarySystem/Install

Installs a library from a package by its identifier and version. This method downloads the package and places it in the project's Library folder.

```APIDOC
## static Task<bool> Install (string ident, long versionId, CancellationToken token)

### Description
Installs a library from a package. This will download the package and install it in the project's Library folder.

### Parameters
- **ident** (string) - Required - The identifier of the package.
- **versionId** (long) - Optional (default: -1) - The version ID of the package.
- **token** (CancellationToken) - Optional (default: null) - A cancellation token to observe while waiting for the task to complete.

### Returns
- **Task<bool>** - Returns a task that resolves to true if the installation was successful, otherwise false.
```

--------------------------------

### Name Property

Source: https://sbox.game/api/Sandbox.Speech.Synthesizer.InstalledVoice/Name

The Name property allows getting or setting the name of the installed voice.

```APIDOC
## Property: Name

### Description
Gets or sets the name of the installed voice.

### Signature
`string Name { get; set; }`

### Namespace
`Sandbox.Speech.Synthesizer`

### Assembly
`Sandbox.Engine`
```

--------------------------------

### void OnStart ()

Source: https://sbox.game/api/Sandbox.PanelComponent/OnStart

The OnStart method is called when the PanelComponent is initialized. It is a void method that takes no parameters.

```APIDOC
## void OnStart ()

### Description
Called when the PanelComponent starts. This method is intended to be overridden to perform initialization logic for the component.

### Signature
`void OnStart ()`

### Assembly
Sandbox.Engine
```

--------------------------------

### ParticleEffect.StartDelay

Source: https://sbox.game/api/Sandbox.ParticleEffect/StartDelay

The StartDelay property allows getting or setting the delay in seconds before a particle starts after being emitted.

```APIDOC
## Property: StartDelay

### Description
The delay before a particle starts after being emitted, measured in seconds.

### Signature
`ParticleFloat StartDelay { get; set; }`

### Namespace
`Sandbox.ParticleEffect`

### Assembly
`Sandbox.Engine`
```

--------------------------------

### void InitDefault ()

Source: https://sbox.game/api/Sandbox.InputSettings/InitDefault

Initializes the input settings to their default configuration.

```APIDOC
## void InitDefault ()

### Description
Initializes the input settings to their default configuration within the Sandbox engine.

### Signature
`void InitDefault ()`

### Namespace
`Sandbox.InputSettings`

### Assembly
`Sandbox.Engine`
```

--------------------------------

### WorldStartPositionOnNavmesh

Source: https://sbox.game/api/Sandbox.NavMeshLink/WorldStartPositionOnNavmesh

A property that gets or sets the start position of the NavMeshLink in world space, snapped to the navmesh.

```APIDOC
## Property: WorldStartPositionOnNavmesh

### Description
Gets or sets the start position of the NavMeshLink in world space, snapped to the navmesh.

### Signature
`System.Nullable<Vector3> WorldStartPositionOnNavmesh { get; set; }`

### Namespace
`Sandbox.NavMeshLink`

### Assembly
`Sandbox.Engine`
```

--------------------------------

### Task<Entry> Install (CancellationToken token)

Source: https://sbox.game/api/Sandbox.Storage.QueryItem/Install

Installs the current storage item. This method returns a Task representing the asynchronous operation, which resolves to an Entry object or null if the item format is incorrect.

```APIDOC
## Install

### Description
Installs the storage item. Returns null if the item is not of the correct format.

### Method
Task<Entry> Install (CancellationToken token)

### Parameters
- **token** (CancellationToken) - Optional - A cancellation token to observe while waiting for the task to complete.

### Returns
- **Task<Entry>** - An asynchronous task that results in an Entry object upon successful installation.
```

--------------------------------

### HeightStart Property

Source: https://sbox.game/api/Sandbox.CubemapFogController/HeightStart

Gets or sets the absolute height in the map at which the height fog will start to fade in.

```APIDOC
## Property: HeightStart

### Description
The absolute height in the map at which the height fog will start to fade in.

### Signature
`float HeightStart { get; set; }`

### Namespace
`Sandbox.CubemapFogController`

### Assembly
`Sandbox.Engine`
```

--------------------------------

### void OpenSolution ()

Source: https://sbox.game/api/Editor.ICodeEditor/OpenSolution

Opens the solution of all sandbox projects.

```APIDOC
## void OpenSolution ()

### Description
Opens the solution of all sandbox projects within the editor.

### Signature
`void OpenSolution ()`

### Declared in
Editor.ICodeEditor · Assembly `Sandbox.Tools`
```

--------------------------------

### Vector3 LocalStartPosition

Source: https://sbox.game/api/Sandbox.NavMeshLink/LocalStartPosition

Gets or sets the start position of the NavMeshLink relative to the game object's position.

```APIDOC
## Property: LocalStartPosition

### Description
Gets or sets the start position of the NavMeshLink relative to the game object's position.

### Signature
`Vector3 LocalStartPosition { get; set; }`

### Namespace
`Sandbox.NavMeshLink`

### Assembly
`Sandbox.Engine`
```

--------------------------------

### AutoExposureSetup Constructor

Source: https://sbox.game/api/Sandbox.CameraComponent.AutoExposureSetup

Initializes a new instance of the AutoExposureSetup class.

```APIDOC
## AutoExposureSetup()

### Description
Initializes a new instance of the AutoExposureSetup class.

### Signature
`AutoExposureSetup()`
```

--------------------------------

### SetupLighting

Source: https://sbox.game/api/Sandbox.Graphics/SetupLighting

Sets up the lighting attributes for the current object and places them in the targetAttributes.

```APIDOC
## SetupLighting

### Description
Sets up the lighting attributes for the current object and places them in the targetAttributes.

### Method Signature
`static void SetupLighting (SceneObject obj, RenderAttributes targetAttributes = null)`

### Parameters
#### Path Parameters
- **obj** (SceneObject) - Description not provided.
- **targetAttributes** (RenderAttributes) - Optional. Defaults to null. Description not provided.

### Declared in
Sandbox.Graphics · Assembly `Sandbox.Engine`
```

--------------------------------

### CursorDelta

Source: https://sbox.game/api/Sandbox.Gizmo.Pressed/CursorDelta

A static property that gets or sets the Vector2 representing the distance the cursor has travelled since the press started.

```APIDOC
## CursorDelta

### Description
Gets or sets the distance the cursor has travelled since the press started.

### Signature
`static Vector2 CursorDelta { get; set; }`

### Type
`Vector2`
```

--------------------------------

### void Init (System.Reflection.MemberInfo x)

Source: https://sbox.game/api/Sandbox.MemberDescription/Init

Initializes the member description with the provided reflection member information.

```APIDOC
## void Init (System.Reflection.MemberInfo x)

### Description
Initializes the member description using the specified System.Reflection.MemberInfo object.

### Signature
`void Init(System.Reflection.MemberInfo x)`

### Parameters
- **x** (System.Reflection.MemberInfo) - Required - The member information to initialize with.
```

--------------------------------

### int LoopStart { get; set; }

Source: https://sbox.game/api/Sandbox.Sprite.Animation/LoopStart

The frame index at which looping starts. A value of -1 means the first frame (0).

```APIDOC
## Property: LoopStart

### Description
The frame index at which looping starts. A value of -1 means the first frame (0).

### Signature
`int LoopStart { get; set; }`

### Namespace
Sandbox.Sprite.Animation

### Assembly
Sandbox.Engine
```

--------------------------------

### int EffectiveLoopStart

Source: https://sbox.game/api/Sandbox.Sprite.Animation/EffectiveLoopStart

Gets or sets the effective loop start frame index. If the value is set to -1, it is resolved to 0.

```APIDOC
## Property: EffectiveLoopStart

### Description
Returns the effective loop start frame index for a sprite animation. This property automatically resolves a value of -1 to 0.

### Signature
`int EffectiveLoopStart { get; set; }`

### Namespace
`Sandbox.Sprite.Animation`

### Assembly
`Sandbox.Engine`
```

--------------------------------

### void StartLine ()

Source: https://sbox.game/api/Sandbox.SceneLineObject/StartLine

Initializes the line object within the scene.

```APIDOC
## void StartLine ()

### Description
Initializes or starts the line object in the scene. This method is part of the `Sandbox.SceneLineObject` class.

### Signature
`void StartLine ()`

### Assembly
`Sandbox.Engine`
```

--------------------------------

### Origin Property

Source: https://sbox.game/api/Sandbox.BaseCombatWeapon.ShotEffect/Origin

The Origin property allows getting or setting the starting position of a shot effect. It is defined as a nullable Vector3.

```APIDOC
## Property: Origin

### Description
Gets or sets the origin point of the shot effect. This property is nullable.

### Signature
`System.Nullable<Vector3> Origin { get; set; }`

### Type
`System.Nullable<Vector3>`
```

--------------------------------

### void OnAboutToShow ()

Source: https://sbox.game/api/Editor.ContextMenu/OnAboutToShow

This method is called by the system when a context menu is about to be shown. It allows for customization or dynamic population of the menu items.

```APIDOC
## void OnAboutToShow ()

### Description
Triggered when a context menu is about to be shown in the editor. This method can be overridden to modify the menu contents before it is rendered to the user.

### Signature
`void OnAboutToShow ()`

### Assembly
`Sandbox.Tools`
```

--------------------------------

### static Task InstallSingle(string ident)

Source: https://sbox.game/api/Editor.CloudAsset/InstallSingle

Installs a cloud asset into the project using the provided asset identifier.

```APIDOC
## static Task InstallSingle(string ident)

### Description
Installs a cloud asset by its unique identifier.

### Signature
`static Task InstallSingle(string ident)`

### Parameters
- **ident** (string) - The unique identifier of the cloud asset to install.

### Returns
- **Task** - A task representing the asynchronous installation operation.
```

--------------------------------

### Sandbox.LaunchArguments.Privacy

Source: https://sbox.game/api/Sandbox.LaunchArguments/Privacy

The static Privacy property allows developers to get or set the default privacy level for lobbies created when the game starts.

```APIDOC
## static LobbyPrivacy Privacy

### Description
Gets or sets the default privacy setting for lobbies created on game start.

### Signature
`static LobbyPrivacy Privacy { get; set; }`

### Assembly
`Sandbox.Engine`
```

--------------------------------

### float HeightExponent

Source: https://sbox.game/api/Sandbox.CubemapFogController/HeightExponent

Gets or sets the exponent for height falloff. A value of 2.0, for example, makes the falloff proportional to the square of the distance.

```APIDOC
## Property: HeightExponent

### Description
Gets or sets the exponent for height falloff. This value determines how the fog density changes relative to height; for instance, a value of 2.0 results in a falloff proportional to the square of the distance.

### Signature
`float HeightExponent { get; set; }`

### Namespace
`Sandbox`

### Assembly
`Sandbox.Engine`
```

--------------------------------

### void GiveLoadout ()

Source: https://sbox.game/api/Sandbox.BaseInventoryComponent/GiveLoadout

Grants the starting loadout defined by StartingItems and StartingAmmo. This method is host-only and should be called once per life.

```APIDOC
## void GiveLoadout ()

### Description
Grants the starting loadout by picking up every `Sandbox.BaseInventoryComponent.StartingItems` prefab and granting the `Sandbox.BaseInventoryComponent.StartingAmmo`. If no item is currently active, it will automatically switch to the best item.

### Usage
This method is host-only. It grants the loadout unconditionally, so the caller is responsible for ensuring it is only invoked once per life.

### Signature
`void GiveLoadout ()`

### Declared in
`Sandbox.BaseInventoryComponent` (Assembly: `Sandbox.Engine`)
```

--------------------------------

### SamplerState Usage Example

Source: https://sbox.game/api/i/allstructs

Demonstrates how to define a SamplerState in shader code and how to configure and apply it using the C# binding.

```csharp
 SamplerState mySampler < Attribute("sampler"); >;
```

```csharp
 var sampler = new SamplerState {     Filter = FilterMode.Trilinear,     AddressModeU = TextureAddressMode.Wrap,     AddressModeV = TextureAddressMode.Wrap,     AddressModeW = TextureAddressMode.Clamp,     MaxAnisotropy = 4 };              Graphics.Attributes.Set("sampler", sampler);
```

--------------------------------

### float FalloffExponent

Source: https://sbox.game/api/Sandbox.CubemapFogController/FalloffExponent

Gets or sets the exponent for distance falloff. A value of 2.0, for example, makes the falloff proportional to the square of the distance.

```APIDOC
## Property: FalloffExponent

### Description
Gets or sets the exponent for distance falloff. A value of 2.0, for example, makes the falloff proportional to the square of the distance.

### Signature
`float FalloffExponent { get; set; }`

### Namespace
`Sandbox.CubemapFogController`

### Assembly
`Sandbox.Engine`
```

--------------------------------

### void OnStart ()

Source: https://sbox.game/api/Sandbox.Component/OnStart

The OnStart method is invoked exactly once during the component lifecycle, specifically before the first Update call, provided the component is enabled.

```APIDOC
## void OnStart ()

### Description
Called once before the first Update when the component is enabled.

### Signature
`void OnStart ()`

### Namespace
Sandbox.Component
```

--------------------------------

### Bind.Builder Example Usage

Source: https://sbox.game/api/i/allstructs

Demonstrates how to use the Builder struct to create a binding between two properties.

```csharp
BindSystem.Build.Set( this, "BoolValue" ).From( this, "StringValue" );
```

--------------------------------

### static SoundFile FromWav(string filename, System.Span<System.Byte> data, System.Nullable<LoadOptions> loadOptions)

Source: https://sbox.game/api/Sandbox.SoundFile/FromWav

Creates a SoundFile instance from the provided WAV data.

```APIDOC
## static SoundFile FromWav(string filename, System.Span<System.Byte> data, System.Nullable<LoadOptions> loadOptions)

### Description
Creates a new SoundFile object from the specified WAV data.

### Parameters
- **filename** (string) - The name of the file.
- **data** (System.Span<System.Byte>) - The raw WAV data.
- **loadOptions** (System.Nullable<LoadOptions>) - Optional loading configurations.

### Returns
- **SoundFile** - The resulting SoundFile object.
```

--------------------------------

### NetList Usage

Source: https://sbox.game/api/i/allclasses

Example of using NetList within a Component to synchronize a list of integers across the network.

```csharp
public class MyComponent : Component { 	[Sync] public NetList MyIntegerList { get; set; } = new(); 	  
 	public void AddNumber( int number ) 	{ 		if ( IsProxy ) return; 		MyIntegerList.Add( number ); 	} }
```

--------------------------------

### Static Map Property Definition

Source: https://sbox.game/api/Sandbox.LaunchArguments/Map

The static string property used to get or set the starting map, declared in Sandbox.LaunchArguments within the Sandbox.Engine assembly.

```csharp
static string Map {  get;  set; }
```

--------------------------------

### static void CreateGame(in CreateGameOptions options)

Source: https://sbox.game/api/Sandbox.Game.Overlay/CreateGame

Opens a modal to create a game with a set of predefined options.

```APIDOC
## static void CreateGame(in CreateGameOptions options)

### Description
Opens a modal to create a game with a bunch of settings. This is typically used in the menu when a user initiates the game creation process.

### Parameters
- **options** (CreateGameOptions) - Required - The configuration settings for the game creation modal.
```

--------------------------------

### NetDictionary Usage

Source: https://sbox.game/api/i/allclasses

Example of using NetDictionary within a Component to synchronize a dictionary of boolean states across the network.

```csharp
public class MyComponent : Component { 	[Sync] public NetDictionary MyBoolTable { get; set; } = new(); 	  
 	public void SetBoolState( string key, bool state ) 	{ 		if ( IsProxy ) return; 		MyBoolTable[key] = state; 	} }
```

--------------------------------

### float BlendDistance

Source: https://sbox.game/api/Sandbox.PostProcessVolume/BlendDistance

Gets or sets the distance from the edge of the volume where blending starts. A value of 0 results in a hard edge, while higher values produce softer transitions.

```APIDOC
## Property: BlendDistance

### Description
Gets or sets the distance from the edge of the volume where blending starts. A value of 0 means a hard edge, while higher values create softer transitions.

### Signature
`float BlendDistance { get; set; }`

### Namespace
`Sandbox`

### Class
`PostProcessVolume`
```

--------------------------------

### Create and open a searchable ContextMenu

Source: https://sbox.game/api/Editor.ContextMenu

Initializes a new context menu with search enabled, adds an option, and displays it at the current cursor position.

```csharp
var menu = new ContextMenu { Searchable = true };
menu.AddOption( "Option 1", action: () => {} );
menu.OpenAtCursor();
```

--------------------------------

### AnyOfType Property Usage

Source: https://sbox.game/api/i/allstructs

Example of using the AnyOfType struct as a property type to allow inspector selection of concrete implementations.

```csharp
public AnyOfType MyScatterer { get; set; }
```

--------------------------------

### void StartEditing ()

Source: https://sbox.game/api/Editor.StringControlWidget/StartEditing

Initiates the editing state for the string control widget.

```APIDOC
## void StartEditing ()

### Description
Initiates the editing process for the string control widget. This method is part of the Editor.StringControlWidget class in the Sandbox.Tools assembly.

### Signature
`void StartEditing()`
```

--------------------------------

### Component FindComponentByGuid(Guid guid)

Source: https://sbox.game/api/Sandbox.GameObjectDirectory/FindComponentByGuid

Finds a Component in the scene by its Guid.

```APIDOC
## Component FindComponentByGuid(Guid guid)

### Description
Finds a Component in the scene by Guid. This operation is designed to be highly performant.

### Parameters
- **guid** (Guid) - The unique identifier of the component to find.

### Returns
- **Component** - The component associated with the provided Guid.
```

--------------------------------

### void Switch (BaseInventoryItem item, bool allowHolster)

Source: https://sbox.game/api/Sandbox.BaseInventoryComponent/Switch

Makes the given item active, holstering whatever was active. Pass null with allowHolster to holster everything. Routed through the host.

```APIDOC
## void Switch (BaseInventoryItem item, bool allowHolster)

### Description
Makes the given item active, holstering whatever was active. Pass null with allowHolster to holster everything. Routed through the host.

### Parameters
- **item** (BaseInventoryItem) - The item to make active.
- **allowHolster** (bool) - Optional (default: False) - Whether to allow holstering the current item.
```

--------------------------------

### static Dictionary<Guid, Guid> MakeIdGuidsUnique (JsonObject json, Guid? rootGuid)

Source: https://sbox.game/api/Sandbox.SceneUtility/MakeIdGuidsUnique

Processes a JSON object to ensure ID GUIDs are unique. Returns a dictionary mapping original GUIDs to their new unique counterparts.

```APIDOC
## MakeIdGuidsUnique

### Description
Processes a `System.Text.Json.Nodes.JsonObject` to ensure that ID GUIDs contained within are unique. Returns a `Dictionary<Guid, Guid>` mapping the original GUIDs to the new unique GUIDs.

### Signature
`static Dictionary<Guid, Guid> MakeIdGuidsUnique (System.Text.Json.Nodes.JsonObject json, System.Nullable<Guid> rootGuid)`

### Parameters
- **json** (System.Text.Json.Nodes.JsonObject) - Required - The JSON object to process.
- **rootGuid** (System.Nullable<Guid>) - Optional - The root GUID, defaults to null.

### Returns
- **Dictionary<Guid, Guid>** - A dictionary containing the mapping of original GUIDs to new unique GUIDs.
```

--------------------------------

### static Mixer FindMixerByGuid(Guid guid)

Source: https://sbox.game/api/Sandbox.Audio.Mixer/FindMixerByGuid

Retrieves an audio mixer by its unique GUID.

```APIDOC
## static Mixer FindMixerByGuid(Guid guid)

### Description
Retrieves a specific audio mixer instance from the engine using its unique GUID.

### Parameters
- **guid** (Guid) - The unique identifier of the mixer to find.

### Returns
- **Mixer** - The mixer instance associated with the provided GUID.
```

--------------------------------

### static void ShowServerList (in ServerListConfig config)

Source: https://sbox.game/api/Sandbox.Game.Overlay/ShowServerList

Opens a modal that displays a list of active servers using the provided configuration.

```APIDOC
## static void ShowServerList (in ServerListConfig config)

### Description
Opens a modal that shows a list of active servers.

### Parameters
- **config** (ServerListConfig) - Required - The configuration object used to filter or display the server list.

### Signature
`static void ShowServerList (in ServerListConfig config)`
```

--------------------------------

### Vector2.x

Source: https://sbox.game/api/Vector2/x

Gets or sets the X component of this vector.

```APIDOC
## Vector2.x

### Description
Gets or sets the X component of this vector.

### Property
- **x** (float) - The X component of the vector.

### Accessors
- **get**
- **set**

### Declared in
Vector2 · Assembly `Sandbox.System`
```

--------------------------------

### GameObject FindByGuid(Guid guid)

Source: https://sbox.game/api/Sandbox.GameObjectDirectory/FindByGuid

Finds a GameObject in the scene by its Guid. This operation is optimized for high performance.

```APIDOC
## GameObject FindByGuid(Guid guid)

### Description
Find a GameObject in the scene by Guid. This should be really really fast.

### Method
Method: FindByGuid(Guid guid)

### Parameters
- **guid** (Guid) - Required - The unique identifier of the GameObject to find.

### Returns
- **GameObject** - The GameObject associated with the provided Guid.
```

--------------------------------

### void SelectItemStartingWith (string text)

Source: https://sbox.game/api/Editor.BaseItemWidget/SelectItemStartingWith

Selects an item in the widget that starts with the provided text string.

```APIDOC
## void SelectItemStartingWith (string text)

### Description
Selects an item within the Editor.BaseItemWidget that starts with the specified string.

### Parameters
- **text** (string) - The prefix string used to identify and select the item.
```

--------------------------------

### void CreateViewModel ()

Source: https://sbox.game/api/Sandbox.BaseCombatWeapon/CreateViewModel

Spawns the view model from the ViewModelPrefab and plays the deploy presentation. This method is idempotent and intended for owner-only execution.

```APIDOC
## void CreateViewModel ()

### Description
Spawns the view model from Sandbox.BaseCombatWeapon.ViewModelPrefab and plays its deploy presentation. This method is owner-only and idempotent, meaning it is safe to call even if a view model already exists.

### Signature
`void CreateViewModel ()`

### Declared In
Sandbox.BaseCombatWeapon (Assembly: Sandbox.Engine)
```

--------------------------------

### FindComponentByGuid(Guid guid)

Source: https://sbox.game/api/Sandbox.GameObjectDirectory

Finds a Component in the scene by its unique identifier.

```APIDOC
## FindComponentByGuid(Guid guid)

### Description
Find a Component in the scene by Guid. This operation is highly performant.

### Parameters
- **guid** (Guid) - Required - The unique identifier of the Component to find.

### Returns
- **Component** - The found Component or null if not found.
```

--------------------------------

### Editor.LibrarySystem.Install

Source: https://sbox.game/api/Editor.LibrarySystem

Installs a library from a package, downloading it and placing it in the project's Library folder.

```APIDOC
## Method: Install

### Description
Install a library from a package. This will download the package and install it in the project's Library folder.

### Signature
`public static void Install( string packageIdent )`
```

--------------------------------

### void OnAboutToShow ()

Source: https://sbox.game/api/Editor.Menu/OnAboutToShow

This method is called when the menu is about to be shown. It is part of the Editor.Menu class in the Sandbox.Tools assembly.

```APIDOC
## void OnAboutToShow ()

### Description
Triggered when the menu is about to be displayed. This method allows for custom logic to be executed immediately before the menu becomes visible.

### Signature
`void OnAboutToShow ()`

### Namespace
`Editor.Menu`

### Assembly
`Sandbox.Tools`
```

--------------------------------

### FindByGuid(Guid guid)

Source: https://sbox.game/api/Sandbox.GameObjectDirectory

Finds a GameObject in the scene by its unique identifier.

```APIDOC
## FindByGuid(Guid guid)

### Description
Find a GameObject in the scene by Guid. This operation is highly performant.

### Parameters
- **guid** (Guid) - Required - The unique identifier of the GameObject to find.

### Returns
- **GameObject** - The found GameObject or null if not found.
```

--------------------------------

### float Item { get; set; }

Source: https://sbox.game/api/Vector4/Item

Accesses or modifies the component of the Vector4 at the specified index.

```APIDOC
## Property: Item

### Description
Gets or sets the component value at the specified index of the Vector4.

### Signature
`float Item { get; set; }`

### Parameters
- **index** (int) - The zero-based index of the component to access (0, 1, 2, or 3).
```

--------------------------------

### int Item { get; set; }

Source: https://sbox.game/api/Vector2Int/Item

Accesses the integer component of the Vector2Int at the specified index.

```APIDOC
## Property: Item

### Description
Gets or sets the integer component of the Vector2Int at the specified index.

### Signature
`int Item { get; set; }`

### Assembly
Sandbox.System
```

--------------------------------

### void StartEditing ()

Source: https://sbox.game/api/Editor.DropdownControlWidget/StartEditing

Initiates the editing mode for the dropdown control widget.

```APIDOC
## void StartEditing ()

### Description
Initiates the editing state for the `Editor.DropdownControlWidget`. This method is part of the `Sandbox.Tools` assembly.

### Signature
`void StartEditing()`
```

--------------------------------

### Get a Vector2 with components set to 1

Source: https://sbox.game/api/Vector2/One

Use this static property to obtain a Vector2 where both X and Y components are equal to 1. This is useful for default values or unit vectors.

```csharp
static Vector2 One {  get;  set; }
```

--------------------------------

### RunInThreadAsync Anonymous Function Example

Source: https://sbox.game/api/Sandbox.TaskSource/RunInThreadAsync

Example of using an anonymous function with RunInThreadAsync.

```csharp
async Task GenericAsync() // Whatever async code your writing
{
    await ts.RunInThreadAsync( () =>
        ExpensiveCalculation();
    );
}
```

--------------------------------

### void OnBecameHost (Connection previousHost)

Source: https://sbox.game/api/Sandbox.Network.GameNetworkSystem/OnBecameHost

This method is invoked when the local client becomes the new host of the game session. It provides the connection information of the previous host.

```APIDOC
## void OnBecameHost (Connection previousHost)

### Description
This method is called when the host leaves the server and the current client is promoted to host. It allows the system to handle the transition of authority.

### Parameters
- **previousHost** (Connection) - The connection object representing the host that just left.
```

--------------------------------

### float Time { get; set; }

Source: https://sbox.game/api/Sandbox.SkinnedModelRenderer.SequenceAccessor/Time

Gets or sets the current time of the sequence.

```APIDOC
## Property: Time

### Description
Gets or sets the current time value for the sequence associated with the SkinnedModelRenderer.

### Signature
`float Time { get; set; }`

### Namespace
`Sandbox.SkinnedModelRenderer.SequenceAccessor`
```

--------------------------------

### void Initialize ()

Source: https://sbox.game/api/Sandbox.Helpers.UndoSystem/Initialize

Clears the existing undo history and captures an initial snapshot. This should be invoked immediately after loading a project or creating a new one.

```APIDOC
## void Initialize ()

### Description
Clears the undo history and takes an initial snapshot. This method should be called right after a load or when starting a new project.

### Signature
`void Initialize ()`

### Namespace
`Sandbox.Helpers.UndoSystem`

### Assembly
`Sandbox.Tools`
```

--------------------------------

### void StartEditing ()

Source: https://sbox.game/api/Editor.VectorIntControlWidget/StartEditing

Initiates the editing state for the VectorIntControlWidget.

```APIDOC
## void StartEditing ()

### Description
Initiates the editing process for the VectorIntControlWidget component.

### Signature
`void StartEditing()`

### Assembly
`Sandbox.Tools`
```

--------------------------------

### static Guid ToGuid(string input)

Source: https://sbox.game/api/Sandbox.SandboxSystemExtensions/ToGuid

Converts a provided string into a deterministic Guid.

```APIDOC
## static Guid ToGuid(string input)

### Description
Takes a string input and creates a deterministic Guid based on that string.

### Parameters
- **input** (string) - The string to convert into a Guid.

### Returns
- **Guid** - The resulting deterministic Guid.
```

--------------------------------

### MovieTimeRange.ClampStart(System.Nullable<MovieTime> start)

Source: https://sbox.game/api/Sandbox.MovieMaker.MovieTimeRange/ClampStart

Clamps the start of the MovieTimeRange to the provided MovieTime value.

```APIDOC
## Method: ClampStart

### Description
Clamps the start time of a `MovieTimeRange` instance to a specified `MovieTime` value.

### Signature
`MovieTimeRange ClampStart(System.Nullable<MovieTime> start)`

### Parameters
- **start** (System.Nullable<MovieTime>) - The start time to clamp to.

### Returns
- **MovieTimeRange** - A new or modified `MovieTimeRange` object with the clamped start time.
```

--------------------------------

### static void RunLocalBenchmarks (System.String[] packageFilter, System.String[] testFilter)

Source: https://sbox.game/api/Sandbox.Game.Overlay/RunLocalBenchmarks

Starts a local benchmark run from within the game. The results panel is shown when all packages complete.

```APIDOC
## static void RunLocalBenchmarks (System.String[] packageFilter, System.String[] testFilter)

### Description
Starts a local benchmark run from within the game. The results panel is shown when all packages complete.

### Parameters
- **packageFilter** (System.String[]) - Optional - Package names to include (null = all configured packages).
- **testFilter** (System.String[]) - Optional - Individual test names to run (null = all). Passed to packages via the benchmark.tests game setting.
```

--------------------------------

### Sample()

Source: https://sbox.game/api/Sandbox.Services.BenchmarkSystem

Records a sample for the benchmark.

```APIDOC
## Sample()

### Description
Should be called in update every frame.
```

--------------------------------

### float MinForce { get; set; }

Source: https://sbox.game/api/Sandbox.Physics.SpringJoint/MinForce

Gets or sets the minimum force allowed for the SpringJoint.

```APIDOC
## Property: MinForce

### Description
Gets or sets the minimum force that the SpringJoint is allowed to exert.

### Signature
`float MinForce { get; set; }`

### Namespace
`Sandbox.Physics`

### Assembly
`Sandbox.Engine`
```

--------------------------------

### float Scale { get; set; }

Source: https://sbox.game/api/Sandbox.ParticleTextRenderer/Scale

Gets or sets the scale of the particle text renderer.

```APIDOC
## Property: Scale

### Description
Gets or sets the scaling factor for the particle text renderer. This property controls the size of the rendered text particles.

### Signature
`float Scale { get; set; }`

### Type
`float`
```

--------------------------------

### Sandbox.Speech.Start

Source: https://sbox.game/api/Sandbox.Speech.Recognition

Starts the speech recognition process with a provided callback and set of choices.

```APIDOC
## Start(callback, choices)

### Description
Starts the speech recognition process. Users can provide a callback function and a list of choices for recognition.

### Parameters
- **callback** (function) - Required - The function to execute upon speech recognition.
- **choices** (array) - Required - The list of valid speech choices to listen for.
```

--------------------------------

### int Count { get; set; }

Source: https://sbox.game/api/Sandbox.NetList%3CT%3E/Count

Gets or sets the number of elements contained in the Sandbox.NetList<T>.

```APIDOC
## Property: Count

### Description
Gets or sets the number of elements contained in the `Sandbox.NetList<T>` collection.

### Signature
`int Count { get; set; }`

### Type
`int`
```

--------------------------------

### void StartEditing ()

Source: https://sbox.game/api/Editor.VectorControlWidget/StartEditing

Initiates the editing process for the VectorControlWidget.

```APIDOC
## void StartEditing ()

### Description
Initiates the editing state for the VectorControlWidget.

### Signature
`void StartEditing ()`

### Assembly
Sandbox.Tools
```

--------------------------------

### Configure and set a SamplerState in C#

Source: https://sbox.game/api/Sandbox.Rendering.SamplerState

Demonstrates initializing a SamplerState object with specific filtering and addressing modes, then binding it to a shader attribute.

```csharp
var sampler = new SamplerState
{
    Filter = FilterMode.Trilinear,
    AddressModeU = TextureAddressMode.Wrap,
    AddressModeV = TextureAddressMode.Wrap,
    AddressModeW = TextureAddressMode.Clamp,
    MaxAnisotropy = 4
};
            
Graphics.Attributes.Set("sampler", sampler);
```

--------------------------------

### string Name { get; set; }

Source: https://sbox.game/api/Sandbox.MovieMaker.Compiled.CompiledPropertyTrack%3CT%3E/Name

Gets or sets the name of the compiled property track.

```APIDOC
## Property: Name

### Description
Gets or sets the string identifier for the CompiledPropertyTrack instance.

### Signature
`string Name { get; set; }`

### Declared In
`Sandbox.MovieMaker.Compiled.CompiledPropertyTrack<T>`
```

--------------------------------

### int Priority { get; set; }

Source: https://sbox.game/api/Sandbox.EnvmapProbe/Priority

Gets or sets the priority level for the EnvmapProbe object.

```APIDOC
## Property: Priority

### Description
Gets or sets the priority level for the EnvmapProbe object. This integer value determines the rendering priority of the probe.

### Signature
`int Priority { get; set; }`

### Namespace
`Sandbox`

### Assembly
`Sandbox.Engine`
```

--------------------------------

### Create()

Source: https://sbox.game/api/Sandbox.Mounting.PrefabBuilder

Serializes the scene content into a registered Sandbox.PrefabFile.

```APIDOC
## Create()

### Description
Serializes the scene content into a registered Sandbox.PrefabFile. This should be called after objects have been created and the Scope has been disposed.
```

--------------------------------

### StartingItems Property

Source: https://sbox.game/api/Sandbox.BaseInventoryComponent/StartingItems

A list of GameObject prefabs that are automatically granted to the inventory upon loadout initialization.

```APIDOC
## Property: StartingItems

### Description
Gets or sets the list of item prefabs granted by the loadout. Each item in this list must be a valid Sandbox.BaseInventoryItem.

### Signature
`List<GameObject> StartingItems { get; set; }`

### Namespace
Sandbox.BaseInventoryComponent
```
Tokens:
Raw