AnimationTimer Class Reference

AnimationTimer class. More...

Inheritance diagram for AnimationTimer:

Protected Member Functions
void	AnimationTimer (int category=CALL_CATEGORY_SYSTEM)
void	~AnimationTimer ()
float	GetValue ()
	Returns actual animated value.
override bool	IsRunning ()
void	Run (float targetVal, Managed obj, string updateFunc, string finishedFunc, float startingVal=0, bool loop=false, float speed=1.0, Param params=null, int category=CALL_CATEGORY_SYSTEM)
override void	Tick (float timeslice)
	Ticks the timer, is called by timer subsystem.

Protected Attributes
string	m_FinishedFunction
ref Param	m_Params
Managed	m_TargetObject
string	m_UpdateFunction

Private Attributes
bool	m_Active
float	m_TargetValue
float	m_TargetValueOriginal
float	m_Value
Private Attributes inherited from TimerBase
string	m_function
ref Param	m_params
Managed	m_target

Additional Inherited Members
Private Member Functions inherited from TimerBase
void	OnTimer ()
void	Run (float duration, Managed obj, string fn_name, Param params=NULL, bool loop=false)
	Starts timer.
override void	Stop ()
void	Timer (int category=CALL_CATEGORY_SYSTEM)

Detailed Description

AnimationTimer class.

This timer is for animating float value.
usage:

class MyObject
{
   ref AnimationTimer myAnim;
   
   void MyObject()
   {
    myAnim = new AnimationTimer();
    myAnim.Run(60, this, "Refresh");
   }
 
   void Refresh()
   {
    Print(myAnim.GetValue());
   }
}; 

Definition at line 650 of file tools.c.

Constructor & Destructor Documentation

AnimationTimer()

void AnimationTimer ( int category = CALL_CATEGORY_SYSTEM )

inlineprotected

Definition at line 661 of file tools.c.

References CALL_CATEGORY_SYSTEM, and OnInit().

~AnimationTimer()

void ~AnimationTimer ( )

inlineprotected

Definition at line 666 of file tools.c.

References SetRunning().

Member Function Documentation

GetValue()

float GetValue ( )

inlineprotected

Returns actual animated value.

Definition at line 689 of file tools.c.

References m_Value.

IsRunning()

override bool IsRunning ( )

inlineprotected

Definition at line 693 of file tools.c.

References m_Active.

Run()

void Run ( float targetVal, Managed obj, string updateFunc, string finishedFunc, float startingVal = 0, bool loop = false, float speed = 1.0, Param params = null, int category = CALL_CATEGORY_SYSTEM )

inlineprotected

Definition at line 671 of file tools.c.

References CALL_CATEGORY_SYSTEM, m_Active, m_FinishedFunction, m_loop, m_Params, m_TargetObject, m_TargetValue, m_TargetValueOriginal, m_time, m_UpdateFunction, m_Value, and SetRunning().

Tick()

override void Tick ( float timeslice )

inlineprotected

Ticks the timer, is called by timer subsystem.

Definition at line 700 of file tools.c.

References Math::AbsFloat(), g_Game, m_Active, m_FinishedFunction, m_loop, m_Params, m_TargetObject, m_TargetValue, m_TargetValueOriginal, m_time, m_UpdateFunction, and m_Value.

Field Documentation

m_Active

bool m_Active

private

Definition at line 652 of file tools.c.

Referenced by IsRunning(), Run(), and Tick().

m_FinishedFunction

string m_FinishedFunction

protected

Definition at line 658 of file tools.c.

Referenced by Run(), and Tick().

m_Params

ref Param m_Params

protected

Definition at line 659 of file tools.c.

Referenced by Run(), and Tick().

m_TargetObject

Managed m_TargetObject

protected

Definition at line 656 of file tools.c.

Referenced by Run(), and Tick().

m_TargetValue

float m_TargetValue

private

Definition at line 653 of file tools.c.

Referenced by Run(), and Tick().

m_TargetValueOriginal

float m_TargetValueOriginal

private

Definition at line 654 of file tools.c.

Referenced by Run(), and Tick().

m_UpdateFunction

string m_UpdateFunction

protected

Definition at line 657 of file tools.c.

Referenced by Run(), and Tick().

m_Value

float m_Value

private

Definition at line 655 of file tools.c.

Referenced by GetValue(), Run(), and Tick().

---

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

• F:/Games/Dayz/scripts/3_game/tools/tools.c