Struct InstantiationParameters
Class that contains properties to apply to instantiated objects.
Namespace: UnityEngine.ResourceManagement.ResourceProviders
Syntax
public struct InstantiationParametersConstructors
InstantiationParameters(Transform, Boolean)
Create a new InstantationParameters class that will set the parent transform and use the prefab transform.
Declaration
public InstantiationParameters(Transform parent, bool instantiateInWorldSpace)Parameters
| Type | Name | Description |
|---|---|---|
| Transform | parent | Transform to set as the parent of the instantiated object. |
| Boolean | instantiateInWorldSpace | Flag to tell the IInstanceProvider whether to set the position and rotation on new instances. |
InstantiationParameters(Vector3, Quaternion, Transform)
Create a new InstantationParameters class that will set the position, rotation, and Transform parent of the instance.
Declaration
public InstantiationParameters(Vector3 position, Quaternion rotation, Transform parent)Parameters
| Type | Name | Description |
|---|---|---|
| Vector3 | position | Position relative to the parent to set on the instance. |
| Quaternion | rotation | Rotation relative to the parent to set on the instance. |
| Transform | parent | Transform to set as the parent of the instantiated object. |
Properties
InstantiateInWorldPosition
When setting the parent Transform, this sets whether to preserve instance transform relative to world space or relative to the parent.
Declaration
public bool InstantiateInWorldPosition { get; }Property Value
| Type | Description |
|---|---|
| Boolean |
Parent
Transform to set as the parent of the instantiated object.
Declaration
public Transform Parent { get; }Property Value
| Type | Description |
|---|---|
| Transform |
Position
Position in world space to instantiate object.
Declaration
public Vector3 Position { get; }Property Value
| Type | Description |
|---|---|
| Vector3 |
Rotation
Rotation in world space to instantiate object.
Declaration
public Quaternion Rotation { get; }Property Value
| Type | Description |
|---|---|
| Quaternion |
SetPositionRotation
Flag to tell the IInstanceProvider whether to set the position and rotation on new instances.
Declaration
public bool SetPositionRotation { get; }Property Value
| Type | Description |
|---|---|
| Boolean |
Methods
Instantiate<TObject>(TObject)
Instantiate an object with the parameters of this object.
Declaration
public TObject Instantiate<TObject>(TObject source)
where TObject : ObjectParameters
| Type | Name | Description |
|---|---|---|
| TObject | source | Object to instantiate. |
Returns
| Type | Description |
|---|---|
| TObject | Returns the instantiated object. |
Type Parameters
| Name | Description |
|---|---|
| TObject | Object type. This type must be of type UnityEngine.Object. |