> 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/ks.reactor.ksspawnparams2d.md).

# Class ksSpawnParams2D

Namespace: [KS.Reactor](/reactor/api-reference/ks.reactor.md)\
Assembly: KSCommon.dll

Parameters for spawning entities with 2D transform values.

```csharp
public class ksSpawnParams2D : ksSpawnParams
```

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ← [ksSpawnParams](/reactor/api-reference/ks.reactor/ks.reactor.ksspawnparams.md) ← [ksSpawnParams2D](/reactor/api-reference/ks.reactor/ks.reactor.ksspawnparams2d.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

### ksSpawnParams2D() <a href="#ks_reactor_ksspawnparams2d__ctor" id="ks_reactor_ksspawnparams2d__ctor"></a>

Constructor

```csharp
public ksSpawnParams2D()
```

### ksSpawnParams2D(string) <a href="#ks_reactor_ksspawnparams2d__ctor_system_string" id="ks_reactor_ksspawnparams2d__ctor_system_string"></a>

Constructor

```csharp
public ksSpawnParams2D(string entityType)
```

#### Parameters

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

Entity type to spawn

### ksSpawnParams2D(uint) <a href="#ks_reactor_ksspawnparams2d__ctor_system_uint32" id="ks_reactor_ksspawnparams2d__ctor_system_uint32"></a>

Constructor

```csharp
public ksSpawnParams2D(uint assetId)
```

#### Parameters

`assetId` [uint](https://learn.microsoft.com/dotnet/api/system.uint32)

Asset id of entity to spawn.

## Properties

### Transform <a href="#ks_reactor_ksspawnparams2d_transform" id="ks_reactor_ksspawnparams2d_transform"></a>

2D-representation of the transform to spawn at.

```csharp
public ksTransformState2D Transform { get; set; }
```

#### Property Value

[ksTransformState2D](/reactor/api-reference/ks.reactor/ks.reactor.kstransformstate2d.md)

## Methods

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

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

```csharp
public static ksSpawnParams2D Create()
```

#### Returns

[ksSpawnParams2D](/reactor/api-reference/ks.reactor/ks.reactor.ksspawnparams2d.md)

Spawn parameters

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

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

```csharp
public static ksSpawnParams2D Create(string entityType)
```

#### Parameters

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

Entity type to spawn

#### Returns

[ksSpawnParams2D](/reactor/api-reference/ks.reactor/ks.reactor.ksspawnparams2d.md)

Spawn parameters

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

Returns the spawn parameters object to the pool.

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

### TransformAssigned() <a href="#ks_reactor_ksspawnparams2d_transformassigned" id="ks_reactor_ksspawnparams2d_transformassigned"></a>

Called when the 3D transform is assigned. Creates a new 2D transform to wrap the 3D transform.

```csharp
protected override void TransformAssigned()
```