C#Code
C#Code
Public Member Functions | Private Attributes
Libraries.Timers.ListFrameTimer Class Reference
Inheritance diagram for Libraries.Timers.ListFrameTimer:
Libraries.Timers.BaseFrameTimer Libraries.Timers.BaseFrameTimer

List of all members.

Public Member Functions

 ListFrameTimer ()
override void Update (UInt32 timePassed)
bool AddFrameToEnd (Object objStore, UInt32 timeLasts)
override int GetNumFrames ()
override object GetCurrFrameData ()
 ListFrameTimer ()
override void Update (UInt32 timePassed)
bool AddFrameToEnd (Object objStore, UInt32 timeLasts)
override int GetNumFrames ()
override object GetCurrFrameData ()

Private Attributes

List< Framem_frames
 Stores the frames in the timer.

Detailed Description

A frame timer that stores its frames in a list.


Constructor & Destructor Documentation

Libraries.Timers.ListFrameTimer.ListFrameTimer ( )

Default constructor.

Libraries.Timers.ListFrameTimer.ListFrameTimer ( )

Default constructor.


Member Function Documentation

bool Libraries.Timers.ListFrameTimer.AddFrameToEnd ( Object  objStore,
UInt32  timeLasts 
)

Add a frame with the given data to the end of the timer. Frame becomes the last frame in the timer. It will not add to a timer that has been started already.

objStore - Data object to store in the frame.
timeLasts - How long the frame lasts.

Return:
Value is true if the frame was added, false if not.
bool Libraries.Timers.ListFrameTimer.AddFrameToEnd ( Object  objStore,
UInt32  timeLasts 
)

Add a frame with the given data to the end of the timer. Frame becomes the last frame in the timer. It will not add to a timer that has been started already.

objStore - Data object to store in the frame.
timeLasts - How long the frame lasts.

Return:
Value is true if the frame was added, false if not.
override object Libraries.Timers.ListFrameTimer.GetCurrFrameData ( ) [virtual]

Retrive the object stored in the frame data for the current frame.

Return:
Value is the object if the current frame is valid, null if not.

Implements Libraries.Timers.BaseFrameTimer.

override object Libraries.Timers.ListFrameTimer.GetCurrFrameData ( ) [virtual]

Retrive the object stored in the frame data for the current frame.

Return:
Value is the object if the current frame is valid, null if not.

Implements Libraries.Timers.BaseFrameTimer.

override int Libraries.Timers.ListFrameTimer.GetNumFrames ( ) [virtual]

Set wether the timer loops. If the timer was finished and looping gts turned on, finished flag gets cleared.

loop - True if the timer should loop, false if not.

Implements Libraries.Timers.BaseFrameTimer.

override int Libraries.Timers.ListFrameTimer.GetNumFrames ( ) [virtual]

Set wether the timer loops. If the timer was finished and looping gts turned on, finished flag gets cleared.

loop - True if the timer should loop, false if not.

Implements Libraries.Timers.BaseFrameTimer.

override void Libraries.Timers.ListFrameTimer.Update ( UInt32  timePassed) [virtual]

Update the frame timer. Determine what the current frame is.

timePassed - How much time has passed to use for the update.

Implements Libraries.Timers.BaseFrameTimer.

override void Libraries.Timers.ListFrameTimer.Update ( UInt32  timePassed) [virtual]

Update the frame timer. Determine what the current frame is.

timePassed - How much time has passed to use for the update.

Implements Libraries.Timers.BaseFrameTimer.


Member Data Documentation

Stores the frames in the timer.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Enumerations Properties