Infohazard.Core 1.4.1
Infohazard Core Utility Library
Loading...
Searching...
No Matches
Infohazard.Core.SpawnRef< T > Class Template Reference

SpawnRef for spawning a GameObject directly. More...

Public Member Functions

 SpawnRef ()
 Default constructor (needed for Unity serialization). More...
 
 SpawnRef (GameObject prefab)
 Construct with a given prefab. More...
 
 SpawnRef ()
 Default constructor (needed for Unity serialization). More...
 
 SpawnRef (T prefab)
 Construct with a given prefab component. More...
 
- Public Member Functions inherited from Infohazard.Core.SpawnRefBase< GameObject >
 SpawnRefBase ()
 Default constructor (needed for Unity serialization). More...
 
 SpawnRefBase (T prefab)
 Construct with a given prefab. More...
 
virtual void Retain ()
 Add a user to the SpawnRef, creating the DefaultPoolHandler if necessary. More...
 
virtual void Release ()
 Remove a user from the SpawnRef, in turn releasing the IPoolHandler. More...
 
Spawn (in SpawnParams spawnParams=default)
 Spawn an instance of Prefab. The SpawnRef MUST be retained. More...
 
- Public Member Functions inherited from Infohazard.Core.SpawnRefBase< T >
 SpawnRefBase ()
 Default constructor (needed for Unity serialization). More...
 
 SpawnRefBase (T prefab)
 Construct with a given prefab. More...
 
virtual void Retain ()
 Add a user to the SpawnRef, creating the DefaultPoolHandler if necessary. More...
 
virtual void Release ()
 Remove a user from the SpawnRef, in turn releasing the IPoolHandler. More...
 
Spawn (in SpawnParams spawnParams=default)
 Spawn an instance of Prefab. The SpawnRef MUST be retained. More...
 

Protected Member Functions

override void GetSpawnableAndGameObject (T obj, out Spawnable spawnable, out GameObject gameObject)
 Override to return the associated Spawnable script and GameObject for given object. More...
 
abstract void GetSpawnableAndGameObject (T obj, out Spawnable spawnable, out GameObject gameObject)
 Override to return the associated Spawnable script and GameObject for given object. More...
 
abstract void GetSpawnableAndGameObject (T obj, out Spawnable spawnable, out GameObject gameObject)
 Override to return the associated Spawnable script and GameObject for given object. More...
 

Additional Inherited Members

- Properties inherited from Infohazard.Core.SpawnRefBase< GameObject >
bool IsValid [get]
 Whether there is a valid prefab is attached. More...
 
Prefab [get]
 The prefab to be spawned. More...
 
- Properties inherited from Infohazard.Core.SpawnRefBase< T >
bool IsValid [get]
 Whether there is a valid prefab is attached. More...
 
Prefab [get]
 The prefab to be spawned. More...
 

Detailed Description

SpawnRef for spawning a GameObject directly.

SpawnRef for spawning a GameObject via one of its components.

Type Constraints
T :Component 

Constructor & Destructor Documentation

◆ SpawnRef() [1/4]

Default constructor (needed for Unity serialization).

◆ SpawnRef() [2/4]

Infohazard.Core.SpawnRef< T >.SpawnRef ( GameObject  prefab)

Construct with a given prefab.

Parameters
prefabThe prefab to be spawned.

inheritdoc/>

◆ SpawnRef() [3/4]

Default constructor (needed for Unity serialization).

◆ SpawnRef() [4/4]

Infohazard.Core.SpawnRef< T >.SpawnRef ( prefab)

Construct with a given prefab component.

Parameters
prefabThe prefab to be spawned.

inheritdoc/>

Member Function Documentation

◆ GetSpawnableAndGameObject()

override void Infohazard.Core.SpawnRef< T >.GetSpawnableAndGameObject ( obj,
out Spawnable  spawnable,
out GameObject  gameObject 
)
protectedvirtual

Override to return the associated Spawnable script and GameObject for given object.

Parameters
objThe attached object.
spawnableThe Spawnable script for obj.
gameObjectThe GameObject for obj.

Implements Infohazard.Core.SpawnRefBase< T >.


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