Sisus.Init.InitializerBase< TClient, TFirstArgument, TSecondArgument, TThirdArgument, TFourthArgument, TFifthArgument > Class Template Reference

Description

A base class for a component that can specify the five arguments used to initialize an object that implements IInitializable<TFirstArgument, TSecondArgument, TThirdArgument, TFourthArgument, TFifthArgument>.

The arguments can be assigned using the inspector and are serialized as part of the client's scene or prefab asset.

The arguments get injected to the TClient client during the Awake event.

The client receives the arguments via the Init method where they can be assigned to member fields or properties.

After the arguments have been injected the initializer is removed from the GameObject that holds it.

When you derive your Initializer class from InitializerBase<,,,,,> you are responsible for implementing the argument properties and serializing their values. This means you will need to write a little bit more code, but it also grants you more options in how to handle the serialization, making it possible to support types that Unity can't serialize automatically. If you derive from Initializer<,,,,,> instead, then these things will be handled for you.

Template Parameters

TClient	Type of the initialized client component.
TFirstArgument	Type of the first argument to pass to the client component's Init function.
TSecondArgument	Type of the second argument to pass to the client component's Init function.
TThirdArgument	Type of the third argument to pass to the client component's Init function.
TFourthArgument	Type of the fourth argument to pass to the client component's Init function.
TFifthArgument	Type of the fifth argument to pass to the client component's Init function.

Type Constraints

TClient	:	MonoBehaviour
TClient	:	IInitializable
TClient	:	TFirstArgument
TClient	:	TSecondArgument
TClient	:	TThirdArgument
TClient	:	TFourthArgument
TClient	:	TFifthArgument

Inheritance diagram for Sisus.Init.InitializerBase< TClient, TFirstArgument, TSecondArgument, TThirdArgument, TFourthArgument, TFifthArgument >:

Protected Member Functions
override TClient	InitTarget ([AllowNull] TClient target)
virtual void	OnReset (ref TFirstArgument firstArgument, ref TSecondArgument secondArgument, ref TThirdArgument thirdArgument, ref TFourthArgument fourthArgument, ref TFifthArgument fifthArgument)
	Resets the Init arguments to their default values.

Properties
TFirstArgument	FirstArgument [get, set]
	The first argument passed to the TClient client's Init function.
TSecondArgument	SecondArgument [get, set]
	The second argument passed to the TClient client's Init function.
TThirdArgument	ThirdArgument [get, set]
	The third argument passed to the TClient client's Init function.
TFourthArgument	FourthArgument [get, set]
	The fourth argument passed to the TClient client's Init function.
TFifthArgument	FifthArgument [get, set]
	The fifth argument passed to the TClient client's Init function.
Properties inherited from Sisus.Init.IInitializer
Object	Target [get, set]
	Existing target instance to initialize, if any.
bool	ProvidesCustomInitArguments [get]
	Gets a value indicating whether this initializer is able to provide custom per-instance Init arguments for its client.

Additional Inherited Members
Public Member Functions inherited from Sisus.Init.IInitializer< TClient >
new TClient	InitTarget ()
	Initializes the client object of type TClient with the arguments specified by this initializer.
new System.Threading.Tasks.Task< TClient >	InitTargetAsync ()
	Initializes the client object of type TClient asynchronously with the arguments specified by this initializer.
Public Member Functions inherited from Sisus.Init.IInitializer
bool	TargetIsAssignableOrConvertibleToType (Type type)
	Gets a value indicating whether an object of the given type can be assigned to the Target property directly, or if type implements IValueProvider<T>, IValueByTypeProvider or IValueByTypeProviderAsync.