> 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.ksghost.md).

# Class ksGhost

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

Attach this script to a Reactor entity game object to have it spawn an associated ghost object. The ghost object will update its trasform to match the entity server transform. This allows the entity server transform to be compared to its client transform, include prediction and smoothing adjustements.

```csharp
public class ksGhost : ksEntityScript
```

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ← Object ← Component ← Behaviour ← MonoBehaviour ← [ksMonoScript\<ksEntity, ksEntityScript>](/reactor/api-reference/ks.reactor.client.unity/ks.reactor.client.unity.ksmonoscript-2.md) ← [ksEntityScript](/reactor/api-reference/ks.reactor.client.unity/ks.reactor.client.unity.ksentityscript.md) ← [ksGhost](/reactor/api-reference/ks.reactor.client.unity/ks.reactor.client.unity.ksghost.md)

#### Inherited Members

[ksEntityScript.Entity](/reactor/api-reference/ks.reactor.client.unity/ks.reactor.client.unity.ksentityscript.md#KS_Reactor_Client_Unity_ksEntityScript_Entity), [ksEntityScript.Room](/reactor/api-reference/ks.reactor.client.unity/ks.reactor.client.unity.ksentityscript.md#KS_Reactor_Client_Unity_ksEntityScript_Room), [ksEntityScript.Properties](/reactor/api-reference/ks.reactor.client.unity/ks.reactor.client.unity.ksentityscript.md#KS_Reactor_Client_Unity_ksEntityScript_Properties), [ksEntityScript.OnEnable()](/reactor/api-reference/ks.reactor.client.unity/ks.reactor.client.unity.ksentityscript.md#KS_Reactor_Client_Unity_ksEntityScript_OnEnable), [ksMonoScript\<ksEntity, ksEntityScript>.InstanceType](/reactor/api-reference/ks.reactor.client.unity/ks.reactor.client.unity.ksmonoscript-2.md#KS_Reactor_Client_Unity_ksMonoScript_2_InstanceType), [ksMonoScript\<ksEntity, ksEntityScript>.Room](/reactor/api-reference/ks.reactor.client.unity/ks.reactor.client.unity.ksmonoscript-2.md#KS_Reactor_Client_Unity_ksMonoScript_2_Room), [ksMonoScript\<ksEntity, ksEntityScript>.Time](/reactor/api-reference/ks.reactor.client.unity/ks.reactor.client.unity.ksmonoscript-2.md#KS_Reactor_Client_Unity_ksMonoScript_2_Time), [ksMonoScript\<ksEntity, ksEntityScript>.IsAttached](/reactor/api-reference/ks.reactor.client.unity/ks.reactor.client.unity.ksmonoscript-2.md#KS_Reactor_Client_Unity_ksMonoScript_2_IsAttached), [ksMonoScript\<ksEntity, ksEntityScript>.IsInitialized](/reactor/api-reference/ks.reactor.client.unity/ks.reactor.client.unity.ksmonoscript-2.md#KS_Reactor_Client_Unity_ksMonoScript_2_IsInitialized), [ksMonoScript\<ksEntity, ksEntityScript>.Assets](/reactor/api-reference/ks.reactor.client.unity/ks.reactor.client.unity.ksmonoscript-2.md#KS_Reactor_Client_Unity_ksMonoScript_2_Assets), [ksMonoScript\<ksEntity, ksEntityScript>.EnableOnAttach](/reactor/api-reference/ks.reactor.client.unity/ks.reactor.client.unity.ksmonoscript-2.md#KS_Reactor_Client_Unity_ksMonoScript_2_EnableOnAttach), [ksMonoScript\<ksEntity, ksEntityScript>.OnDestroy()](/reactor/api-reference/ks.reactor.client.unity/ks.reactor.client.unity.ksmonoscript-2.md#KS_Reactor_Client_Unity_ksMonoScript_2_OnDestroy), [ksMonoScript\<ksEntity, ksEntityScript>.Attached()](/reactor/api-reference/ks.reactor.client.unity/ks.reactor.client.unity.ksmonoscript-2.md#KS_Reactor_Client_Unity_ksMonoScript_2_Attached), [ksMonoScript\<ksEntity, ksEntityScript>.Initialize()](/reactor/api-reference/ks.reactor.client.unity/ks.reactor.client.unity.ksmonoscript-2.md#KS_Reactor_Client_Unity_ksMonoScript_2_Initialize), [ksMonoScript\<ksEntity, ksEntityScript>.Detached()](/reactor/api-reference/ks.reactor.client.unity/ks.reactor.client.unity.ksmonoscript-2.md#KS_Reactor_Client_Unity_ksMonoScript_2_Detached), [ksMonoScript\<ksEntity, ksEntityScript>.Awake()](/reactor/api-reference/ks.reactor.client.unity/ks.reactor.client.unity.ksmonoscript-2.md#KS_Reactor_Client_Unity_ksMonoScript_2_Awake), MonoBehaviour.IsInvoking(), MonoBehaviour.CancelInvoke(), MonoBehaviour.Invoke(string, float), MonoBehaviour.InvokeRepeating(string, float, float), MonoBehaviour.CancelInvoke(string), MonoBehaviour.IsInvoking(string), MonoBehaviour.StartCoroutine(string), MonoBehaviour.StartCoroutine(string, object), MonoBehaviour.StartCoroutine(IEnumerator), MonoBehaviour.StartCoroutine\_Auto(IEnumerator), MonoBehaviour.StopCoroutine(IEnumerator), MonoBehaviour.StopCoroutine(Coroutine), MonoBehaviour.StopCoroutine(string), MonoBehaviour.StopAllCoroutines(), MonoBehaviour.print(object), MonoBehaviour.destroyCancellationToken, MonoBehaviour.useGUILayout, MonoBehaviour.runInEditMode, Behaviour.enabled, Behaviour.isActiveAndEnabled, Component.GetComponent(Type), Component.GetComponent\<T>(), Component.TryGetComponent(Type, out Component), Component.TryGetComponent\<T>(out T), Component.GetComponent(string), Component.GetComponentInChildren(Type, bool), Component.GetComponentInChildren(Type), Component.GetComponentInChildren\<T>(bool), Component.GetComponentInChildren\<T>(), Component.GetComponentsInChildren(Type, bool), Component.GetComponentsInChildren(Type), Component.GetComponentsInChildren\<T>(bool), Component.GetComponentsInChildren\<T>(bool, List\<T>), Component.GetComponentsInChildren\<T>(), Component.GetComponentsInChildren\<T>(List\<T>), Component.GetComponentInParent(Type, bool), Component.GetComponentInParent(Type), Component.GetComponentInParent\<T>(bool), Component.GetComponentInParent\<T>(), Component.GetComponentsInParent(Type, bool), Component.GetComponentsInParent(Type), Component.GetComponentsInParent\<T>(bool), Component.GetComponentsInParent\<T>(bool, List\<T>), Component.GetComponentsInParent\<T>(), Component.GetComponents(Type), Component.GetComponents(Type, List\<Component>), Component.GetComponents\<T>(List\<T>), Component.GetComponents\<T>(), Component.CompareTag(string), Component.SendMessageUpwards(string, object, SendMessageOptions), Component.SendMessageUpwards(string, object), Component.SendMessageUpwards(string), Component.SendMessageUpwards(string, SendMessageOptions), Component.SendMessage(string, object), Component.SendMessage(string), Component.SendMessage(string, object, SendMessageOptions), Component.SendMessage(string, SendMessageOptions), Component.BroadcastMessage(string, object, SendMessageOptions), Component.BroadcastMessage(string, object), Component.BroadcastMessage(string), Component.BroadcastMessage(string, SendMessageOptions), Component.transform, Component.gameObject, Component.tag, 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

### GhostInstance <a href="#ks_reactor_client_unity_ksghost_ghostinstance" id="ks_reactor_client_unity_ksghost_ghostinstance"></a>

```csharp
public GameObject GhostInstance
```

#### Field Value

GameObject

### GhostMaterial <a href="#ks_reactor_client_unity_ksghost_ghostmaterial" id="ks_reactor_client_unity_ksghost_ghostmaterial"></a>

```csharp
[Tooltip("Material to use on renderer when a ghost prefab is not defined.")]
public Material GhostMaterial
```

#### Field Value

Material

### GhostPrefab <a href="#ks_reactor_client_unity_ksghost_ghostprefab" id="ks_reactor_client_unity_ksghost_ghostprefab"></a>

```csharp
[Tooltip("Prefab to use for the ghost object. If the value is null then a duplicate of the game object with only mesh renderer components will be created.")]
public GameObject GhostPrefab
```

#### Field Value

GameObject

### ShowGhost <a href="#ks_reactor_client_unity_ksghost_showghost" id="ks_reactor_client_unity_ksghost_showghost"></a>

```csharp
public bool ShowGhost
```

#### Field Value

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

## Methods

### Detached() <a href="#ks_reactor_client_unity_ksghost_detached" id="ks_reactor_client_unity_ksghost_detached"></a>

Destroy the ghost gameobject instance.

```csharp
public override void Detached()
```

### Update() <a href="#ks_reactor_client_unity_ksghost_update" id="ks_reactor_client_unity_ksghost_update"></a>

Spawns/Destroys/Update a ghost gameobject.

```csharp
public void Update()
```