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

# Class ksClientSpawnParams

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

Parameters for spawning entities on the client.

```csharp
public class ksClientSpawnParams : ksSpawnParams
```

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ← [ksSpawnParams](/reactor/api-reference/ks.reactor/ks.reactor.ksspawnparams.md) ← [ksClientSpawnParams](/reactor/api-reference/ks.reactor.client.unity/ks.reactor.client.unity.ksclientspawnparams.md)

#### Derived

[ksClientSpawnParams2D](/reactor/api-reference/ks.reactor.client.unity/ks.reactor.client.unity.ksclientspawnparams2d.md)

#### Inherited Members

[ksSpawnParams.EntityType](/reactor/api-reference/ks.reactor/ks.reactor.ksspawnparams.md#KS_Reactor_ksSpawnParams_EntityType), [ksSpawnParams.m\_entityType](/reactor/api-reference/ks.reactor/ks.reactor.ksspawnparams.md#KS_Reactor_ksSpawnParams_m_entityType), [ksSpawnParams.AssetId](/reactor/api-reference/ks.reactor/ks.reactor.ksspawnparams.md#KS_Reactor_ksSpawnParams_AssetId), [ksSpawnParams.m\_assetId](/reactor/api-reference/ks.reactor/ks.reactor.ksspawnparams.md#KS_Reactor_ksSpawnParams_m_assetId), [ksSpawnParams.Transform](/reactor/api-reference/ks.reactor/ks.reactor.ksspawnparams.md#KS_Reactor_ksSpawnParams_Transform), [ksSpawnParams.TransformAssigned()](/reactor/api-reference/ks.reactor/ks.reactor.ksspawnparams.md#KS_Reactor_ksSpawnParams_TransformAssigned), [ksSpawnParams.ScaleMode](/reactor/api-reference/ks.reactor/ks.reactor.ksspawnparams.md#KS_Reactor_ksSpawnParams_ScaleMode), [ksSpawnParams.Properties](/reactor/api-reference/ks.reactor/ks.reactor.ksspawnparams.md#KS_Reactor_ksSpawnParams_Properties), [ksSpawnParams.OwnerId](/reactor/api-reference/ks.reactor/ks.reactor.ksspawnparams.md#KS_Reactor_ksSpawnParams_OwnerId), [ksSpawnParams.Permissions](/reactor/api-reference/ks.reactor/ks.reactor.ksspawnparams.md#KS_Reactor_ksSpawnParams_Permissions), [ksSpawnParams.PlayerController](/reactor/api-reference/ks.reactor/ks.reactor.ksspawnparams.md#KS_Reactor_ksSpawnParams_PlayerController), [ksSpawnParams.Validate(bool)](/reactor/api-reference/ks.reactor/ks.reactor.ksspawnparams.md#KS_Reactor_ksSpawnParams_Validate_System_Boolean_), [ksSpawnParams.Create()](/reactor/api-reference/ks.reactor/ks.reactor.ksspawnparams.md#KS_Reactor_ksSpawnParams_Create), [ksSpawnParams.Create(string)](/reactor/api-reference/ks.reactor/ks.reactor.ksspawnparams.md#KS_Reactor_ksSpawnParams_Create_System_String_), [ksSpawnParams.Release()](/reactor/api-reference/ks.reactor/ks.reactor.ksspawnparams.md#KS_Reactor_ksSpawnParams_Release), [ksSpawnParams.Create\<T>()](/reactor/api-reference/ks.reactor/ks.reactor.ksspawnparams.md#KS_Reactor_ksSpawnParams_Create__1), [ksSpawnParams.Release\<T>()](/reactor/api-reference/ks.reactor/ks.reactor.ksspawnparams.md#KS_Reactor_ksSpawnParams_Release__1), [ksSpawnParams.Reset()](/reactor/api-reference/ks.reactor/ks.reactor.ksspawnparams.md#KS_Reactor_ksSpawnParams_Reset), [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)

## Constructors

### ksClientSpawnParams() <a href="#ks_reactor_client_unity_ksclientspawnparams__ctor" id="ks_reactor_client_unity_ksclientspawnparams__ctor"></a>

Constructor

```csharp
public ksClientSpawnParams()
```

### ksClientSpawnParams(GameObject) <a href="#ks_reactor_client_unity_ksclientspawnparams__ctor_unityengine_gameobject" id="ks_reactor_client_unity_ksclientspawnparams__ctor_unityengine_gameobject"></a>

Constructor

```csharp
public ksClientSpawnParams(GameObject prefab)
```

#### Parameters

`prefab` GameObject

Entity prefab to spawn.

## Properties

### GameObject <a href="#ks_reactor_client_unity_ksclientspawnparams_gameobject" id="ks_reactor_client_unity_ksclientspawnparams_gameobject"></a>

The game object to spawn an entity for. The game object must have a [ksEntityComponent](/reactor/api-reference/ks.reactor.client.unity/ks.reactor.client.unity.ksentitycomponent.md) and a non-zero asset id (which all entity prefabs in Resources or asset bundles should have). If the game object is a prefab, an instance will be instantiated for the spawned entity.

```csharp
public GameObject GameObject { get; set; }
```

#### Property Value

GameObject

## Methods

### Create() <a href="#ks_reactor_client_unity_ksclientspawnparams_create" id="ks_reactor_client_unity_ksclientspawnparams_create"></a>

Fetches a [ksClientSpawnParams](/reactor/api-reference/ks.reactor.client.unity/ks.reactor.client.unity.ksclientspawnparams.md) from the pool, or creates one if the pool is empty.

```csharp
public static ksClientSpawnParams Create()
```

#### Returns

[ksClientSpawnParams](/reactor/api-reference/ks.reactor.client.unity/ks.reactor.client.unity.ksclientspawnparams.md)

Spawn parameters

### Create(GameObject) <a href="#ks_reactor_client_unity_ksclientspawnparams_create_unityengine_gameobject" id="ks_reactor_client_unity_ksclientspawnparams_create_unityengine_gameobject"></a>

Fetches a [ksClientSpawnParams](/reactor/api-reference/ks.reactor.client.unity/ks.reactor.client.unity.ksclientspawnparams.md) from the pool, or creates one if the pool is empty.

```csharp
public static ksClientSpawnParams Create(GameObject prefab)
```

#### Parameters

`prefab` GameObject

Prefab to spawn

#### Returns

[ksClientSpawnParams](/reactor/api-reference/ks.reactor.client.unity/ks.reactor.client.unity.ksclientspawnparams.md)

Spawn parameters

### Release() <a href="#ks_reactor_client_unity_ksclientspawnparams_release" id="ks_reactor_client_unity_ksclientspawnparams_release"></a>

Returns the spawn parameters object to the pool.

```csharp
public override void Release()
```

### Reset() <a href="#ks_reactor_client_unity_ksclientspawnparams_reset" id="ks_reactor_client_unity_ksclientspawnparams_reset"></a>

Resets parameters to their default values.

```csharp
protected override void Reset()
```

### Validate(bool) <a href="#ks_reactor_client_unity_ksclientspawnparams_validate_system_boolean" id="ks_reactor_client_unity_ksclientspawnparams_validate_system_boolean"></a>

Validates the parameters.

```csharp
public override bool Validate(bool log = true)
```

#### Parameters

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

True to log warnings

#### Returns

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

True if the spawn parameters are valid.