Text Behaviour Profile is an asset that contains the concrete profile of the stacked text animation behaviour. More...

Inheritance diagram for Calcatz.Sequine.TextBehaviourProfile:

Public Member Functions
void	Reset ()

T	Add< T > ()
	Adds a TextBehaviourComponent to this Sequine Text Behaviour Profile. More...

TextBehaviourComponent	Add (Type type)
	Adds a TextBehaviourComponent to this Behaviour Profile. More...

void	Remove< T > ()
	Removes a TextBehaviourComponent from this Behaviour Profile. More...

void	Remove (Type type)
	Removes a TextBehaviourComponent from this Behaviour Profile. More...

bool	Has< T > ()
	Checks if this Behaviour Profile contains the TextBehaviourComponent you pass in. More...

bool	Has (Type type)
	Checks if this Behaviour Profile contains the TextBehaviourComponent you pass in. More...

bool	HasSubclassOf (Type type)
	Checks if this Behaviour Profile contains the TextBehaviourComponent, which is a subclass of type , that you pass in. More...

bool	TryGet< T > (out T component)
	Gets the TextBehaviourComponent of the specified type, if it exists. More...

bool	TryGet< T > (Type type, out T component)
	Gets the TextBehaviourComponent of the specified type, if it exists. More...

bool	TryGetSubclassOf< T > (Type type, out T component)
	Gets the See also TextBehaviourComponent , which is a subclass of type , if it exists. More...

bool	TryGetAllSubclassOf< T > (Type type, List< T > result)
	Gets all the See also TextBehaviourComponent that are subclasses of the specified type, if there are any. More...

Public Attributes
float	durationPerCharacter = 0.1f

float	delayPerCharacter = 0.05f

List< TextBehaviourComponent >	components = new List<TextBehaviourComponent>()
	A list of every setting that this Sequine Text Behaviour Profile stores. More...

bool	isDirty = true

Detailed Description

Text Behaviour Profile is an asset that contains the concrete profile of the stacked text animation behaviour.

Member Function Documentation

◆ Add()

TextBehaviourComponent Calcatz.Sequine.TextBehaviourProfile.Add ( Type type )

Adds a TextBehaviourComponent to this Behaviour Profile.

You can only have a single component of the same type per Behaviour Profile.

Parameters

type	A type that inherits from TextBehaviourComponent.
overrides	Specifies whether Unity should automatically override all the settings when you add a TextBehaviourComponent to the Behaviour Profile.

Returns: The instance created for the given type that has been added to the profile

Add<T>

◆ Add< T >()

T Calcatz.Sequine.TextBehaviourProfile.Add< T > ( )

Adds a TextBehaviourComponent to this Sequine Text Behaviour Profile.

You can only have a single component of the same type per Behaviour Profile.

Template Parameters

T	A type of TextBehaviourComponent.

Returns: The instance for the given type that you added to the Behaviour Profile

See also: Add

Type Constraints

T

:

TextBehaviourComponent

◆ Has()

bool Calcatz.Sequine.TextBehaviourProfile.Has ( Type type )

Checks if this Behaviour Profile contains the TextBehaviourComponent you pass in.

Parameters

type	A type that inherits from TextBehaviourComponent.

Returns: true if the TextBehaviourComponent exists in the Behaviour Profile, false otherwise.

See also: Has<T>, HasSubclassOf

◆ Has< T >()

bool Calcatz.Sequine.TextBehaviourProfile.Has< T > ( )

Checks if this Behaviour Profile contains the TextBehaviourComponent you pass in.

Template Parameters

T	A type of TextBehaviourComponent.

Returns: true if the TextBehaviourComponent exists in the Behaviour Profile, false otherwise.

See also: Has, HasSubclassOf

Type Constraints

T

:

TextBehaviourComponent

◆ HasSubclassOf()

bool Calcatz.Sequine.TextBehaviourProfile.HasSubclassOf ( Type type )

Checks if this Behaviour Profile contains the TextBehaviourComponent, which is a subclass of type , that you pass in.

Parameters

type	A type that inherits from TextBehaviourComponent.

Returns: true if the TextBehaviourComponent exists in the Behaviour Profile, false otherwise.

See also: Has, Has<T>

◆ Remove()

void Calcatz.Sequine.TextBehaviourProfile.Remove ( Type type )

Removes a TextBehaviourComponent from this Behaviour Profile.

This method does nothing if the type does not exist in the Behaviour Profile.

