NikosAssets.Instantiation.BaseDefaultInstantiationMono< TObject > Class Template Reference

An abstract wrapper class handling the classic instantiation logic. More...

Public Member Functions
override async Task< TObject >	CreateInstanceAsync (Transform parent=null, bool worldPositionStays=false)
	Just executes the default Instantiate method and returns the result.
override async Task< TObject >	CreateInstanceAsync (Vector3 position, Quaternion rotation, Transform parent=null)
	Just executes the default Instantiate method and returns the result.
override async Task< TObject >	LoadAssetReferenceAsync ()
	Just returns the CachedAssetReference
override async Task	UnloadAssetReference ()
	For default instantiation, does nothing, as we don't unload prefabs/ original Objects.
Public Member Functions inherited from NikosAssets.Instantiation.BaseInstantiationMono< TObject >
virtual void	Dispose ()
	Executed by OnDestroy
Task< TObject >	CreateInstanceAsync (Transform parent=null, bool worldPositionStays=false)
Task< TObject >	CreateInstanceAsync (Vector3 position, Quaternion rotation, Transform parent=null)
Task< TObject >	LoadAssetReferenceAsync ()
	Loads the Object to clone and caches it in the CachedAssetReference
Task	UnloadAssetReference ()
	Unloads the CachedAssetReference when using addressables. For convenience you can also just call Dispose().

Public Attributes
TObject	objToInstantiate

Properties
override TObject	CachedAssetReference [get, set]
	Just sets and returns the objToInstantiate
Properties inherited from NikosAssets.Instantiation.BaseInstantiationMono< TObject >
TObject	CachedAssetReference [get, set]
	Either set a cached asset yourself or call and await LoadAssetReferenceAsync() to initialize this property. By default, this cached asset reference will be used for Instantiation and it is even recommended you use it yourself to avoid overhead.

Additional Inherited Members
Protected Member Functions inherited from NikosAssets.Instantiation.BaseInstantiationMono< TObject >
virtual void	OnDestroy ()
	Calls Dispose

Detailed Description

An abstract wrapper class handling the classic instantiation logic.

Template Parameters

TObject

To load and cache

Type Constraints

TObject

:

Object

Member Function Documentation

CreateInstanceAsync() [1/2]

override async Task< TObject > NikosAssets.Instantiation.BaseDefaultInstantiationMono< TObject >.CreateInstanceAsync	(	Transform	parent = null,
		bool	worldPositionStays = false )

Just executes the default Instantiate method and returns the result.

Parameters

parent
worldPositionStays

Returns

Implements NikosAssets.Instantiation.IInstantiation< TObject >.

CreateInstanceAsync() [2/2]

override async Task< TObject > NikosAssets.Instantiation.BaseDefaultInstantiationMono< TObject >.CreateInstanceAsync	(	Vector3	position,
		Quaternion	rotation,
		Transform	parent = null )

Just executes the default Instantiate method and returns the result.

Parameters

position
rotation
parent

Returns

Implements NikosAssets.Instantiation.IInstantiation< TObject >.

LoadAssetReferenceAsync()

override async Task< TObject > NikosAssets.Instantiation.BaseDefaultInstantiationMono< TObject >.LoadAssetReferenceAsync

(

)

Just returns the CachedAssetReference

Returns

Implements NikosAssets.Instantiation.IInstantiation< TObject >.

UnloadAssetReference()

override async Task NikosAssets.Instantiation.BaseDefaultInstantiationMono< TObject >.UnloadAssetReference

(

)

For default instantiation, does nothing, as we don't unload prefabs/ original Objects.

Implements NikosAssets.Instantiation.IInstantiation< TObject >.

Property Documentation

CachedAssetReference

override TObject NikosAssets.Instantiation.BaseDefaultInstantiationMono< TObject >.CachedAssetReference

getset

Just sets and returns the objToInstantiate

Implements NikosAssets.Instantiation.IInstantiation< TObject >.

---

The documentation for this class was generated from the following file:

• BaseDefaultInstantiationMono.cs