> For the complete documentation index, see [llms.txt](https://kinematicsoup.gitbook.io/reactor/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://kinematicsoup.gitbook.io/reactor/api-reference/ks.reactor.client.unity/ks.reactor.client.unity.ksreactorconfig.md).

# Class ksReactorConfig

Namespace: [KS.Reactor.Client.Unity](/reactor/api-reference/ks.reactor.client.unity.md)\
Assembly: KSUnity-Source.dll

Reactor configuration setttings.

```csharp
public class ksReactorConfig : ScriptableObject
```

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ← Object ← ScriptableObject ← [ksReactorConfig](/reactor/api-reference/ks.reactor.client.unity/ks.reactor.client.unity.ksreactorconfig.md)

#### Inherited Members

ScriptableObject.SetDirty(), ScriptableObject.CreateInstance(string), ScriptableObject.CreateInstance(Type), ScriptableObject.CreateInstance\<T>(), Object.GetInstanceID(), Object.GetHashCode(), Object.Equals(object), Object.Instantiate(Object, Vector3, Quaternion), Object.Instantiate(Object, Vector3, Quaternion, Transform), Object.Instantiate(Object), Object.Instantiate(Object, Transform), Object.Instantiate(Object, Transform, bool), Object.Instantiate\<T>(T), Object.Instantiate\<T>(T, Vector3, Quaternion), Object.Instantiate\<T>(T, Vector3, Quaternion, Transform), Object.Instantiate\<T>(T, Transform), Object.Instantiate\<T>(T, Transform, bool), Object.Destroy(Object, float), Object.Destroy(Object), Object.DestroyImmediate(Object, bool), Object.DestroyImmediate(Object), Object.FindObjectsOfType(Type), Object.FindObjectsOfType(Type, bool), Object.FindObjectsByType(Type, FindObjectsSortMode), Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode), Object.DontDestroyOnLoad(Object), Object.DestroyObject(Object, float), Object.DestroyObject(Object), Object.FindSceneObjectsOfType(Type), Object.FindObjectsOfTypeIncludingAssets(Type), Object.FindObjectsOfType\<T>(), Object.FindObjectsByType\<T>(FindObjectsSortMode), Object.FindObjectsOfType\<T>(bool), Object.FindObjectsByType\<T>(FindObjectsInactive, FindObjectsSortMode), Object.FindObjectOfType\<T>(), Object.FindObjectOfType\<T>(bool), Object.FindFirstObjectByType\<T>(), Object.FindAnyObjectByType\<T>(), Object.FindFirstObjectByType\<T>(FindObjectsInactive), Object.FindAnyObjectByType\<T>(FindObjectsInactive), Object.FindObjectsOfTypeAll(Type), Object.FindObjectOfType(Type), Object.FindFirstObjectByType(Type), Object.FindAnyObjectByType(Type), Object.FindObjectOfType(Type, bool), Object.FindFirstObjectByType(Type, FindObjectsInactive), Object.FindAnyObjectByType(Type, FindObjectsInactive), Object.ToString(), Object.name, Object.hideFlags, [object.Equals(object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals\(system-object\)), [object.Equals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals\(system-object-system-object\)), [object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode), [object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype), [object.MemberwiseClone()](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone), [object.ReferenceEquals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals), [object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)

## Fields

### AutoRunInBackground <a href="#ks_reactor_client_unity_ksreactorconfig_autoruninbackground" id="ks_reactor_client_unity_ksreactorconfig_autoruninbackground"></a>

Automatically enable Unity to run in the background when you connect to a room. If this is false, you will not be allowed to connect if run in background is false.

```csharp
[Tooltip("Automatically enable Unity to run in the background when you connect to a room. If this is unchecked, you will not be allowed to connect if run in background is false.")]
public bool AutoRunInBackground
```

#### Field Value

[bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### Build <a href="#ks_reactor_client_unity_ksreactorconfig_build" id="ks_reactor_client_unity_ksreactorconfig_build"></a>

Build settings.

```csharp
public ksReactorConfig.BuildConfigs Build
```

#### Field Value

[ksReactorConfig](/reactor/api-reference/ks.reactor.client.unity/ks.reactor.client.unity.ksreactorconfig.md).[BuildConfigs](/reactor/api-reference/ks.reactor.client.unity/ks.reactor.client.unity.ksreactorconfig/ks.reactor.client.unity.ksreactorconfig.buildconfigs.md)

### Cluster <a href="#ks_reactor_client_unity_ksreactorconfig_cluster" id="ks_reactor_client_unity_ksreactorconfig_cluster"></a>

Local cluster settings.

```csharp
public ksReactorConfig.ClusterConfigs Cluster
```

#### Field Value

[ksReactorConfig](/reactor/api-reference/ks.reactor.client.unity/ks.reactor.client.unity.ksreactorconfig.md).[ClusterConfigs](/reactor/api-reference/ks.reactor.client.unity/ks.reactor.client.unity.ksreactorconfig/ks.reactor.client.unity.ksreactorconfig.clusterconfigs.md)

### CollisionGroups <a href="#ks_reactor_client_unity_ksreactorconfig_collisiongroups" id="ks_reactor_client_unity_ksreactorconfig_collisiongroups"></a>

Names assigned to collision groups.

```csharp
public string[] CollisionGroups
```

#### Field Value

[string](https://learn.microsoft.com/dotnet/api/system.string)\[]

### Server <a href="#ks_reactor_client_unity_ksreactorconfig_server" id="ks_reactor_client_unity_ksreactorconfig_server"></a>

Local server settings.

```csharp
public ksReactorConfig.ServerConfigs Server
```

#### Field Value

[ksReactorConfig](/reactor/api-reference/ks.reactor.client.unity/ks.reactor.client.unity.ksreactorconfig.md).[ServerConfigs](/reactor/api-reference/ks.reactor.client.unity/ks.reactor.client.unity.ksreactorconfig/ks.reactor.client.unity.ksreactorconfig.serverconfigs.md)

### ShowGettingStartedScreen <a href="#ks_reactor_client_unity_ksreactorconfig_showgettingstartedscreen" id="ks_reactor_client_unity_ksreactorconfig_showgettingstartedscreen"></a>

Show the Reactor getting started screen when Unity launches.

```csharp
[Tooltip("Show the Reactor Getting Started screen when opening this project.")]
public bool ShowGettingStartedScreen
```

#### Field Value

[bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### Urls <a href="#ks_reactor_client_unity_ksreactorconfig_urls" id="ks_reactor_client_unity_ksreactorconfig_urls"></a>

Web API URLs.

```csharp
public ksReactorConfig.URLConfigs Urls
```

#### Field Value

[ksReactorConfig](/reactor/api-reference/ks.reactor.client.unity/ks.reactor.client.unity.ksreactorconfig.md).[URLConfigs](/reactor/api-reference/ks.reactor.client.unity/ks.reactor.client.unity.ksreactorconfig/ks.reactor.client.unity.ksreactorconfig.urlconfigs.md)

## Properties

### Instance <a href="#ks_reactor_client_unity_ksreactorconfig_instance" id="ks_reactor_client_unity_ksreactorconfig_instance"></a>

Singleton instance. Load the config from the asset database if the instance is not initialized.

```csharp
public static ksReactorConfig Instance { get; }
```

#### Property Value

[ksReactorConfig](/reactor/api-reference/ks.reactor.client.unity/ks.reactor.client.unity.ksreactorconfig.md)

### Version <a href="#ks_reactor_client_unity_ksreactorconfig_version" id="ks_reactor_client_unity_ksreactorconfig_version"></a>

Reactor version.

```csharp
public ksVersion Version { get; }
```

#### Property Value

[ksVersion](/reactor/api-reference/ks.reactor.client/ks.reactor.client.ksversion.md)