CMessageProgressiveLoad Class Reference

Handle progressive loading of resources. More...

#include <MessageTypes.h>

Inheritance diagram for CMessageProgressiveLoad:

Public Member Functions
virtual int	GetType () const
virtual const char *	GetScriptHandlerName () const
virtual const char *	GetScriptGlobalHandlerName () const
virtual jsval	ToJSVal (ScriptInterface &scriptInterface) const
	CMessageProgressiveLoad (bool *progressed, int *total, int *progress)
Public Member Functions inherited from CMessage
virtual	~CMessage ()
jsval	ToJSValCached (ScriptInterface &) const

Static Public Member Functions
static CMessage *	FromJSVal (ScriptInterface &, jsval val)

Public Attributes
bool *	progressed
int *	total
int *	progress

Additional Inherited Members
Protected Member Functions inherited from CMessage
	CMessage ()

Detailed Description

Handle progressive loading of resources.

A component that listens to this message must do the following:

• Increase *msg.total by the non-zero number of loading tasks this component can perform.
• If *msg.progressed == true, return and do nothing.
• If you've loaded everything, increase *msg.progress by the value you added to .total
• Otherwise do some loading, set *msg.progressed = true, and increase *msg.progress by a value indicating how much progress you've made in total (0 <= p <= what you added to .total) In some situations these messages will never be sent - components must ensure they load all their data themselves before using it in that case.

Definition at line 171 of file MessageTypes.h.

Constructor & Destructor Documentation

CMessageProgressiveLoad::CMessageProgressiveLoad ( bool *  progressed, int *  total, int *  progress  )

inline

Definition at line 176 of file MessageTypes.h.

Member Function Documentation

CMessage * CMessageProgressiveLoad::FromJSVal ( ScriptInterface &  scriptInterface, jsval  val  )

static

Definition at line 135 of file MessageTypeConversions.cpp.

virtual const char* CMessageProgressiveLoad::GetScriptGlobalHandlerName ( ) const

inlinevirtual

Implements CMessage.

Definition at line 174 of file MessageTypes.h.

virtual const char* CMessageProgressiveLoad::GetScriptHandlerName ( ) const

inlinevirtual

Implements CMessage.

Definition at line 174 of file MessageTypes.h.

virtual int CMessageProgressiveLoad::GetType ( void  ) const

inlinevirtual

Implements CMessage.

Definition at line 174 of file MessageTypes.h.

jsval CMessageProgressiveLoad::ToJSVal ( ScriptInterface &  scriptInterface ) const

virtual

Implements CMessage.

Definition at line 129 of file MessageTypeConversions.cpp.

Member Data Documentation

int* CMessageProgressiveLoad::progress

Definition at line 183 of file MessageTypes.h.

bool* CMessageProgressiveLoad::progressed

Definition at line 181 of file MessageTypes.h.

int* CMessageProgressiveLoad::total

Definition at line 182 of file MessageTypes.h.

---

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

• /home/sathyam/0ad.svn/source/simulation2/MessageTypes.h
• /home/sathyam/0ad.svn/source/simulation2/scripting/MessageTypeConversions.cpp