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

# Class ksEntityScript

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

Base class for scripts attached to entities.

```csharp
[AddComponentMenu("GameObject/")]
public abstract class ksEntityScript : ksMonoScript<ksEntity, 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)

#### Derived

[ksAnimationSync](/reactor/api-reference/ks.reactor.client.unity/ks.reactor.client.unity.ksanimationsync.md), [ksGhost](/reactor/api-reference/ks.reactor.client.unity/ks.reactor.client.unity.ksghost.md)

#### Inherited Members

[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)

## Properties

### Entity <a href="#ks_reactor_client_unity_ksentityscript_entity" id="ks_reactor_client_unity_ksentityscript_entity"></a>

Entity this script is attached to.

```csharp
public ksEntity Entity { get; }
```

#### Property Value

[ksEntity](/reactor/api-reference/ks.reactor.client.unity/ks.reactor.client.unity.ksentity.md)

### Properties <a href="#ks_reactor_client_unity_ksentityscript_properties" id="ks_reactor_client_unity_ksentityscript_properties"></a>

Entity properties

```csharp
public ksPropertyMap Properties { get; }
```

#### Property Value

[ksPropertyMap](/reactor/api-reference/ks.reactor/ks.reactor.kspropertymap.md)

### Room <a href="#ks_reactor_client_unity_ksentityscript_room" id="ks_reactor_client_unity_ksentityscript_room"></a>

Room the entity is in.

```csharp
public override sealed ksRoom Room { get; }
```

#### Property Value

[ksRoom](/reactor/api-reference/ks.reactor.client.unity/ks.reactor.client.unity.ksroom.md)

## Methods

### OnEnable() <a href="#ks_reactor_client_unity_ksentityscript_onenable" id="ks_reactor_client_unity_ksentityscript_onenable"></a>

Initialize internal components.

```csharp
protected virtual void OnEnable()
```