Pyrogenesis  trunk
Public Member Functions | List of all members
ICmpOwnership Class Referenceabstract

Player ownership. More...

#include <ICmpOwnership.h>

Inheritance diagram for ICmpOwnership:
Inheritance graph
[legend]
Collaboration diagram for ICmpOwnership:
Collaboration graph
[legend]

Public Member Functions

virtual player_id_t GetOwner () const =0
 
virtual void SetOwner (player_id_t playerID)=0
 
virtual void SetOwnerQuiet (player_id_t playerID)=0
 
- Public Member Functions inherited from IComponent
virtual ~IComponent ()
 
virtual void Init (const CParamNode &paramNode)=0
 
virtual void Deinit ()=0
 
virtual void HandleMessage (const CMessage &msg, bool global)
 
CEntityHandle GetEntityHandle () const
 
void SetEntityHandle (CEntityHandle ent)
 
entity_id_t GetEntityId () const
 
CEntityHandle GetSystemEntity () const
 
const CSimContextGetSimContext () const
 
void SetSimContext (const CSimContext &context)
 
virtual void Serialize (ISerializer &serialize)=0
 
virtual void Deserialize (const CParamNode &paramNode, IDeserializer &deserialize)=0
 
virtual bool NewJSObject (ScriptInterface &scriptInterface, JS::MutableHandleObject out) const
 Returns false by default, indicating that a scripted wrapper of this IComponent is not supported. More...
 
virtual JS::Value GetJSInstance () const
 
virtual int GetComponentTypeId () const =0
 

Additional Inherited Members

- Static Public Member Functions inherited from IComponent
static std::string GetSchema ()
 
static u8 GetSerializationVersion ()
 

Detailed Description

Player ownership.

Owner values are either a player ID (if >= 0), or unassigned (INVALID_PLAYER). Sends message OwnershipChanged after it changes.

Member Function Documentation

virtual player_id_t ICmpOwnership::GetOwner ( ) const
pure virtual

Implemented in CCmpOwnership.

virtual void ICmpOwnership::SetOwner ( player_id_t  playerID)
pure virtual

Implemented in CCmpOwnership.

virtual void ICmpOwnership::SetOwnerQuiet ( player_id_t  playerID)
pure virtual

Implemented in CCmpOwnership.


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