Struct InstantiationParameters
Class that contains properties to apply to instantiated objects.
Syntax
public struct InstantiationParameters
Constructors
Create a new InstantationParameters class that will set the parent transform and use the prefab transform.
Transform to set as the parent of the instantiated object.
Flag to tell the IInstanceProvider whether to set the position and rotation on new instances.
Declaration
public InstantiationParameters(Transform parent, bool instantiateInWorldSpace)
Parameters
| Type |
Name |
Description |
| Transform |
parent |
|
| System.Boolean |
instantiateInWorldSpace |
|
Create a new InstantationParameters class that will set the position, rotation, and Transform parent of the instance.
Position relative to the parent to set on the instance.
Rotation relative to the parent to set on the instance.
Transform to set as the parent of the instantiated object.
Declaration
public InstantiationParameters(Vector3 position, Quaternion rotation, Transform parent)
Parameters
| Type |
Name |
Description |
| Vector3 |
position |
|
| Quaternion |
rotation |
|
| Transform |
parent |
|
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 |
| System.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
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 |
| System.Boolean |
|
Methods
Instantiate<TObject>(TObject)
Instantiate an object with the parameters of this object.
Object to instantiate.
Instantiated object.
Object type. This type must be of type UnityEngine.Object.
Declaration
public TObject Instantiate<TObject>(TObject source)
Parameters
| Type |
Name |
Description |
| TObject |
source |
|
Returns
Type Parameters