Core Rules
WoTC AD&D 2nd Edition -- Drakein API Reference
Loading...
Searching...
No Matches
CoreRules::IPropertyOb Class Referenceabstract

#include <IPropertyOb.h>

Public Types

enum  OwnerKind {
  Owner_None = 0 , Owner_Unknown = 1 , Owner_Family = 2 , Owner_Character = 3 ,
  Owner_Party = 4
}
 Discriminator for m_owner_id – what kind of catalog the owner-id indexes into. More...

Public Member Functions

virtual ~IPropertyOb ()
virtual long GetId () const =0
virtual int GetOwnerKind () const =0
virtual long GetOwnerId () const =0
virtual const char * GetOwnerName () const =0
virtual bool SetOwner (int kind, long id)=0
 Set kind + id together.
virtual void SetOwnerParty (const char *party_name)=0
 Set the owner as Party-by-name.
virtual const char * GetName () const =0
virtual void SetName (const char *v)=0
virtual const char * GetLocation () const =0
virtual void SetLocation (const char *v)=0
virtual const IDateOb * GetDateAcquired () const =0
virtual IDateOb * GetDateAcquired ()=0
virtual void SetDateAcquired (const IDateOb *v)=0
virtual const IDateOb * GetDateDisposed () const =0
virtual IDateOb * GetDateDisposed ()=0
virtual void SetDateDisposed (const IDateOb *v)=0
virtual long long GetPrice () const =0
virtual bool SetPrice (long long v)=0
virtual const char * GetDispositionMethod () const =0
virtual void SetDispositionMethod (const char *v)=0
virtual bool IsDirty () const =0
virtual void MarkClean ()=0
virtual IPropertyOb * Clone () const =0

Member Enumeration Documentation

◆ OwnerKind

enum CoreRules::IPropertyOb::OwnerKind

Discriminator for m_owner_id – what kind of catalog the owner-id indexes into.

Property is single-source-of-truth for ownership (the property record carries the owner; owners don't carry property lists). See [[drakein-consolidated-sdk-file]] for the design rationale.

Enumerator
Owner_None 

deliberately unowned (abandoned / lost in a way the DM accepts)

Owner_Unknown 

self-heal: owner couldn't be resolved at load; needs DM attention

Owner_Family 

owner_id is a CFamilyOb::m_id

Owner_Character 

owner_id is a CCharacter_Extension::m_character_id

Owner_Party 

owner_id is a CCharacter_Party::m_id

Constructor & Destructor Documentation

◆ ~IPropertyOb()

virtual CoreRules::IPropertyOb::~IPropertyOb ( )
inlinevirtual

Member Function Documentation

◆ Clone()

virtual IPropertyOb * CoreRules::IPropertyOb::Clone ( ) const
pure virtual

◆ GetDateAcquired() [1/2]

virtual const IDateOb * CoreRules::IPropertyOb::GetDateAcquired ( ) const
pure virtual

◆ GetDateAcquired() [2/2]

virtual IDateOb * CoreRules::IPropertyOb::GetDateAcquired ( )
pure virtual

◆ GetDateDisposed() [1/2]

virtual const IDateOb * CoreRules::IPropertyOb::GetDateDisposed ( ) const
pure virtual

◆ GetDateDisposed() [2/2]

virtual IDateOb * CoreRules::IPropertyOb::GetDateDisposed ( )
pure virtual

◆ GetDispositionMethod()

virtual const char * CoreRules::IPropertyOb::GetDispositionMethod ( ) const
pure virtual

◆ GetId()

virtual long CoreRules::IPropertyOb::GetId ( ) const
pure virtual

◆ GetLocation()

virtual const char * CoreRules::IPropertyOb::GetLocation ( ) const
pure virtual

◆ GetName()

virtual const char * CoreRules::IPropertyOb::GetName ( ) const
pure virtual

◆ GetOwnerId()

virtual long CoreRules::IPropertyOb::GetOwnerId ( ) const
pure virtual

◆ GetOwnerKind()

virtual int CoreRules::IPropertyOb::GetOwnerKind ( ) const
pure virtual

◆ GetOwnerName()

virtual const char * CoreRules::IPropertyOb::GetOwnerName ( ) const
pure virtual

◆ GetPrice()

virtual long long CoreRules::IPropertyOb::GetPrice ( ) const
pure virtual

◆ IsDirty()

virtual bool CoreRules::IPropertyOb::IsDirty ( ) const
pure virtual

◆ MarkClean()

virtual void CoreRules::IPropertyOb::MarkClean ( )
pure virtual

◆ SetDateAcquired()

virtual void CoreRules::IPropertyOb::SetDateAcquired ( const IDateOb * v)
pure virtual

◆ SetDateDisposed()

virtual void CoreRules::IPropertyOb::SetDateDisposed ( const IDateOb * v)
pure virtual

◆ SetDispositionMethod()

virtual void CoreRules::IPropertyOb::SetDispositionMethod ( const char * v)
pure virtual

◆ SetLocation()

virtual void CoreRules::IPropertyOb::SetLocation ( const char * v)
pure virtual

◆ SetName()

virtual void CoreRules::IPropertyOb::SetName ( const char * v)
pure virtual

◆ SetOwner()

virtual bool CoreRules::IPropertyOb::SetOwner ( int kind,
long id )
pure virtual

Set kind + id together.

Used for None/Unknown (both fields zeroed/cleared) and Family/Character (id matters, name cleared). Passing Owner_Party here is a no-op for safety; use SetOwnerParty(name) instead.

◆ SetOwnerParty()

virtual void CoreRules::IPropertyOb::SetOwnerParty ( const char * party_name)
pure virtual

Set the owner as Party-by-name.

Stores the party name verbatim; zeroes owner_id. Pass a null or empty string to clear (collapses to Owner_None).

◆ SetPrice()

virtual bool CoreRules::IPropertyOb::SetPrice ( long long v)
pure virtual
The documentation for this class was generated from the following file: