VR Builder

https://mindport-gmbh.github.io/VR-Builder-Documentation/
Admin
VR Builder is a Unity-based platform for creating interactive VR applications through a visual...
Tokens:412,625
Snippets:4,506
Trust Score:9.7
Update:4 months ago
Show doc for...
Tokens:
Raw
### Setup Method

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.Input.DefaultInputController.html

Performs internal setup for the input controller.

```csharp
protected override void Setup()
```

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

### Start Method

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.Conditions.BaseActiveProcessOverCompletable-1.html

Overrides the base Start method to initialize the process.

```csharp
public override void Start()
```

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

### SceneObjectAutomaticSetup

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.SceneObjects.SceneObjectExtensions.html

Utility methods for automatic setup and undoing setup of scene objects.

```APIDOC
## SceneObjectAutomaticSetup

### Description
Performs automatic setup for a scene object based on a provided type.

### Parameters
#### Path Parameters
- **selectedSceneObject** (GameObject) - Required - The target game object.
- **valueType** (Type) - Required - The type used for setup.
- **excludeEditor** (bool) - Optional - Whether to exclude editor-only components.
```

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

### SceneSetup Setup Method Declaration

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.Editor.Setup.SceneSetup.html

Abstract method that must be implemented by derived classes to perform the scene setup based on a configuration.

```csharp
public abstract void Setup(ISceneSetupConfiguration configuration)
```

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

### RigLoaderSceneSetup Setup Method

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.BasicInteraction.Editor.Setup.RigLoaderSceneSetup.html

Configures the scene using the provided ISceneSetupConfiguration.

```csharp
public override void Setup(ISceneSetupConfiguration configuration)
```

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

### Start Recording

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.Editor.TestableEditorElements.html

Begins a new recording session.

```csharp
public static void StartRecording()
```

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

### InteractionRigProvider Methods

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.BasicInteraction.RigSetup.InteractionRigProvider.html

Methods for managing the rig setup lifecycle and prefab retrieval.

```csharp
public virtual bool CanBeUsed()
```

```csharp
protected GameObject FindPrefab(string prefab)
```

```csharp
public virtual GameObject GetPrefab()
```

```csharp
public virtual string GetSetupTooltip()
```

```csharp
public virtual void OnSetup()
```

```csharp
public virtual void PreSetup()
```

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

### ParticleSystemProperty StartEmission Method

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.Properties.ParticleSystemProperty.html

Starts the emission of particles from the associated particle system.

```csharp
public void StartEmission()
```

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

### Play Method Declaration

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Pro.Properties.IVideoPlayerProperty.html

Starts video playback.

```csharp
void Play()
```

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

### StageProcess Start Method

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.StageProcess-1.html

Abstract method that must be implemented by derived classes to define the logic for starting the process.

```csharp
public abstract void Start()
```

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

### Start Playback

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.Editor.TestableEditorElements.html

Initiates playback for a provided list of selection strings.

```csharp
public static void StartPlayback(List<string> selections)
```

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

### SpectatorCamera Start Method

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.UI.Spectator.SpectatorCamera.html

The Start method for the SpectatorCamera class, called when the script instance is being loaded.

```csharp
protected virtual void Start()
```

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

### Handle process started event

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.RestrictiveEnvironment.StepLockHandlingStrategy.html

Virtual method triggered when a process starts.

```csharp
public virtual void OnProcessStarted(IProcess process)
```

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

### Scene Object Automatic Setup

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.SceneObjects.SceneObjectExtensions.html

Performs automatic setup for a scene object based on a specified type. Editor types can be excluded.

```csharp
public static void SceneObjectAutomaticSetup(GameObject selectedSceneObject, Type valueType, bool excludeEditor = true)
```

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

### ProcessSceneObject Guids Property

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.SceneObjects.ProcessSceneObject.html

Gets an enumerable collection of all GUIDs associated with the ProcessSceneObject.

```csharp
public IEnumerable<Guid> Guids { get; }
```

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

### VRBuilder.Core.Setup Namespace Overview

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.Setup.html

Documentation for the classes and interfaces defined within the VRBuilder.Core.Setup namespace.

```APIDOC
## VRBuilder.Core.Setup Namespace

### Classes
- **LayerSet**: A class responsible for managing sets of layers within the VR Builder environment.

### Interfaces
- **ILayerConfigurator**: An interface defining the contract for components that configure layers.
```

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

### ProcessSceneObject Guid Property

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.SceneObjects.ProcessSceneObject.html

Gets the primary unique identifier (Guid) of the ProcessSceneObject.

```csharp
public Guid Guid { get; }
```

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

### XRISceneSetupConfiguration Implements

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.XRInteraction.Editor.Setup.XRISceneSetupConfiguration.html

Lists the interfaces implemented by the XRISceneSetupConfiguration class.

```APIDOC
### Implements
ISceneSetupConfiguration
```

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

### C# GuidBasedSceneObjectRegistry Item Property by Guid

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.SceneObjects.GuidBasedSceneObjectRegistry.html

Gets the ISceneObject associated with the specified GUID.

```csharp
public ISceneObject this[Guid guid] { get; }
```

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

### StartHighlighting Methods

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.Highlighting.DefaultHighlighter.html

Methods to initiate highlighting using different parameters.

```csharp
public string StartHighlighting(Color highlightColor, string highlightID)
```

```csharp
public override void StartHighlighting(Material highlightMaterial)
```

```csharp
public string StartHighlighting(Material highlightMaterial, string highlightID)
```

```csharp
public string StartHighlighting(Texture highlightTexture, string highlightID)
```

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

### Get SceneObjectGroup GUID

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.Settings.SceneObjectGroups.SceneObjectGroup.html

Retrieves the unique identifier (Guid) of the SceneObjectGroup. This property is read-only and assigned upon creation.

```csharp
public Guid Guid { get; }
```

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

### Setup Method

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Netcode.VoiceChat.Dissonance.DissonanceVoiceChatService.html

Initializes or sets up the Dissonance voice chat service. This method should typically be called before other operations.

```csharp
public void Setup()
```

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

### C# GuidBasedSceneObjectRegistry RegisteredGuids Property

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.SceneObjects.GuidBasedSceneObjectRegistry.html

Gets an enumerable collection of all registered GUIDs.

```csharp
public IEnumerable<Guid> RegisteredGuids { get; }
```

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

### AutoStartProcess Property

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Netcode.ProcessController.NetcodeProcessLoader.html

Property to get or set whether the process should start automatically.

```csharp
public bool AutoStartProcess { get; set; }
```

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

### SetupFinished Event Declaration

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.Editor.UI.Wizard.ProjectSetupWizard.html

Event triggered when the project setup process has finished.

```csharp
public static event EventHandler<EventArgs> SetupFinished
```

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

### Get Compatible Ports

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.Editor.UI.GraphView.ProcessGraphView.html

Retrieves a list of ports compatible with the specified start port.

```csharp
public override List<Port> GetCompatiblePorts(Port startPort, NodeAdapter nodeAdapter)
```

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

### SceneSetup SetupPrefab Method

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.Editor.Setup.SceneSetup.html

Sets up a prefab in the scene, optionally assigning it a parent. Returns the created GameObject. This is a protected method.

```csharp
protected GameObject SetupPrefab(string prefab, string parentPath)
```

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

### XRSimulatorSetup Class Reference

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.XRInteraction.Rigs.XRSimulatorSetup.html

Details regarding the XRSimulatorSetup class, its properties, and methods.

```APIDOC
## Class XRSimulatorSetup

### Description
Provides setup functionality for the XR simulator rig. Inherits from XRSetupBase.

### Namespace
VRBuilder.XRInteraction.Rigs

### Properties
- **Name** (string) - The name of the rig provider.
- **PrefabName** (string) - The name of the prefab associated with the simulator.

### Methods
- **CanBeUsed()** (bool) - Determines if the simulator setup can be used in the current context.
- **GetSetupTooltip()** (string) - Returns a tooltip description for the setup.
```

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

### SceneSetup Priority Property

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.Editor.Setup.SceneSetup.html

Gets the priority of the scene setup. This property is virtual and can be overridden.

```csharp
public virtual int Priority { get; }
```

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

### OpenSampleSceneSafely Method

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.Editor.Setup.SampleImportPostprocessingUtility.html

Safely opens a sample scene. Requires the demo scene name and the sample root path.

```csharp
public static void OpenSampleSceneSafely(string demoSceneName, string sampleRootPath)
```

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

### SceneSetup Key Property

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.Editor.Setup.SceneSetup.html

Gets a unique key identifier for the scene setup. This property is virtual and can be overridden.

```csharp
public virtual string Key { get; }
```

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

### ProjectSetupWizard Class Syntax

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.Editor.UI.Wizard.ProjectSetupWizard.html

Defines the static class structure for the project setup wizard.

```csharp
public static class ProjectSetupWizard
```

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

### systemGestureStarted Event

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/UnityEngine.XR.Interaction.Toolkit.Samples.Hands.MetaSystemGestureDetector.html

Gets or sets the UnityEvent triggered when a system gesture starts. This is useful for initiating actions when a gesture begins.

```csharp
public UnityEvent systemGestureStarted { get; set; }
```

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

### Get Unique ID from ISceneObjectProperty - C#

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.Utils.ProcessReferenceUtils.html

Use this method to retrieve a unique Guid from an ISceneObjectProperty. Ensure the property is valid before calling.

```csharp
public static Guid GetUniqueIdFrom(ISceneObjectProperty property)
```

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

### XRISceneSetupConfiguration Class Overview

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.XRInteraction.Editor.Setup.XRISceneSetupConfiguration.html

Provides an overview of the XRISceneSetupConfiguration abstract class, including its namespace, assembly, and inheritance hierarchy.

```APIDOC
## Class XRISceneSetupConfiguration 

##### Inheritance
System.Object
XRISceneSetupConfiguration
NetcodeSceneSetupConfiguration
DefaultSceneSetupConfiguration

##### Implements
ISceneSetupConfiguration

##### Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()

###### **Namespace** : VRBuilder.XRInteraction.Editor.Setup
###### **Assembly** : VRBuilder.XRInteraction.Editor.dll

##### Syntax
```csharp
public abstract class XRISceneSetupConfiguration : ISceneSetupConfiguration
```
```

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

### Get Core Folder Path

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.Editor.EditorUtils.html

Retrieves the path to the core folder of the VR Builder installation. This method is static and returns a string.

```csharp
public static string GetCoreFolder()
```

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

### OpenSampleScene Method

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.Editor.Setup.SampleImportPostprocessingUtility.html

Opens a sample scene. Requires the demo scene name and the prefix for sample roots.

```csharp
public static void OpenSampleScene(string demoSceneName, string samplesRootPrefix)
```

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

### Get NoRigSetup Name

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.BasicInteraction.RigSetup.NoRigSetup.html

This C# code defines the Name property for the NoRigSetup class. It returns the name of the rig setup, which is an empty string for NoRigSetup.

```csharp
public override string Name { get; }
```

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

### ILifeCycle Activate Method

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.ILifeCycle.html

Activates the component, starting its lifecycle process.

```csharp
void Activate()
```

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

### Define XRSetupBase class

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.XRInteraction.Rigs.XRSetupBase.html

The abstract base class for XR setup providers.

```csharp
public abstract class XRSetupBase : InteractionRigProvider
```

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

### InstantProcess Start Method

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.InstantProcess-1.html

Abstract method that must be implemented by derived classes. This method is called when the process begins.

```csharp
public abstract override void Start()
```

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

### Get Unique ID from ISceneObject - C#

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.Utils.ProcessReferenceUtils.html

This method returns a unique Guid for a given ISceneObject. It's useful for uniquely identifying scene objects in VR Builder.

```csharp
public static Guid GetUniqueIdFrom(ISceneObject sceneObject)
```

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

### StartHighlighting Method

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.Highlighting.IHighlighter.html

Initiates the highlighting process with a specified material. This method requires a valid Material object.

```csharp
void StartHighlighting(Material highlightMaterial)
```

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

### Get NoRigSetup Prefab Name

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.BasicInteraction.RigSetup.NoRigSetup.html

This C# code defines the PrefabName property for the NoRigSetup class. It returns the name of the prefab associated with the rig setup, which is an empty string for NoRigSetup.

```csharp
public override string PrefabName { get; }
```

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

### MultipleSceneReference Constructor with GUIDs

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.SceneObjects.MultipleSceneReference-1.html

Initializes a new instance of the MultipleSceneReference class with a collection of GUIDs. Ensure the provided IEnumerable<Guid> is valid.

```csharp
public MultipleSceneReference(IEnumerable<Guid> guids)
```

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

### ProcessSceneObject guids Field

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.SceneObjects.ProcessSceneObject.html

A list of serializable GUIDs associated with the ProcessSceneObject.

```csharp
protected List<SerializableGuid> guids
```

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

### VRBuilder.XRInteraction.Editor.Setup Namespace Overview

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.XRInteraction.Editor.Setup.html

This section provides an overview of the classes available within the VRBuilder.XRInteraction.Editor.Setup namespace.

```APIDOC
## Namespace VRBuilder.XRInteraction.Editor.Setup

### Classes

This namespace contains classes for configuring XR interactions and scene setups within the VR Builder editor.

#### DefaultSceneSetupConfiguration

Represents the default configuration for setting up XR scenes.

#### EnableOpenXRHandSettings

Manages settings related to enabling OpenXR hand tracking.

#### XRISceneSetupConfiguration

Provides configuration options for setting up XR scenes.
```

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

### Guids Property

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.SceneObjects.ProcessSceneReferenceBase.html

Access the read-only list of GUIDs associated with the reference.

```csharp
public IReadOnlyList<Guid> Guids { get; }
```

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

### RigLoaderSceneSetup Properties

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.BasicInteraction.Editor.Setup.RigLoaderSceneSetup.html

Properties for accessing the key and priority of the scene setup.

```csharp
public override string Key { get; }
```

```csharp
public override int Priority { get; }
```

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

### IGuidContainer Guids Property

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.SceneObjects.IGuidContainer.html

Retrieves the collection of GUIDs associated with the container.

```csharp
IEnumerable<Guid> Guids { get; }
```

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

### XRISceneSetupConfiguration Methods

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.XRInteraction.Editor.Setup.XRISceneSetupConfiguration.html

Details the methods available in the XRISceneSetupConfiguration class.

```APIDOC
### Methods 

#### GetSetupNames()
##### Declaration
```csharp
public abstract IEnumerable<string> GetSetupNames()
```

##### Returns
Type | Description  
---|---
System.Collections.Generic.IEnumerable<System.String> |   
```

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

### ISceneObject Guid Property

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.SceneObjects.ISceneObject.html

The Guid property returns the unique identifier for the ISceneObject.

```csharp
Guid Guid { get; }
```

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

### SetupFinished Event

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.Editor.UI.Wizard.ProjectSetupWizard.html

Details of the SetupFinished event within the ProjectSetupWizard class.

```APIDOC
### Events 

#### SetupFinished

##### Declaration
```csharp
public static event EventHandler<EventArgs> SetupFinished
```

##### Event Type
Type | Description  
---|---
System.EventHandler<System.EventArgs> |   
```

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

### RigLoaderSceneSetup Class Reference

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.BasicInteraction.Editor.Setup.RigLoaderSceneSetup.html

Details regarding the RigLoaderSceneSetup class, its properties, and methods.

```APIDOC
## Class RigLoaderSceneSetup

### Description
Represents a scene setup component for loading rigs. This class is marked as obsolete and will be removed in VR Builder 6.0.

### Namespace
VRBuilder.BasicInteraction.Editor.Setup

### Assembly
VRBuilder.BasicInteraction.Editor.dll

### Properties
- **Key** (string) - Gets the unique key for the scene setup.
- **Priority** (int) - Gets the priority level of the scene setup.

### Methods
#### Setup(ISceneSetupConfiguration configuration)
- **configuration** (ISceneSetupConfiguration) - The configuration object used to set up the scene.
```

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

### IProcessController Methods

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.ProcessController.IProcessController.html

Methods for retrieving the controller prefab, required components, and handling post-setup logic.

```csharp
GameObject GetProcessControllerPrefab()
```

```csharp
List<Type> GetRequiredSetupComponents()
```

```csharp
void HandlePostSetup(GameObject processControllerObject)
```

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

### ProcessSceneObject AddGuid Method

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.SceneObjects.ProcessSceneObject.html

Adds a new GUID to the list of associated GUIDs for this ProcessSceneObject.

```csharp
public void AddGuid(Guid guid)
```

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

### Constructors for MultipleScenePropertyReference<T>

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.SceneObjects.MultipleScenePropertyReference-1.html

Constructors for initializing the reference with no arguments, a collection of GUIDs, or a single GUID.

```csharp
public MultipleScenePropertyReference()
```

```csharp
public MultipleScenePropertyReference(IEnumerable<Guid> guids)
```

```csharp
public MultipleScenePropertyReference(Guid guid)
```

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

### Initialize Method

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.XRInteraction.Properties.HighlightProperty.html

Initializes the HighlightProperty. This is a protected method.

```csharp
protected void Initialize()
```

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

### Chapter Constructor (Public)

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.Chapter.html

Initializes a new Chapter with a given name and a starting step. Requires a name and an IStep object.

```csharp
public Chapter(string name, IStep firstStep)
```

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

### GuidBasedSceneObjectRegistry Properties

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.SceneObjects.GuidBasedSceneObjectRegistry.html

Provides access to scene objects by their GUID or name, and retrieves all registered GUIDs.

```APIDOC
## Item[Guid]

### Description
Gets the scene object associated with the specified GUID.

### Method
Property Accessor

### Parameters
#### Path Parameters
- **guid** (System.Guid) - The GUID of the scene object to retrieve.

### Property Value
Type | Description  
---|---
ISceneObject | The scene object with the specified GUID.
```

```APIDOC
## Item[String]

### Description
Gets the scene object associated with the specified name.

### Method
Property Accessor

### Parameters
#### Path Parameters
- **name** (System.String) - The name of the scene object to retrieve.

### Property Value
Type | Description  
---|---
ISceneObject | The scene object with the specified name.
```

```APIDOC
## RegisteredGuids

### Description
Gets an enumerable collection of all registered GUIDs in the registry.

### Method
Property Accessor

### Property Value
Type | Description  
---|---
System.Collections.Generic.IEnumerable<System.Guid> | An enumerable collection of GUIDs.
```

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

### InitiateImportPostprocessing Method

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.Editor.Setup.SampleImportPostprocessingUtility.html

Initiates the postprocessing for sample imports. Requires paths for the sample root, process file, package root, and destination, along with the sample name, demo scene name, and an action to fix validation issues.

```csharp
public static void InitiateImportPostprocessing(string sampleRootPath, string sampleName, string processFileName, string demoSceneName, string packageProcessRoot, string packageProcessDestination, Action fixValidationIssues)
```

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

### SceneSetup Class Methods

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.Editor.Setup.SceneSetup.html

Overview of the methods available in the SceneSetup class for managing scene prefabs and configuration.

```APIDOC
## Method FindPrefab(string)

### Description
Finds a specific prefab within the current scene context.

### Parameters
#### Path Parameters
- **prefab** (string) - Required - The name or identifier of the prefab to locate.

### Response
- **GameObject** - The found GameObject or null if not found.

## Method IsPrefabMissingInScene(string)

### Description
Checks if a required prefab is missing from the current scene.

### Parameters
#### Path Parameters
- **prefabName** (string) - Required - The name of the prefab to check.

### Response
- **bool** - True if the prefab is missing, false otherwise.

## Method SetPrefabParent(GameObject, string)

### Description
Sets the parent of a given GameObject based on a provided path.

### Parameters
#### Path Parameters
- **prefab** (GameObject) - Required - The GameObject to reparent.
- **parentPath** (string) - Required - The path to the target parent object.

## Method Setup(ISceneSetupConfiguration)

### Description
Abstract method to perform the scene setup based on the provided configuration.

### Parameters
#### Path Parameters
- **configuration** (ISceneSetupConfiguration) - Required - The configuration object for the setup process.

## Method SetupPrefab(string, string)

### Description
Initializes and sets up a prefab in the scene under a specific parent path.

### Parameters
#### Path Parameters
- **prefab** (string) - Required - The name of the prefab to setup.
- **parentPath** (string) - Required - The path to the parent object.

### Response
- **GameObject** - The initialized GameObject.
```

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

### SetAnimatorFloatParameterBehavior Constructor with Guid

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Pro.Behaviors.SetAnimatorFloatParameterBehavior.html

Initializes a new instance of the SetAnimatorFloatParameterBehavior class using a Guid for the animator property.

```csharp
public SetAnimatorFloatParameterBehavior(Guid animatorPropertyGuid, string parameterName, float targetValue, float duration, AnimationCurve animationCurve)
```

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

### StartTracking Method

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Pro.Utils.ObjectPointer.html

Abstract method to begin tracking a target transform. Must be implemented by derived classes.

```csharp
public abstract void StartTracking(Transform target)
```

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

### Constructors for SingleSceneReference<T>

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.SceneObjects.SingleSceneReference-1.html

Initializes a new instance of the class using default, GUID collection, or single GUID parameters.

```csharp
public SingleSceneReference()
```

```csharp
public SingleSceneReference(IEnumerable<Guid> guids)
```

```csharp
public SingleSceneReference(Guid guid)
```

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

### Initialize Method

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Pro.Components.ScoreFeedback.FloatingTextMesh.html

Initializes the text component with the specified string.

```csharp
public void Initialize(string text)
```

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

### InitializeAudioClip Method

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.TextToSpeech.TextToSpeechAudio.html

Initializes the AudioClip for the TextToSpeechAudio instance. This method likely triggers the text-to-speech conversion process.

```csharp
public void InitializeAudioClip()
```

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

### CheckStateCondition Constructor with Guid

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Pro.Conditions.CheckStateCondition.html

Initializes a new instance of CheckStateCondition using a Guid for the data property, a comparison value, and an operation command.

```csharp
public CheckStateCondition(Guid dataProperty, int compareValue, IOperationCommand<int, bool> operation)
```

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

### Undo Scene Object Automatic Setup

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.SceneObjects.SceneObjectExtensions.html

Reverts the automatic setup performed on a scene object. Returns a boolean indicating success.

```csharp
public static bool UndoSceneObjectAutomaticSetup(GameObject selectedSceneObject, Type valueType, Component[] alreadyAttachedProperties)
```

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

### ComponentSettingsSection OnGUI Method

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.Editor.UI.ProjectSettings.ComponentSettingsSection-2.html

Renders the settings section UI based on the provided search context.

```csharp
public void OnGUI(string searchContext)
```

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

### Constructor for XRSetupBase

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.XRInteraction.Rigs.XRSetupBase.html

Initializes a new instance of the XRSetupBase class.

```csharp
public XRSetupBase()
```

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

### Class XRLegacySetup

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.XRInteraction.Rigs.XRLegacySetup.html

Details regarding the XRLegacySetup class, its properties, and methods.

```APIDOC
## Class XRLegacySetup

### Description
Represents a legacy XR setup provider for VR Builder interaction rigs.

### Namespace
VRBuilder.XRInteraction.Rigs

### Assembly
VRBuilder.XRInteraction.dll

### Syntax
public class XRLegacySetup : XRSetupBase

### Properties
- **Name** (string) - The name of the setup provider.
- **PrefabName** (string) - The name of the associated prefab.

### Methods
- **CanBeUsed()** (bool) - Determines if the setup can be used in the current context.
- **GetSetupTooltip()** (string) - Returns the tooltip text for the setup.
```

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

### ProcessSceneObject RemoveGuid Method

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.SceneObjects.ProcessSceneObject.html

Removes a specified GUID from the ProcessSceneObject's list of associated GUIDs. Returns true if successful, false otherwise.

```csharp
public bool RemoveGuid(Guid guid)
```

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

### ProcessControllerSetup Methods

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.ProcessController.ProcessControllerSetup.html

API methods for managing the ProcessController configuration.

```APIDOC
## ResetToDefault

### Description
Resets the current process controller to its default state.

### Method
public void

## SetEnforcedProcessController

### Description
Sets a specific IProcessController to be enforced.

### Parameters
- **processController** (IProcessController) - Required - The controller instance to enforce.

## SetProcessControllerQualifiedName

### Description
Sets the process controller using its fully qualified type name.

### Parameters
- **processControllerQualifiedName** (string) - Required - The qualified name of the process controller.
```

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

### SetRandomBooleanBehavior Constructor (Guid, Probability)

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Pro.Behaviors.SetRandomBooleanBehavior.html

Initializes SetRandomBooleanBehavior with a property GUID and a probability for the boolean to be true. The true probability defaults to 0.5 if not specified.

```csharp
public SetRandomBooleanBehavior(Guid propertyGuid, float trueProbability = 0.5F)
```

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

### InitializeUser Method

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Netcode.VoiceChat.VoiceUserInfo.html

Initializes the user instance for the voice chat component.

```csharp
public void InitializeUser(IVoiceChatUser user)
```

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

### MultipleSceneObjectReference Constructor (Guid)

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.SceneObjects.MultipleSceneObjectReference.html

Initializes a new instance of the MultipleSceneObjectReference class with a single GUID representing a scene object. Use this for a single reference.

```csharp
public MultipleSceneObjectReference(Guid guid)
```

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

### EmitTouched Method

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.XRInteraction.Properties.TouchableProperty.html

Protected method to internally emit the touch started event.

```csharp
protected void EmitTouched()
```

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

### Guid Property Declaration

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.SceneObjects.GuidContainerEventArgs.html

Declares the public readonly Guid property of the GuidContainerEventArgs class. This property holds the unique identifier associated with the event.

```csharp
public readonly Guid Guid
```

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

### NetcodeSceneSetupConfiguration Class Overview

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Netcode.Editor.NetcodeSceneSetupConfiguration.html

Provides an overview of the NetcodeSceneSetupConfiguration class, including its inheritance hierarchy and namespace.

```APIDOC
## Class NetcodeSceneSetupConfiguration 

### Inheritance
System.Object
XRISceneSetupConfiguration
NetcodeSceneSetupConfiguration

### Implements
ISceneSetupConfiguration

### Namespace
VRBuilder.Netcode.Editor

### Assembly
VRBuilder.Netcode.Editor.dll

### Syntax
```csharp
public class NetcodeSceneSetupConfiguration : XRISceneSetupConfiguration, ISceneSetupConfiguration
```
```

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

### SetValueBehavior(Guid, T) Constructor

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.Behaviors.SetValueBehavior-1.html

Initializes a new instance of SetValueBehavior with a specified property ID and value. Requires a Guid for the property and the value to set.

```csharp
public SetValueBehavior(Guid propertyId, T value)
```

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

### ProjectSetupWizard Class

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.Editor.UI.Wizard.ProjectSetupWizard.html

Information about the ProjectSetupWizard class, its namespace, assembly, and syntax.

```APIDOC
## Class ProjectSetupWizard 

##### Inheritance
System.Object
ProjectSetupWizard

##### Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()

###### **Namespace** : VRBuilder.Core.Editor.UI.Wizard
###### **Assembly** : VRBuilder.Core.Editor.dll

##### Syntax
```csharp
public static class ProjectSetupWizard
```
```

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

### IStepNodeInstantiator Methods

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.Editor.UI.GraphView.Instantiators.IStepNodeInstantiator.html

Methods for managing context menu status and node instantiation.

```csharp
DropdownMenuAction.Status GetContextMenuStatus(IEventHandler target, IChapter currentChapter)
```

```csharp
ProcessGraphNode InstantiateNode(IStep step)
```

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

### StopTimerBehavior Constructor with Guid

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Pro.Behaviors.StopTimerBehavior.html

Initializes a new instance of the StopTimerBehavior class using a specified GUID. This constructor takes a single parameter of type System.Guid.

```csharp
public StopTimerBehavior(Guid propertyGuid)
```

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

### ResourceAudio Methods

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.Utils.Audio.ResourceAudio.html

Methods for retrieving localized content, initializing the audio clip, and checking if the object is empty.

```csharp
public string GetLocalizedContent()
```

```csharp
public void InitializeAudioClip()
```

```csharp
public bool IsEmpty()
```

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

### StartTimerBehavior Constructor with Guid and Boolean

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Pro.Behaviors.StartTimerBehavior.html

Initializes a new instance of the StartTimerBehavior class using a Guid and a boolean flag to indicate if it's a countdown timer.

```csharp
public StartTimerBehavior(Guid propertyGuid, bool isCountdown)
```

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

### MultipleSceneReference Constructor with Single GUID

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.SceneObjects.MultipleSceneReference-1.html

Initializes a new instance of the MultipleSceneReference class with a single GUID. This is a convenient overload for referencing a single scene object.

```csharp
public MultipleSceneReference(Guid guid)
```

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

### StartDedicatedServer Method

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Netcode.VoiceChat.Dissonance.DissonanceVoiceChatService.html

Starts a dedicated server for voice chat on a specified channel. This is used when the application acts as a server rather than a client.

```csharp
public void StartDedicatedServer(string channelName)
```

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

### MultipleSceneObjectReference Constructor (IEnumerable<Guid>)

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.SceneObjects.MultipleSceneObjectReference.html

Initializes a new instance of the MultipleSceneObjectReference class with a collection of GUIDs representing scene objects. Use this constructor to pre-populate references.

```csharp
public MultipleSceneObjectReference(IEnumerable<Guid> guids)
```

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

### DesktopProcessMenu Constructor

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Pro.ProcessMenu.DesktopProcessMenu.html

Initializes a new instance of the DesktopProcessMenu class.

```csharp
public DesktopProcessMenu()
```

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

### ObjectInColliderCondition Constructor with Guid Parameters

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.Conditions.ObjectInColliderCondition.html

Initializes a new instance of the ObjectInColliderCondition class with target position and object GUIDs, and optional required time and object count.

```csharp
public ObjectInColliderCondition(Guid targetPosition, Guid targetObject, float requiredTimeInTarget = 0F, float objectsRequiredInTrigger = 1F)
```

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

### DesktopProcessMenu Class Overview

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Pro.ProcessMenu.DesktopProcessMenu.html

Provides an overview of the DesktopProcessMenu class, its inheritance, namespace, and syntax.

```APIDOC
## Class DesktopProcessMenu

### Inheritance
System.Object
BaseProcessControllerMenu
DesktopProcessMenu

### Namespace
VRBuilder.Pro.ProcessMenu

### Assembly
VRBuilder.Pro.dll

### Syntax
```csharp
public class DesktopProcessMenu : BaseProcessControllerMenu
```
```

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

### MoveObjectBehavior Constructor with GUIDs and Duration

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.Behaviors.MoveObjectBehavior.html

Initializes a new instance of the MoveObjectBehavior class using target object and final position GUIDs, along with a specified duration for the movement.

```csharp
public MoveObjectBehavior(Guid targetObjectId, Guid finalPositionId, float duration)
```

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

### ChildExplosionViewBehavior Constructor with Target GUID

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Pro.Behaviors.ChildExplosionViewBehavior.html

Initializes a new instance of the ChildExplosionViewBehavior class with a target entity specified by its GUID. This constructor allows for precise targeting of an entity for the explosion effect.

```csharp
public ChildExplosionViewBehavior(Guid targetGuid, float scale, float duration, AnimationCurve explosionCurve, bool pingPong = false, int repeats = 1)
```

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

### StartTimerMenuItem Constructor

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Pro.Editor.UI.MenuItems.Behaviors.StartTimerMenuItem.html

Initializes a new instance of the StartTimerMenuItem class. This is the default constructor.

```csharp
public StartTimerMenuItem()
```

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

### RigLoaderSceneSetup Constructor

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.BasicInteraction.Editor.Setup.RigLoaderSceneSetup.html

Constructor for the RigLoaderSceneSetup class.

```csharp
public RigLoaderSceneSetup()
```

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

### Instantiate SceneObjectGroup with Label and GUID

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.Settings.SceneObjectGroups.SceneObjectGroup.html

Constructs a new SceneObjectGroup instance, requiring both a string label and a Guid. This overload allows for explicit control over the group's unique identifier.

```csharp
public SceneObjectGroup(string label, Guid guid)
```

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

### AnimateTransformBehavior Constructor with Guids

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Pro.Behaviors.AnimateTransformBehavior.html

Use this constructor when you have the GUIDs of the target object and the transform provider. Specifies duration, animation curves for position, rotation, and scale, and optional ping-pong and repeat settings.

```csharp
public AnimateTransformBehavior(Guid targetGuid, Guid transformProviderGuid, float duration, AnimationCurve positionCurve, AnimationCurve rotationCurve, AnimationCurve scaleCurve, bool pingPong = false, int repeats = 1)
```

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

### NetcodeSceneSetupConfiguration Methods

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Netcode.Editor.NetcodeSceneSetupConfiguration.html

Details the methods available in the NetcodeSceneSetupConfiguration class.

```APIDOC
## Methods

### GetSetupNames()

- **Declaration:** `public override IEnumerable<string> GetSetupNames()`
- **Returns:** `System.Collections.Generic.IEnumerable<System.String>` - Description not specified.
- **Overrides:** `XRISceneSetupConfiguration.GetSetupNames()`
```

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

### SetAnimatorBoolParameterBehavior Constructor (Guid, String, Boolean)

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Pro.Behaviors.SetAnimatorBoolParameterBehavior.html

Initializes a new instance of the SetAnimatorBoolParameterBehavior class using a GUID for the animator property, a parameter name, and a boolean value. This is useful when the animator property is referenced by its unique identifier.

```csharp
public SetAnimatorBoolParameterBehavior(Guid animatorPropertyGuid, string parameterName, bool parameterValue)
```

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

### GetSetupNames Method

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Netcode.Editor.NetcodeSceneSetupConfiguration.html

Overrides the GetSetupNames method from the base class. It returns an enumerable collection of setup names available for this configuration.

```csharp
public override IEnumerable<string> GetSetupNames()
```

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

### OnProcessStarted Method

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.RestrictiveEnvironment.DefaultStepLockHandling.html

Handles logic when a process has started.

```csharp
public override void OnProcessStarted(IProcess process)
```

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

### Class: PlayAnimationClipBehavior.ActivatingProcess

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Pro.Behaviors.PlayAnimationClipBehavior.ActivatingProcess.html

Details regarding the ActivatingProcess class, its constructor, and lifecycle methods.

```APIDOC
## Class: PlayAnimationClipBehavior.ActivatingProcess

### Description
Represents the activation process for a PlayAnimationClipBehavior, inheriting from StageProcess and implementing IStageProcess.

### Namespace
VRBuilder.Pro.Behaviors

### Assembly
VRBuilder.Pro.dll

### Constructor
#### ActivatingProcess(PlayAnimationClipBehavior.EntityData data)
- **data** (PlayAnimationClipBehavior.EntityData) - The entity data associated with the behavior.

### Methods
- **End()**: Finalizes the process.
- **FastForward()**: Skips the process to completion.
- **Start()**: Initializes the process.
- **Update()**: Returns an IEnumerator to handle the process update loop.
```

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

### InteractionFrameworkSceneSetup Class

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.BasicInteraction.Editor.Setup.InteractionFrameworkSceneSetup.html

Details regarding the InteractionFrameworkSceneSetup class, its properties, and methods.

```APIDOC
## Class InteractionFrameworkSceneSetup

### Description
An abstract class that provides functionality for setting up scenes in the VR Builder interaction framework.

### Namespace
VRBuilder.BasicInteraction.Editor.Setup

### Assembly
VRBuilder.BasicInteraction.Editor.dll

### Syntax
public abstract class InteractionFrameworkSceneSetup : SceneSetup

### Properties
- **Key** (string) - The unique identifier for the scene setup.
- **Priority** (int) - The priority level of the scene setup.

### Methods
- **RemoveMainCamera()** - Protected method to remove the main camera from the scene.
```

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

### StartEditingProcess Method

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.Editor.GlobalEditorHandler.html

Initiates the process of editing a process. Call this to begin modifying a process.

```csharp
public static void StartEditingProcess()
```

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

### UserName Property

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Netcode.User.CommandLineUserNameProvider.html

Gets the current user name.

```csharp
public string UserName { get; }
```

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

### GetDisplayName

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.Editor.EditorReflectionUtils.html

Gets the display name for a given MemberInfo.

```APIDOC
## GetDisplayName(MemberInfo)

### Description
Retrieves a user-friendly display name for a given MemberInfo, often used in editor UIs.

### Method
`public static string GetDisplayName(this MemberInfo memberInfo)`

### Parameters
#### Path Parameters
- **memberInfo** (System.Reflection.MemberInfo) - The member for which to get the display name.

### Returns
- **System.String** - The display name of the member.
```

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

### CreateAudioClipFromMp3 Method

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.TextToSpeech.IAudioConverter.html

Converts raw MP3 byte data into a Unity AudioClip.

```csharp
AudioClip CreateAudioClipFromMp3(byte[] data)
```

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

### InstantiatePrefab Method

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Netcode.Configuration.MultiUserSceneObjectManager.html

Instantiates a network prefab at a specific position and rotation with an optional callback.

```csharp
public void InstantiatePrefab(GameObject prefab, Vector3 position, Quaternion rotation, Action<GameObject> onPrefabInstantiated = null)
```

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

### Mode Name Property

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.Configuration.Modes.Mode.html

Gets the name of the Mode.

```csharp
public string Name { get; }
```

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

### ProcessSceneObject guid Field

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.SceneObjects.ProcessSceneObject.html

Represents the unique identifier for the ProcessSceneObject.

```csharp
protected Guid guid
```

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

### Instantiate FileTextToSpeechConfiguration

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.TextToSpeech.Configuration.FileTextToSpeechConfiguration.html

This is the default constructor for the FileTextToSpeechConfiguration class. No specific setup is required before instantiation.

```csharp
public FileTextToSpeechConfiguration()
```

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

### Timer Control Methods

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Pro.Properties.ITimerProperty.html

Methods to start and stop the timer.

```csharp
void StartTimer()
```

```csharp
void StopTimer()
```

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

### PlayVideoBehaviorMenuItem Constructor

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Pro.Editor.UI.MenuItems.Behaviors.PlayVideoBehaviorMenuItem.html

Constructor for initializing a new instance of the PlayVideoBehaviorMenuItem class.

```csharp
public PlayVideoBehaviorMenuItem()
```

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

### Check IsReady Property

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.Utils.Audio.IAudioData.html

Indicates whether the audio data is fully loaded and ready for use.

```csharp
bool IsReady { get; }
```

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

### Play Method

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Pro.Properties.AnimationProperty.html

Starts or resumes playback of the assigned animation.

```csharp
public void Play()
```

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

### Activate Methods

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.Utils.ParticleMachines.IParticleMachine.html

Methods to start particle emission, with an optional overload for specifying radius and duration.

```csharp
void Activate()
```

```csharp
void Activate(float radius, float duration)
```

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

### Animation Property

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Pro.Properties.AnimationProperty.html

Gets the UnityEngine.Animation component associated with this property.

```csharp
public Animation Animation { get; }
```

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

### ProcessSceneObject GameObject Property

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.SceneObjects.ProcessSceneObject.html

Gets the associated GameObject for the ProcessSceneObject.

```csharp
public GameObject GameObject { get; }
```

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

### ProcessControllerSceneSetup Class

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.Editor.Setup.ProcessControllerSceneSetup.html

Details about the ProcessControllerSceneSetup class, including its inheritance, namespace, assembly, syntax, constructors, properties, and methods.

```APIDOC
## Class ProcessControllerSceneSetup

### Inheritance
System.Object
SceneSetup
ProcessControllerSceneSetup

### Inherited Members
SceneSetup.SetupPrefab(String, String)
SceneSetup.SetPrefabParent(GameObject, String)
SceneSetup.FindPrefab(String)
SceneSetup.IsPrefabMissingInScene(String)
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()

### Namespace
VRBuilder.Core.Editor.Setup

### Assembly
VRBuilder.Core.Editor.dll

### Syntax
```csharp
public class ProcessControllerSceneSetup : SceneSetup
```

### Constructors
#### ProcessControllerSceneSetup()
##### Declaration
```csharp
public ProcessControllerSceneSetup()
```

### Properties
#### Key
##### Declaration
```csharp
public override string Key { get; }
```

##### Property Value
Type | Description  
---|---
System.String |
##### Overrides
SceneSetup.Key

#### Priority
##### Declaration
```csharp
public override int Priority { get; }
```

##### Property Value
Type | Description  
---|---
System.Int32 |
##### Overrides
SceneSetup.Priority

### Methods
#### Setup(ISceneSetupConfiguration)
##### Declaration
```csharp
public override void Setup(ISceneSetupConfiguration configuration)
```

##### Parameters
Type | Name | Description  
---|---|---
ISceneSetupConfiguration | configuration |
##### Overrides
SceneSetup.Setup(ISceneSetupConfiguration)
```

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

### VoiceUserInfo User Property

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Netcode.VoiceChat.VoiceUserInfo.html

Gets the IVoiceChatUser associated with this instance.

```csharp
public IVoiceChatUser User { get; }
```

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

### PlayAudioBehavior Constructors

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.Behaviors.PlayAudioBehavior.html

Constructors for initializing the audio behavior with data, execution stages, and optional audio sources.

```csharp
protected PlayAudioBehavior()
```

```csharp
public PlayAudioBehavior(IAudioData audioData, BehaviorExecutionStages executionStages, bool isBlocking, AudioSource audioPlayer = null)
```

```csharp
public PlayAudioBehavior(IAudioData audioData, BehaviorExecutionStages executionStages, AudioSource audioPlayer = null)
```

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

### GetVelocity Method

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.Utils.Bezier.BezierSpline.html

Gets the velocity of the curve at the specified point (t).

```csharp
public Vector3 GetVelocity(float t)
```

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

### DesktopProcessMenu Methods

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Pro.ProcessMenu.DesktopProcessMenu.html

Methods for handling process lifecycle events and menu updates.

```csharp
protected virtual void Awake()
```

```csharp
protected virtual void OnDisable()
```

```csharp
protected virtual void OnProcessFinished(object sender, ProcessEventArgs eventArgs)
```

```csharp
protected virtual void OnProcessStarted(object sender, ProcessEventArgs eventArgs)
```

```csharp
protected virtual void SetupMenu(object sender, ProcessEventArgs e)
```

```csharp
protected virtual void SubscribeToControllerEvents()
```

```csharp
protected virtual void SubscribeToProcessEvents()
```

```csharp
protected virtual void UnsubscribeFromControllerEvents()
```

```csharp
protected virtual void UnsubscribeFromProcessEvents()
```

```csharp
protected virtual void Update()
```

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

### GetControlPoint Method

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.Utils.Bezier.BezierSpline.html

Gets the control point at the specified index.

```csharp
public Vector3 GetControlPoint(int index)
```

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

### Start Particle Emission

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.Properties.IParticleSystemProperty.html

The StartEmission method initiates particle emission. Call this method to begin the particle system's effect.

```csharp
void StartEmission()
```

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

### Transition Methods

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.Transition.html

Methods for managing the lifecycle and configuration of the transition process.

```csharp
public ITransition Clone()
```

```csharp
public override IStageProcess GetAbortingProcess()
```

```csharp
public override IStageProcess GetActivatingProcess()
```

```csharp
public override IStageProcess GetActiveProcess()
```

```csharp
protected override IAutocompleter GetAutocompleter()
```

```csharp
protected override IConfigurator GetConfigurator()
```

```csharp
public override IStageProcess GetDeactivatingProcess()
```

```csharp
public IEnumerable<LockablePropertyData> GetLockableProperties()
```

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

### CurveResolution Property

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.Utils.Bezier.BezierSpline.html

Gets or sets the resolution of the Bezier curve.

```csharp
public int CurveResolution { get; set; }
```

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

### CurveCount Property

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.Utils.Bezier.BezierSpline.html

Gets the number of curves in the Bezier spline.

```csharp
public int CurveCount { get; }
```

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

### ActivatingProcess Constructor

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Pro.Behaviors.PlayAnimationClipBehavior.ActivatingProcess.html

Initializes a new instance of the ActivatingProcess class. Requires an EntityData object for configuration.

```csharp
public ActivatingProcess(PlayAnimationClipBehavior.EntityData data)
```

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

### ProcessFileName Property

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.IO.ProcessAssetManifest.html

Gets or sets the name of the process file.

```csharp
public string ProcessFileName { get; set; }
```

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

### ProcessAssetUtils Methods

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.Editor.ProcessAssets.ProcessAssetUtils.html

This section details the various static methods provided by the ProcessAssetUtils class for interacting with VR Builder process assets.

```APIDOC
## ProcessAssetUtils

This static class provides utility methods for managing VR Builder process assets.

### Methods

#### CanCreate(String, out String)

Checks if a new process asset with the given name can be created.

- **Method**: static bool
- **Parameters**:
  - **processName** (String) - The name of the process to check.
  - **errorMessage** (out String) - Output parameter to store an error message if creation is not possible.

#### CanRename(IProcess, String, out String)

Checks if an existing process asset can be renamed to the new name.

- **Method**: static bool
- **Parameters**:
  - **process** (IProcess) - The process asset to rename.
  - **newName** (String) - The desired new name for the process.
  - **errorMessage** (out String) - Output parameter to store an error message if renaming is not possible.

#### DoesAnyProcessExist()

Checks if any process assets exist in the project.

- **Method**: static bool
- **Returns**: True if at least one process asset exists, false otherwise.

#### DoesProcessAssetExist(String)

Checks if a process asset with the specified name exists.

- **Method**: static bool
- **Parameters**:
  - **processName** (String) - The name of the process asset to check.

#### GetAllProcesses()

Retrieves a collection of names of all existing process assets.

- **Method**: static IEnumerable<string>
- **Returns**: An enumerable collection of process names.

#### GetProcessAssetDirectory(String)

Gets the directory path for a given process asset.

- **Method**: static string
- **Parameters**:
  - **processName** (String) - The name of the process asset.

#### GetProcessAssetPath(String)

Gets the full file path for a given process asset.

- **Method**: static string
- **Parameters**:
  - **processName** (String) - The name of the process asset.

#### GetProcessNameFromPath(String)

Extracts the process name from a given file path.

- **Method**: static string
- **Parameters**:
  - **processPath** (String) - The full path to the process asset.

#### GetProcessStreamingAssetPath(String)

Gets the path to the streaming assets directory for a given process asset.

- **Method**: static string
- **Parameters**:
  - **processName** (String) - The name of the process asset.

#### GetProcessStreamingAssetsSubdirectory(String)

Gets the path to a subdirectory within the streaming assets for a given process asset.

- **Method**: static string
- **Parameters**:
  - **processName** (String) - The name of the process asset.

#### IsValidProcessAssetPath(String)

Checks if the provided path is a valid path for a process asset.

- **Method**: static bool
- **Parameters**:
  - **assetPath** (String) - The path to validate.
```

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

### ProcessFileName Property

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.IO.IProcessAssetManifest.html

Gets or sets the name of the process file.

```csharp
string ProcessFileName { get; set; }
```

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

### PathToSubmenu Property

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.Editor.UI.StepInspector.Menu.MenuSeparator-1.html

Gets the path to the submenu associated with this separator.

```csharp
public string PathToSubmenu { get; }
```

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

### StartParticleEmissionMenuItem Constructor

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.Editor.UI.MenuItems.Behaviors.StartParticleEmissionMenuItem.html

Constructor declaration for the class.

```csharp
public StartParticleEmissionMenuItem()
```

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

