RaTweening 1.0.0
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Member Functions | Properties | List of all members
RaTweening.RaTweenerComponent Class Reference

The Component that allows for making Tweens within the editor. This component is used to create tweens without code or have visual designers create tweens which are triggered by code This system uses RaTweening.Core.Elements.RaTweenerElementBase inheritors to serialize the data of tweens More...

Inheritance diagram for RaTweening.RaTweenerComponent:

Public Types

enum  PlayOption
 These enum values represent the options on which trigger the tween of the component should play Based on the Progressor chosen, the Play option will override the current tween or not
 
enum  StopOption
 These enum values represent the options on which trigger the tween of the component should stop
 
enum  Progressor
 These enum values represent what the PlayOption and StopOption will do on their triggers
 

Public Member Functions

void EditorPlay ()
 Plays the tween of the component without a return value so it can be referenced in UnityEvents

‍Note: This method is designed to be used within UnityEvents
Note: This stops the previous tween of the component if active


 
void EditorPause ()
 Pauses the tween of the component if it is playing without a return value so it can be referenced in UnityEvents

‍Note: This method is designed to be used within UnityEvents


 
void EditorResumeOrPlay ()
 Resumes the currently paused tween without a return value so it can be referenced in UnityEvents If the tween is no longer active due to completion or destruction, it plays a new tween instance.

‍Note: without a return value so it can be referenced in UnityEvents


 
void EditorResume ()
 Attempts to resume to paused tween of this component if able, without a return value so it can be referenced in UnityEvents

‍Note: without a return value so it can be referenced in UnityEvents


 
void EditorStop (bool rewind)
 Attempts to Stop the currently active tween if able, without a return value so it can be referenced in UnityEvents

‍Note: without a return value so it can be referenced in UnityEvents

More...
 
void EditorReset ()
 Attempts to Reset the currently active tween if able, without a return value so it can be referenced in UnityEvents

‍Note: without a return value so it can be referenced in UnityEvents


 
void EditorRewind ()
 Attempts to Rewind the currently active tween if able, without a return value so it can be referenced in UnityEvents

‍Note: This resets all timers and performs the inital evaluation.ep Note: without a return value so it can be referenced in UnityEvents


 
RaTweenBase CreateTweenInstance ()
 Create an instance of the tween defined within the component More...
 
RaTweenBase Play ()
 Plays the tween of the component

‍Note: This stops the previous tween of the component if active


 
bool Pause ()
 Pauses the tween of the component if it is playing

‍Note: See RaTweenBase.Pause()

More...
 
RaTweenBase ResumeOrPlay ()
 Resumes the currently paused tween. If the tween is no longer active due to completion or destruction, it plays a new tween instance.

‍Note: See RaTweenBase.Resume(bool)


 
bool Resume ()
 Attempts to resume the paused tween of this component if able.

‍Note: See RaTweenBase.Resume(bool)

More...
 
bool Rewind (bool inclDelay=true)
 Attempts to rewind tween of this component if able.

‍Note: This resets all timers and performs the inital evaluation.
Note: See RaTweenBase.Rewind(bool)

More...
 
bool Reset (bool resumeAfterReset=false)
 Attempts to reset tween of this component if able.

‍Note: With the default parameters, it will act as if the tween was freshly submitted to the system
Note: See RaTweenBase.Reset(bool)

More...
 
bool Stop (bool rewind=false)
 Attempts to Stop the currently active tween if able If reset is set to true, it also evaluates the tween to the first evaluation step More...
 

Protected Member Functions

void Awake ()
 
void Start ()
 
void OnEnable ()
 
void OnDisable ()
 
void OnDestroy ()
 

Properties

bool IsPlaying [get]
 Returns true if the tween which was started using this component is still playing
 
bool IsPaused [get]
 Returns true if the tween which was started using this component is paused
 
bool IsCompleted [get]
 Returns true if the tween which was started using this component has completed
 

Detailed Description

The Component that allows for making Tweens within the editor. This component is used to create tweens without code or have visual designers create tweens which are triggered by code This system uses RaTweening.Core.Elements.RaTweenerElementBase inheritors to serialize the data of tweens

Member Function Documentation

◆ CreateTweenInstance()

RaTweenBase RaTweening.RaTweenerComponent.CreateTweenInstance ( )

Create an instance of the tween defined within the component

Returns
The new tween instance

◆ EditorStop()

void RaTweening.RaTweenerComponent.EditorStop ( bool  rewind)

Attempts to Stop the currently active tween if able, without a return value so it can be referenced in UnityEvents

‍Note: without a return value so it can be referenced in UnityEvents

Parameters
rewindWhen set to True, it also evaluates the tween to the first evaluation step

◆ Pause()

bool RaTweening.RaTweenerComponent.Pause ( )

Pauses the tween of the component if it is playing

‍Note: See RaTweenBase.Pause()

Returns
True if the tween was successfully paused, false if no tween was active to pause

◆ Reset()

bool RaTweening.RaTweenerComponent.Reset ( bool  resumeAfterReset = false)

Attempts to reset tween of this component if able.

‍Note: With the default parameters, it will act as if the tween was freshly submitted to the system
Note: See RaTweenBase.Reset(bool)

Returns
True if the tween was resumed, else false

◆ Resume()

bool RaTweening.RaTweenerComponent.Resume ( )

Attempts to resume the paused tween of this component if able.

‍Note: See RaTweenBase.Resume(bool)

Returns
True if the tween was resumed, else false

◆ Rewind()

bool RaTweening.RaTweenerComponent.Rewind ( bool  inclDelay = true)

Attempts to rewind tween of this component if able.

‍Note: This resets all timers and performs the inital evaluation.
Note: See RaTweenBase.Rewind(bool)

Returns
True if the tween was resumed, else false

◆ Stop()

bool RaTweening.RaTweenerComponent.Stop ( bool  rewind = false)

Attempts to Stop the currently active tween if able If reset is set to true, it also evaluates the tween to the first evaluation step

Parameters
rewindTo apply the first evaluation of the tween
Returns
If the stop was successful