> 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.editor/ks.reactor.client.unity.editor.ksgettingstarted.md).

# Class ksGettingStarted

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

Popup screen with Reactor Multiplayer getting started instructions. This screen will appear when opening unity and the last loaded version and the current version are different or when the show getting started config value is true.

```csharp
public class ksGettingStarted : ksSingleton<ksGettingStarted>, ksIMenu
```

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ← Object ← ScriptableObject ← [ksSingleton\<ksGettingStarted>](/reactor/api-reference/ks.unity.editor/ks.unity.editor.kssingleton-1.md) ← [ksGettingStarted](/reactor/api-reference/ks.reactor.client.unity.editor/ks.reactor.client.unity.editor.ksgettingstarted.md)

#### Implements

[ksIMenu](/reactor/api-reference/ks.unity.editor/ks.unity.editor.ksimenu.md)

#### Inherited Members

[ksSingleton\<ksGettingStarted>.Get()](/reactor/api-reference/ks.unity.editor/ks.unity.editor.kssingleton-1.md#KS_Unity_Editor_ksSingleton_1_Get), [ksSingleton\<ksGettingStarted>.Initialize()](/reactor/api-reference/ks.unity.editor/ks.unity.editor.kssingleton-1.md#KS_Unity_Editor_ksSingleton_1_Initialize), [ksSingleton\<ksGettingStarted>.Create()](/reactor/api-reference/ks.unity.editor/ks.unity.editor.kssingleton-1.md#KS_Unity_Editor_ksSingleton_1_Create), 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

### SESSION\_STATE <a href="#ks_reactor_client_unity_editor_ksgettingstarted_session_state" id="ks_reactor_client_unity_editor_ksgettingstarted_session_state"></a>

```csharp
public const string SESSION_STATE = "KS.Reactor.ShowGettingStarted"
```

#### Field Value

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

## Properties

### DestroyOnClose <a href="#ks_reactor_client_unity_editor_ksgettingstarted_destroyonclose" id="ks_reactor_client_unity_editor_ksgettingstarted_destroyonclose"></a>

Destroy this menu on close.

```csharp
public bool DestroyOnClose { get; }
```

#### Property Value

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

### Icon <a href="#ks_reactor_client_unity_editor_ksgettingstarted_icon" id="ks_reactor_client_unity_editor_ksgettingstarted_icon"></a>

Icon

```csharp
public Texture Icon { get; }
```

#### Property Value

Texture

## Methods

### Draw(ksWindow) <a href="#ks_reactor_client_unity_editor_ksgettingstarted_draw_ks_unity_editor_kswindow" id="ks_reactor_client_unity_editor_ksgettingstarted_draw_ks_unity_editor_kswindow"></a>

Draw the window content

```csharp
public void Draw(ksWindow window)
```

#### Parameters

`window` [ksWindow](/reactor/api-reference/ks.unity.editor/ks.unity.editor.kswindow.md)

window the GUI is for.

### OnClose(ksWindow) <a href="#ks_reactor_client_unity_editor_ksgettingstarted_onclose_ks_unity_editor_kswindow" id="ks_reactor_client_unity_editor_ksgettingstarted_onclose_ks_unity_editor_kswindow"></a>

Called when the menu is closed. Does nothing.

```csharp
public void OnClose(ksWindow window)
```

#### Parameters

`window` [ksWindow](/reactor/api-reference/ks.unity.editor/ks.unity.editor.kswindow.md)

window that closed the menu.

### OnOpen(ksWindow) <a href="#ks_reactor_client_unity_editor_ksgettingstarted_onopen_ks_unity_editor_kswindow" id="ks_reactor_client_unity_editor_ksgettingstarted_onopen_ks_unity_editor_kswindow"></a>

Called when the menu is opened.

```csharp
public void OnOpen(ksWindow window)
```

#### Parameters

`window` [ksWindow](/reactor/api-reference/ks.unity.editor/ks.unity.editor.kswindow.md)

window that opened the menu.

### Open() <a href="#ks_reactor_client_unity_editor_ksgettingstarted_open" id="ks_reactor_client_unity_editor_ksgettingstarted_open"></a>

Opens the getting started window.

```csharp
public void Open()
```