> For the complete documentation index, see [llms.txt](https://kinematicsoup.gitbook.io/scene-fusion/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/scene-fusion/api-reference/ks.scenefusion.client.unity.editor/ks.scenefusion.client.unity.editor.sfconfig.md).

# Class sfConfig

Namespace: [KS.SceneFusion.Client.Unity.Editor](/scene-fusion/api-reference/ks.scenefusion.client.unity.editor.md)\
Assembly: KSUnity-Source.dll

Scene Fusion config.

```csharp
public class sfConfig : ScriptableObject
```

#### Inheritance

object ← Object ← ScriptableObject ← [sfConfig](/scene-fusion/api-reference/ks.scenefusion.client.unity.editor/ks.scenefusion.client.unity.editor.sfconfig.md)

#### Extension Methods

[sfUnityUtils.IsDestroyed(Object)](/scene-fusion/api-reference/ks.scenefusion.client.unity.editor/ks.scenefusion.client.unity.editor.sfunityutils.md#ks_scenefusion_client_unity_editor_sfunityutils_isdestroyed_unityengine_object)

## Fields

### Debug <a href="#ks_scenefusion_client_unity_editor_sfconfig_debug" id="ks_scenefusion_client_unity_editor_sfconfig_debug"></a>

```csharp
public bool Debug
```

#### Field Value

bool

### LastVersion <a href="#ks_scenefusion_client_unity_editor_sfconfig_lastversion" id="ks_scenefusion_client_unity_editor_sfconfig_lastversion"></a>

```csharp
public string LastVersion
```

#### Field Value

string

### Logging <a href="#ks_scenefusion_client_unity_editor_sfconfig_logging" id="ks_scenefusion_client_unity_editor_sfconfig_logging"></a>

```csharp
public sfConfig.LogSettings Logging
```

#### Field Value

[sfConfig](/scene-fusion/api-reference/ks.scenefusion.client.unity.editor/ks.scenefusion.client.unity.editor.sfconfig.md).[LogSettings](/scene-fusion/api-reference/ks.scenefusion.client.unity.editor/ks.scenefusion.client.unity.editor.sfconfig/ks.scenefusion.client.unity.editor.sfconfig.logsettings.md)

### Network <a href="#ks_scenefusion_client_unity_editor_sfconfig_network" id="ks_scenefusion_client_unity_editor_sfconfig_network"></a>

```csharp
public sfConfig.NetworkSettings Network
```

#### Field Value

[sfConfig](/scene-fusion/api-reference/ks.scenefusion.client.unity.editor/ks.scenefusion.client.unity.editor.sfconfig.md).[NetworkSettings](/scene-fusion/api-reference/ks.scenefusion.client.unity.editor/ks.scenefusion.client.unity.editor.sfconfig/ks.scenefusion.client.unity.editor.sfconfig.networksettings.md)

### Performance <a href="#ks_scenefusion_client_unity_editor_sfconfig_performance" id="ks_scenefusion_client_unity_editor_sfconfig_performance"></a>

```csharp
public sfConfig.PerformanceSettings Performance
```

#### Field Value

[sfConfig](/scene-fusion/api-reference/ks.scenefusion.client.unity.editor/ks.scenefusion.client.unity.editor.sfconfig.md).[PerformanceSettings](/scene-fusion/api-reference/ks.scenefusion.client.unity.editor/ks.scenefusion.client.unity.editor.sfconfig/ks.scenefusion.client.unity.editor.sfconfig.performancesettings.md)

### SessionSettingsLocked <a href="#ks_scenefusion_client_unity_editor_sfconfig_sessionsettingslocked" id="ks_scenefusion_client_unity_editor_sfconfig_sessionsettingslocked"></a>

If true, prevents changing the following settings that should not change during a session:

* SyncPrefabs

```csharp
[NonSerialized]
public bool SessionSettingsLocked
```

#### Field Value

bool

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

```csharp
public bool ShowGettingStartedScreen
```

#### Field Value

bool

### UI <a href="#ks_scenefusion_client_unity_editor_sfconfig_ui" id="ks_scenefusion_client_unity_editor_sfconfig_ui"></a>

```csharp
public sfConfig.UISettings UI
```

#### Field Value

[sfConfig](/scene-fusion/api-reference/ks.scenefusion.client.unity.editor/ks.scenefusion.client.unity.editor.sfconfig.md).[UISettings](/scene-fusion/api-reference/ks.scenefusion.client.unity.editor/ks.scenefusion.client.unity.editor.sfconfig/ks.scenefusion.client.unity.editor.sfconfig.uisettings.md)

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

```csharp
public sfConfig.URLConfigs Urls
```

#### Field Value

[sfConfig](/scene-fusion/api-reference/ks.scenefusion.client.unity.editor/ks.scenefusion.client.unity.editor.sfconfig.md).[URLConfigs](/scene-fusion/api-reference/ks.scenefusion.client.unity.editor/ks.scenefusion.client.unity.editor.sfconfig/ks.scenefusion.client.unity.editor.sfconfig.urlconfigs.md)

## Properties

### FullVersion <a href="#ks_scenefusion_client_unity_editor_sfconfig_fullversion" id="ks_scenefusion_client_unity_editor_sfconfig_fullversion"></a>

Full version string including of the form \[Version]\[Build Identifier].

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

#### Property Value

string

### ProjectId <a href="#ks_scenefusion_client_unity_editor_sfconfig_projectid" id="ks_scenefusion_client_unity_editor_sfconfig_projectid"></a>

Active project ID

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

#### Property Value

int

### ServerVersion <a href="#ks_scenefusion_client_unity_editor_sfconfig_serverversion" id="ks_scenefusion_client_unity_editor_sfconfig_serverversion"></a>

Scene Fusion server version

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

#### Property Value

ksVersion

### SyncMaterials <a href="#ks_scenefusion_client_unity_editor_sfconfig_syncmaterials" id="ks_scenefusion_client_unity_editor_sfconfig_syncmaterials"></a>

If true, referenced materials and materiald modified during a session will be synced. The value for this setting is determined by the session creator and cannot be changed during a session.

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

#### Property Value

bool

### SyncPrefabs <a href="#ks_scenefusion_client_unity_editor_sfconfig_syncprefabs" id="ks_scenefusion_client_unity_editor_sfconfig_syncprefabs"></a>

Prefab sync mode. The value for this setting is determined by the session creator and cannot be changed during a session.

```csharp
public sfConfig.PrefabSyncMode SyncPrefabs { get; set; }
```

#### Property Value

[sfConfig](/scene-fusion/api-reference/ks.scenefusion.client.unity.editor/ks.scenefusion.client.unity.editor.sfconfig.md).[PrefabSyncMode](/scene-fusion/api-reference/ks.scenefusion.client.unity.editor/ks.scenefusion.client.unity.editor.sfconfig/ks.scenefusion.client.unity.editor.sfconfig.prefabsyncmode.md)

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

Scene Fusion version

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

#### Property Value

ksVersion

## Methods

### Get() <a href="#ks_scenefusion_client_unity_editor_sfconfig_get" id="ks_scenefusion_client_unity_editor_sfconfig_get"></a>

```csharp
public static sfConfig Get()
```

#### Returns

[sfConfig](/scene-fusion/api-reference/ks.scenefusion.client.unity.editor/ks.scenefusion.client.unity.editor.sfconfig.md)

singleton instance. Load the config from the asset database. If it does not exist, then create a new config.