### WebTextToSpeechProvider Constructors

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.Editor.TextToSpeech.Providers.WebTextToSpeechProvider.html

Initializes a new instance of the provider with optional web request and audio converter dependencies.

```csharp
protected WebTextToSpeechProvider()
```

```csharp
protected WebTextToSpeechProvider(UnityWebRequest unityWebRequest)
```

```csharp
protected WebTextToSpeechProvider(UnityWebRequest unityWebRequest, IAudioConverter audioConverter)
```

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

### EndChapterNode Behavior Property

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.Editor.UI.GraphView.Nodes.EndChapterNode.html

Gets the GoToChapterBehavior associated with this node.

```csharp
protected GoToChapterBehavior Behavior { get; }
```

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

### ValueDeclaredType Property

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.Editor.MetadataWrapper.html

Gets or sets the declared type of the value.

```csharp
public Type ValueDeclaredType { get; set; }
```

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

### ActivatingProcess Constructor

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Pro.Behaviors.PlayVideoBehavior.ActivatingProcess.html

Documentation for the public constructor of the ActivatingProcess class.

```APIDOC
## Constructors

### ActivatingProcess(PlayVideoBehavior.EntityData)

#### Declaration
```csharp
public ActivatingProcess(PlayVideoBehavior.EntityData data)
```

#### Parameters
Type | Name | Description  
---|---|---  
PlayVideoBehavior.EntityData | data |   
```

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

### StepWindow Class Overview

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.Editor.UI.Windows.StepWindow.html

Provides an overview of the StepWindow class, including its inheritance and namespace.

```APIDOC
## Class StepWindow 

### Inheritance
System.Object
StepWindow

### Implements
IStepView

###### Namespace : VRBuilder.Core.Editor.UI.Windows
###### Assembly : VRBuilder.Core.Editor.dll

##### Syntax
```csharp
public class StepWindow : EditorWindow, IStepView
```
```

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

### Value Property

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.Configuration.Modes.ModeParameter-1.html

Gets or sets the current value of the parameter.

```csharp
public T Value { get; set; }
```

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

### SceneSetupParameter Constructor

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.Editor.Setup.SceneSetupParameter.html

Initializes a new instance of the SceneSetupParameter class with specified parameters. Optional parameters for tooltip, disable condition, and change callback can be provided.

```csharp
public SceneSetupParameter(string label, Type type, object defaultValue, string tooltip = "", Func<bool> isDisabled = null, Action<object> changedCallback = null)
```

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

### Chapter Property Declaration

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.Behaviors.SubChapter.html

Gets the IChapter associated with this SubChapter.

```csharp
public IChapter Chapter { get; }
```

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

### PlayVideoBehavior.ActivatingProcess Class

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Pro.Behaviors.PlayVideoBehavior.ActivatingProcess.html

Details the ActivatingProcess class, including its inheritance, namespace, assembly, and syntax.

```APIDOC
## Class PlayVideoBehavior.ActivatingProcess

### Inheritance
System.Object
StageProcess<PlayVideoBehavior.EntityData>
PlayVideoBehavior.ActivatingProcess

### Implements
IStageProcess

### Inherited Members
StageProcess<PlayVideoBehavior.EntityData>.Data
StageProcess<PlayVideoBehavior.EntityData>.Outer

### Namespace
VRBuilder.Pro.Behaviors

### Assembly
VRBuilder.Pro.dll

### Syntax
```csharp
public class ActivatingProcess : StageProcess<PlayVideoBehavior.EntityData>, IStageProcess
```
```

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

### ExecutionStages Property

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.Behaviors.PlayAudioBehavior.EntityData.html

Gets or sets the execution stages for the behavior.

```csharp
public BehaviorExecutionStages ExecutionStages { get; set; }
```

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

### XRISceneSetupConfiguration Constructor

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.XRInteraction.Editor.Setup.XRISceneSetupConfiguration.html

Details the public constructor for the XRISceneSetupConfiguration class.

```APIDOC
### Constructors 

#### XRISceneSetupConfiguration()
##### Declaration
```csharp
public XRISceneSetupConfiguration()
```
```

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

### AudioPlayer Property

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.Behaviors.PlayAudioBehavior.EntityData.html

Gets or sets the UnityEngine.AudioSource used for playback.

```csharp
public AudioSource AudioPlayer { get; set; }
```

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

### C# GuidBasedSceneObjectRegistry GetByGuid Method

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.SceneObjects.GuidBasedSceneObjectRegistry.html

Retrieves a scene object by its GUID.

```csharp
public ISceneObject GetByGuid(Guid guid)
```

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

### Initialize Method

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Pro.Components.ScoreFeedback.FloatingTextMesh.html

Details on how to initialize the FloatingTextMesh with specific text.

```APIDOC
## Methods 

### Initialize(String)

#### Declaration
```csharp
public void Initialize(string text)
```

#### Parameters
Type | Name | Description  
---|---|---  
System.String | text |
```

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

### GetObjects Method

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.SceneObjects.ISceneObjectRegistry.html

Retrieves all scene objects associated with the given GUID.

```csharp
IEnumerable<ISceneObject> GetObjects(Guid guid)
```

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

### SceneSetupWizard Class

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Core.Editor.UI.Wizard.SceneSetupWizard.html

Overview of the SceneSetupWizard static class and its associated events.

```APIDOC
## SceneSetupWizard

### Description
A static class used to manage the scene setup wizard in the VR Builder editor.

### Namespace
VRBuilder.Core.Editor.UI.Wizard

### Assembly
VRBuilder.Core.Editor.dll

### Events
#### SetupFinished
- **Declaration**: public static event EventHandler<EventArgs> SetupFinished
- **Description**: Triggered when the scene setup process has finished.
```

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

### ActivatingProcess Methods

Source: https://mindport-gmbh.github.io/VR-Builder-Documentation/api/VRBuilder.Pro.Behaviors.PlayVideoBehavior.ActivatingProcess.html

Documentation for the methods available in the ActivatingProcess class.

```APIDOC
### Methods

#### End()
##### Declaration
```csharp
public override void End()
```
##### Overrides
VRBuilder.Core.StageProcess<VRBuilder.Pro.Behaviors.PlayVideoBehavior.EntityData>.End()

#### FastForward()
##### Declaration
```csharp
public override void FastForward()
```
##### Overrides
VRBuilder.Core.StageProcess<VRBuilder.Pro.Behaviors.PlayVideoBehavior.EntityData>.FastForward()

#### Start()
##### Declaration
```csharp
public override void Start()
```
##### Overrides
VRBuilder.Core.StageProcess<VRBuilder.Pro.Behaviors.PlayVideoBehavior.EntityData>.Start()

#### Update()
##### Declaration
```csharp
public override IEnumerator Update()
```
##### Returns
Type | Description  
---|---  
System.Collections.IEnumerator |
##### Overrides
VRBuilder.Core.StageProcess<VRBuilder.Pro.Behaviors.PlayVideoBehavior.EntityData>.Update()
```
Tokens:
Raw