Parameters

type	A type that inherits from TextBehaviourComponent.

See also: Remove<T>

◆ Remove< T >()

void Calcatz.Sequine.TextBehaviourProfile.Remove< T > ( )

Removes a TextBehaviourComponent from this Behaviour Profile.

This method does nothing if the type does not exist in the Behaviour Profile.

Template Parameters

T	A type of TextBehaviourComponent.

See also: Remove

Type Constraints

T

:

TextBehaviourComponent

◆ Reset()

void Calcatz.Sequine.TextBehaviourProfile.Reset ( )

◆ TryGet< T >() [1/2]

bool Calcatz.Sequine.TextBehaviourProfile.TryGet< T > ( out T component )

Gets the TextBehaviourComponent of the specified type, if it exists.

Template Parameters

T	A type of TextBehaviourComponent.

Parameters

component The output argument that contains the TextBehaviourComponent or null.

Returns: true if the TextBehaviourComponent is in the Behaviour Profile, false otherwise.

See also: TryGet<T>(Type, out T), TryGetSubclassOf<T>, TryGetAllSubclassOf<T>

Type Constraints

T

:

TextBehaviourComponent

◆ TryGet< T >() [2/2]

bool Calcatz.Sequine.TextBehaviourProfile.TryGet< T >	(	Type	type,
		out T	component
	)

Gets the TextBehaviourComponent of the specified type, if it exists.

Template Parameters

T	A type of TextBehaviourComponent

Parameters

type	A type that inherits from TextBehaviourComponent.
component	The output argument that contains the TextBehaviourComponent or `null`.

Returns: true if the TextBehaviourComponent is in the Behaviour Profile, false otherwise.

See also: TryGet<T>(out T), TryGetSubclassOf<T>, TryGetAllSubclassOf<T>

Type Constraints

T

:

TextBehaviourComponent

◆ TryGetAllSubclassOf< T >()

bool Calcatz.Sequine.TextBehaviourProfile.TryGetAllSubclassOf< T >	(	Type	type,
		List< T >	result
	)

Gets all the

See also: TextBehaviourComponent

that are subclasses of the specified type, if there are any.

Template Parameters

T	A type of TextBehaviourComponent.

Parameters

type	A type that inherits from TextBehaviourComponent.
result	The output list that contains all the See also TextBehaviourComponent if any. Note that Unity does not clear this list.

Returns: true if any TextBehaviourComponent have been found in the profile, false otherwise.

See also: TryGet<T>(Type, out T), TryGet<T>(out T), TryGetSubclassOf<T>

Type Constraints

T

:

TextBehaviourComponent

◆ TryGetSubclassOf< T >()

bool Calcatz.Sequine.TextBehaviourProfile.TryGetSubclassOf< T >	(	Type	type,
		out T	component
	)

Gets the

See also: TextBehaviourComponent

, which is a subclass of type , if it exists.

Template Parameters

T	A type of TextBehaviourComponent.

Parameters

type	A type that inherits from TextBehaviourComponent.
component	The output argument that contains the TextBehaviourComponent or `null`.

Returns: true if the TextBehaviourComponent is in the Behaviour Profile, false otherwise.

See also: TryGet<T>(Type, out T), TryGet<T>(out T), TryGetAllSubclassOf<T>

Type Constraints

T

:

TextBehaviourComponent

Member Data Documentation

◆ components

List<TextBehaviourComponent> Calcatz.Sequine.TextBehaviourProfile.components = new List<TextBehaviourComponent>()

A list of every setting that this Sequine Text Behaviour Profile stores.

◆ delayPerCharacter

float Calcatz.Sequine.TextBehaviourProfile.delayPerCharacter = 0.05f

◆ durationPerCharacter

float Calcatz.Sequine.TextBehaviourProfile.durationPerCharacter = 0.1f

◆ isDirty

bool Calcatz.Sequine.TextBehaviourProfile.isDirty = true

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ Add()

◆ Add< T >()

◆ Has()

◆ Has< T >()

◆ HasSubclassOf()

◆ Remove()

◆ Remove< T >()

◆ Reset()

◆ TryGet< T >() [1/2]

◆ TryGet< T >() [2/2]

◆ TryGetAllSubclassOf< T >()

◆ TryGetSubclassOf< T >()

Member Data Documentation

◆ components

◆ delayPerCharacter

◆ durationPerCharacter

◆ isDirty