Sisus.Init.StateMachineBehaviourInitializerBase< TStateMachineBehaviour, TFirstArgument, TSecondArgument, TThirdArgument, TFourthArgument > Class Template Reference

Description

A base class for an animator component that can be used to specify the four arguments used to initialize a state machine behaviour of type TStateMachineBehaviour that implements IInitializable<TFirstArgument, TSecondArgument, TThirdArgument, TFourthArgument>.

The arguments are injected to the TStateMachineBehaviour client during the Awake event.

The client receives the argument via the Init method where it can assign them to a member field or property.

After the argument has been injected the initializer is removed from the GameObject that holds it.

When you derive your Initializer class from StateMachineBehaviourInitializerBase<,,,,> you are responsible for implementing the argument properties and serializing their value. 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 StateMachineBehaviourInitializer<,,,,> instead, then these things will be handled for you.

Template Parameters

TStateMachineBehaviour	Type of the initialized state machine behaviour client.
TFirstArgument	Type of the first argument to pass to the client's Init function.
TSecondArgument	Type of the second argument to pass to the client's Init function.
TThirdArgument	Type of the third argument to pass to the client's Init function.
TFourthArgument	Type of the fourth argument to pass to the client's Init function.

Type Constraints

TStateMachineBehaviour	:	StateMachineBehaviour
TStateMachineBehaviour	:	IInitializable
TStateMachineBehaviour	:	TFirstArgument
TStateMachineBehaviour	:	TSecondArgument
TStateMachineBehaviour	:	TThirdArgument
TStateMachineBehaviour	:	TFourthArgument

Inheritance diagram for Sisus.Init.StateMachineBehaviourInitializerBase< TStateMachineBehaviour, TFirstArgument, TSecondArgument, TThirdArgument, TFourthArgument >:

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

Properties
TFirstArgument	FirstArgument [get, set]
	The first argument passed to the TStateMachineBehaviour client's Init function.
TSecondArgument	SecondArgument [get, set]
	The second argument passed to the TStateMachineBehaviour client's Init function.
TThirdArgument	ThirdArgument [get, set]
	The third argument passed to the TStateMachineBehaviour client's Init function.
TFourthArgument	FourthArgument [get, set]
	The fourth argument passed to the TStateMachineBehaviour 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.