Drag[en]gine Game Engine  1.21
deNetworkState Class Reference

Network State Class. More...

#include <deNetworkState.h>

Inheritance diagram for deNetworkState:
deResource deObject

Public Types

typedef deTObjectReference< deNetworkStateRef
 Type holding strong reference. More...
 
- Public Types inherited from deResource
typedef deTObjectReference< deResourceRef
 Type holding strong reference. More...
 
- Public Types inherited from deObject
typedef deTObjectReference< deObjectRef
 Type holding strong reference. More...
 

Public Member Functions

Management
bool IsValidParent (deResource *parent) const
 Resource is a valid parent. More...
 
bool GetReadOnly () const
 Network state is read only. More...
 
Values
int GetValueCount () const
 Count of values. More...
 
int IndexOfValue (deNetworkValue *value) const
 Index of value. More...
 
deNetworkValueGetValueAt (int index) const
 Value at index. More...
 
void AddValue (deNetworkValue *value)
 Add value. More...
 
void NotifyValueChanged (int index) const
 Notify network peer value changed. More...
 
void NotifyPrecisionChanged (int index) const
 Notify network peer precision changed. More...
 
System Peers
deBaseNetworkStateGetPeerNetwork () const
 Network system peer object. More...
 
void SetPeerNetwork (deBaseNetworkState *peer)
 Set network system peer object. More...
 
deBaseScriptingNetworkStateGetPeerScripting () const
 Scripting system peer object. More...
 
void SetPeerScripting (deBaseScriptingNetworkState *peer)
 Set scripting system peer object. More...
 
Linked List
deWorldGetParentWorld () const
 Parent world or NULL. More...
 
void SetParentWorld (deWorld *world)
 Set parent world or NULL. More...
 
deNetworkStateGetLLWorldPrev () const
 Previous networkState in the parent world linked list. More...
 
void SetLLWorldPrev (deNetworkState *networkState)
 Set next networkState in the parent world linked list. More...
 
deNetworkStateGetLLWorldNext () const
 Next networkState in the parent world linked list. More...
 
void SetLLWorldNext (deNetworkState *networkState)
 Set next networkState in the parent world linked list. More...
 
- Public Member Functions inherited from deResource
deResourceManagerGetResourceManager () const
 Resource manager or NULL if resource is leaking. More...
 
deEngineGetEngine () const
 Game engine object from resource manager. More...
 
deResourceGetLLManagerPrev () const
 Previous resource in the resource manager linked list. More...
 
void SetLLManagerPrev (deResource *resource)
 Set next resource in the resource manager linked list. More...
 
deResourceGetLLManagerNext () const
 Next resource in the resource manager linked list. More...
 
void SetLLManagerNext (deResource *resource)
 Set next resource in the resource manager linked list. More...
 
void MarkLeaking ()
 Marks the resource leaking. More...
 
 deResource (deResourceManager *resourceManager)
 Create resource. More...
 
- Public Member Functions inherited from deObject
int GetRefCount () const
 Reference count. More...
 
void AddReference ()
 Add reference increasing reference count by 1. More...
 
void FreeReference ()
 Decrease reference count by one and delete object if count reaches 0. More...
 
 deObject ()
 Create object with reference count of 1. More...
 

Constructors and Destructors

 deNetworkState (deNetworkStateManager *manager, bool readOnly)
 Create network state object. More...
 
virtual ~deNetworkState ()
 Clean up network state object. More...
 

Additional Inherited Members

- Protected Member Functions inherited from deResource
virtual ~deResource ()
 Clean up resource. More...
 
- Protected Member Functions inherited from deObject
virtual ~deObject ()
 Clean up object. More...
 

Detailed Description

Network State Class.

Stores the state of a game object. States can be positional if attached to a World or positionless if attached to a network player. Only attached network states are updated and monitored.

Member Typedef Documentation

◆ Ref

Type holding strong reference.

Constructor & Destructor Documentation

◆ deNetworkState()

deNetworkState::deNetworkState ( deNetworkStateManager manager,
bool  readOnly 
)

Create network state object.

◆ ~deNetworkState()

virtual deNetworkState::~deNetworkState ( )
protectedvirtual

Clean up network state object.

Note
Subclasses should set their destructor protected too to avoid users accidently deleting a reference counted object through the object pointer. Only FreeReference() is allowed to delete the object.

Member Function Documentation

◆ AddValue()

void deNetworkState::AddValue ( deNetworkValue value)

Add value.

◆ GetLLWorldNext()

deNetworkState* deNetworkState::GetLLWorldNext ( ) const
inline

Next networkState in the parent world linked list.

◆ GetLLWorldPrev()

deNetworkState* deNetworkState::GetLLWorldPrev ( ) const
inline

Previous networkState in the parent world linked list.

◆ GetParentWorld()

deWorld* deNetworkState::GetParentWorld ( ) const
inline

Parent world or NULL.

◆ GetPeerNetwork()

deBaseNetworkState* deNetworkState::GetPeerNetwork ( ) const
inline

Network system peer object.

◆ GetPeerScripting()

deBaseScriptingNetworkState* deNetworkState::GetPeerScripting ( ) const
inline

Scripting system peer object.

◆ GetReadOnly()

bool deNetworkState::GetReadOnly ( ) const
inline

Network state is read only.

◆ GetValueAt()

deNetworkValue* deNetworkState::GetValueAt ( int  index) const

Value at index.

◆ GetValueCount()

int deNetworkState::GetValueCount ( ) const

Count of values.

◆ IndexOfValue()

int deNetworkState::IndexOfValue ( deNetworkValue value) const

Index of value.

◆ IsValidParent()

bool deNetworkState::IsValidParent ( deResource parent) const

Resource is a valid parent.

◆ NotifyPrecisionChanged()

void deNetworkState::NotifyPrecisionChanged ( int  index) const

Notify network peer precision changed.

◆ NotifyValueChanged()

void deNetworkState::NotifyValueChanged ( int  index) const

Notify network peer value changed.

◆ SetLLWorldNext()

void deNetworkState::SetLLWorldNext ( deNetworkState networkState)

Set next networkState in the parent world linked list.

◆ SetLLWorldPrev()

void deNetworkState::SetLLWorldPrev ( deNetworkState networkState)

Set next networkState in the parent world linked list.

◆ SetParentWorld()

void deNetworkState::SetParentWorld ( deWorld world)

Set parent world or NULL.

◆ SetPeerNetwork()

void deNetworkState::SetPeerNetwork ( deBaseNetworkState peer)

Set network system peer object.

◆ SetPeerScripting()

void deNetworkState::SetPeerScripting ( deBaseScriptingNetworkState peer)

Set scripting system peer object.


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