API ReferenceSandbox.Mounting

PrefabBuilderclass

A scoped builder for creating prefabs within a Mount. Typically used inside a `Sandbox.Mounting.ResourceLoader.Load` implementation.

object→PrefabBuilder

Namespace: Sandbox.Mounting
Assembly: Sandbox.Engine
Declaration: public sealed class Sandbox.Mounting.PrefabBuilder

Constructors1

Showing 1 constructors

public PrefabBuilder()PUBLICCONSTRUCTOR

Methods4

Showing 4 methods

public Sandbox.PrefabFile Create()PUBLIC

Serialize the scene content into a registered `Sandbox.PrefabFile`. Call after you've created any objects and the `Sandbox.Mounting.PrefabBuilder.Scope` has been disposed.

Returns:PrefabFile—

public static void Destroy(Sandbox.PrefabFile prefab)PUBLICSTATIC

Unregister and destroy a `Sandbox.PrefabFile` created by `Sandbox.Mounting.PrefabBuilder.Create`. Call from `Sandbox.Mounting.ResourceLoader.Shutdown` when a mount is disabled.

Parameter	Type	Description
prefab	`PrefabFile`	—

Returns:void—

public Sandbox.Mounting.PrefabBuildScope Scope()PUBLIC

Enter a temporary scene scope. GameObjects created inside will become part of this prefab.

Returns:PrefabBuildScope—

public Sandbox.Mounting.PrefabBuilder WithName(string name)PUBLIC

Set the name/resource path of the resulting prefab. The root `Sandbox.GameObject` name is derived from the filename portion if left unchanged.

Parameter	Type	Description
name	`string`	—

Returns:PrefabBuilder—

TryParse()

Create()

PrefabBuilderclass

Constructors1

Methods4

On this page