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

One Item Properties row inside an encounter template. More...

#include <IEncTemplateItemPropertiesOb.h>

Public Types

enum  CurrencyType { Currency_PP = 0 , Currency_GP = 1 , Currency_SP = 2 , Currency_CP = 3 }
 Currency-type encoding (matches CR's dialog drop-down). More...

Public Member Functions

virtual ~IEncTemplateItemPropertiesOb ()
virtual long GetPercentChance () const =0
 Percent chance (0..100) the item appears when the template fires.
virtual bool SetPercentChance (long v)=0
 Set percent chance.
virtual long GetNumItemsDieN () const =0
 Number-of-items die N.
virtual long GetNumItemsDieS () const =0
 Number-of-items die S.
virtual long GetNumItemsDieM () const =0
 Number-of-items die M.
virtual long GetNumItemsDieA () const =0
 Number-of-items die A.
virtual bool SetNumItemsDieN (long v)=0
 Set num-items die N (number of dice).
virtual bool SetNumItemsDieS (long v)=0
 Set num-items die S (sides).
virtual bool SetNumItemsDieM (long v)=0
 Set num-items die M (multiplier).
virtual bool SetNumItemsDieA (long v)=0
 Set num-items die A (adds).
virtual long GetCurrencyType () const =0
 Currency type (Currency_PP / Currency_GP / Currency_SP / Currency_CP).
virtual bool SetCurrencyType (long v)=0
 Set currency type.
virtual long GetCurrencyDieN () const =0
 Currency die N.
virtual long GetCurrencyDieS () const =0
 Currency die S.
virtual long GetCurrencyDieM () const =0
 Currency die M.
virtual long GetCurrencyDieA () const =0
 Currency die A.
virtual bool SetCurrencyDieN (long v)=0
 Set currency die N (number of dice).
virtual bool SetCurrencyDieS (long v)=0
 Set currency die S (sides).
virtual bool SetCurrencyDieM (long v)=0
 Set currency die M (multiplier).
virtual bool SetCurrencyDieA (long v)=0
 Set currency die A (adds).
virtual long GetDependentFlag () const =0
 Dependent-on flag.
virtual long GetForEvery () const =0
 "For every" multiplier.
virtual long GetBeyond () const =0
 "Beyond" threshold.
virtual bool SetDependentFlag (long v)=0
 Set dependent flag.
virtual bool SetForEvery (long v)=0
 Set "for every".
virtual bool SetBeyond (long v)=0
 Set "beyond".
virtual const IMonsterOb * GetDependentMonster () const =0
 Embedded dependent-monster reference (read-only view).
virtual IMonsterOb * GetDependentMonster ()=0
 Embedded dependent-monster reference (mutable view).
virtual bool CopyDependentMonsterFrom (const IMonsterOb *src)=0
 Deep-copy src into this row's dependent-monster slot.
virtual const IMonsterTypeOb * GetDependentType () const =0
 Embedded dependent-type reference (read-only).
virtual IMonsterTypeOb * GetDependentType ()=0
 Embedded dependent-type reference (mutable).
virtual bool CopyDependentTypeFrom (const IMonsterTypeOb *src)=0
 Deep-copy src into this row's dependent-type slot.
virtual const IPart * GetItemPart () const =0
 Embedded item-part reference (the actual item, e.g. "Cart"; read-only).
virtual IPart * GetItemPart ()=0
 Embedded item-part reference (mutable).
virtual bool CopyItemPartFrom (const IPart *src)=0
 Deep-copy src into this row's item-part slot.
virtual int GetDoubleMonsterCount () const =0
 Number of monster names whose count is doubled.
virtual const char * GetDoubleMonster (int index) const =0
 Monster name at index.
virtual bool AddDoubleMonster (const char *name)=0
 Append a monster name to the doubled-count list.
virtual bool RemoveDoubleMonsterAt (int index)=0
 Remove the doubled-count entry at index.
virtual void ClearDoubleMonsters ()=0
 Remove every doubled-count entry.
virtual int GetEscortCount () const =0
 Number of escort-monster entries.
virtual const IEncTemplateNumAppearOb * GetEscort (int index) const =0
 Escort entry at index (read-only).
virtual IEncTemplateNumAppearOb * GetEscort (int index)=0
 Escort entry at index (mutable).
virtual bool AddEscort (const IEncTemplateNumAppearOb *src)=0
 Append a deep copy of src as an escort entry.
virtual bool RemoveEscortAt (int index)=0
 Remove escort entry at index.
virtual void ClearEscorts ()=0
 Remove all escort entries.
virtual int GetPerItemMonsterCount () const =0
 Number of per-item-monster entries.
virtual const IEncTemplateNumAppearOb * GetPerItemMonster (int index) const =0
 Per-item-monster entry at index (read-only).
virtual IEncTemplateNumAppearOb * GetPerItemMonster (int index)=0
 Per-item-monster entry at index (mutable).
virtual bool AddPerItemMonster (const IEncTemplateNumAppearOb *src)=0
 Append a deep copy of src as a per-item-monster entry.
virtual bool RemovePerItemMonsterAt (int index)=0
 Remove per-item-monster entry at index.
virtual void ClearPerItemMonsters ()=0
 Remove all per-item-monster entries.
virtual bool IsDirty () const =0
 Composite walk (own state + embedded monster/type/part + every array entry).
virtual void MarkClean ()=0
 Clear dirty flag (recursive).
virtual IEncTemplateItemPropertiesOb * Clone () const =0
 Deep copy.

Detailed Description

One Item Properties row inside an encounter template.

Member Enumeration Documentation

◆ CurrencyType

enum CoreRules::IEncTemplateItemPropertiesOb::CurrencyType

Currency-type encoding (matches CR's dialog drop-down).

Enumerator
Currency_PP 

Platinum pieces.

Currency_GP 

Gold pieces.

Currency_SP 

Silver pieces.

Currency_CP 

Copper pieces.

Constructor & Destructor Documentation

◆ ~IEncTemplateItemPropertiesOb()

virtual CoreRules::IEncTemplateItemPropertiesOb::~IEncTemplateItemPropertiesOb ( )
inlinevirtual

Member Function Documentation

◆ AddDoubleMonster()

virtual bool CoreRules::IEncTemplateItemPropertiesOb::AddDoubleMonster ( const char * name)
pure virtual

Append a monster name to the doubled-count list.

◆ AddEscort()

virtual bool CoreRules::IEncTemplateItemPropertiesOb::AddEscort ( const IEncTemplateNumAppearOb * src)
pure virtual

Append a deep copy of src as an escort entry.

◆ AddPerItemMonster()

virtual bool CoreRules::IEncTemplateItemPropertiesOb::AddPerItemMonster ( const IEncTemplateNumAppearOb * src)
pure virtual

Append a deep copy of src as a per-item-monster entry.

◆ ClearDoubleMonsters()

virtual void CoreRules::IEncTemplateItemPropertiesOb::ClearDoubleMonsters ( )
pure virtual

Remove every doubled-count entry.

◆ ClearEscorts()

virtual void CoreRules::IEncTemplateItemPropertiesOb::ClearEscorts ( )
pure virtual

Remove all escort entries.

◆ ClearPerItemMonsters()

virtual void CoreRules::IEncTemplateItemPropertiesOb::ClearPerItemMonsters ( )
pure virtual

Remove all per-item-monster entries.

◆ Clone()

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

Deep copy.

◆ CopyDependentMonsterFrom()

virtual bool CoreRules::IEncTemplateItemPropertiesOb::CopyDependentMonsterFrom ( const IMonsterOb * src)
pure virtual

Deep-copy src into this row's dependent-monster slot.

◆ CopyDependentTypeFrom()

virtual bool CoreRules::IEncTemplateItemPropertiesOb::CopyDependentTypeFrom ( const IMonsterTypeOb * src)
pure virtual

Deep-copy src into this row's dependent-type slot.

◆ CopyItemPartFrom()

virtual bool CoreRules::IEncTemplateItemPropertiesOb::CopyItemPartFrom ( const IPart * src)
pure virtual

Deep-copy src into this row's item-part slot.

◆ GetBeyond()

virtual long CoreRules::IEncTemplateItemPropertiesOb::GetBeyond ( ) const
pure virtual

"Beyond" threshold.

◆ GetCurrencyDieA()

virtual long CoreRules::IEncTemplateItemPropertiesOb::GetCurrencyDieA ( ) const
pure virtual

Currency die A.

◆ GetCurrencyDieM()

virtual long CoreRules::IEncTemplateItemPropertiesOb::GetCurrencyDieM ( ) const
pure virtual

Currency die M.

◆ GetCurrencyDieN()

virtual long CoreRules::IEncTemplateItemPropertiesOb::GetCurrencyDieN ( ) const
pure virtual

Currency die N.

◆ GetCurrencyDieS()

virtual long CoreRules::IEncTemplateItemPropertiesOb::GetCurrencyDieS ( ) const
pure virtual

Currency die S.

◆ GetCurrencyType()

virtual long CoreRules::IEncTemplateItemPropertiesOb::GetCurrencyType ( ) const
pure virtual

Currency type (Currency_PP / Currency_GP / Currency_SP / Currency_CP).

◆ GetDependentFlag()

virtual long CoreRules::IEncTemplateItemPropertiesOb::GetDependentFlag ( ) const
pure virtual

Dependent-on flag.

◆ GetDependentMonster() [1/2]

virtual const IMonsterOb * CoreRules::IEncTemplateItemPropertiesOb::GetDependentMonster ( ) const
pure virtual

Embedded dependent-monster reference (read-only view).

◆ GetDependentMonster() [2/2]

virtual IMonsterOb * CoreRules::IEncTemplateItemPropertiesOb::GetDependentMonster ( )
pure virtual

Embedded dependent-monster reference (mutable view).

◆ GetDependentType() [1/2]

virtual const IMonsterTypeOb * CoreRules::IEncTemplateItemPropertiesOb::GetDependentType ( ) const
pure virtual

Embedded dependent-type reference (read-only).

◆ GetDependentType() [2/2]

virtual IMonsterTypeOb * CoreRules::IEncTemplateItemPropertiesOb::GetDependentType ( )
pure virtual

Embedded dependent-type reference (mutable).

◆ GetDoubleMonster()

virtual const char * CoreRules::IEncTemplateItemPropertiesOb::GetDoubleMonster ( int index) const
pure virtual

Monster name at index.

◆ GetDoubleMonsterCount()

virtual int CoreRules::IEncTemplateItemPropertiesOb::GetDoubleMonsterCount ( ) const
pure virtual

Number of monster names whose count is doubled.

◆ GetEscort() [1/2]

virtual const IEncTemplateNumAppearOb * CoreRules::IEncTemplateItemPropertiesOb::GetEscort ( int index) const
pure virtual

Escort entry at index (read-only).

◆ GetEscort() [2/2]

virtual IEncTemplateNumAppearOb * CoreRules::IEncTemplateItemPropertiesOb::GetEscort ( int index)
pure virtual

Escort entry at index (mutable).

◆ GetEscortCount()

virtual int CoreRules::IEncTemplateItemPropertiesOb::GetEscortCount ( ) const
pure virtual

Number of escort-monster entries.

◆ GetForEvery()

virtual long CoreRules::IEncTemplateItemPropertiesOb::GetForEvery ( ) const
pure virtual

"For every" multiplier.

◆ GetItemPart() [1/2]

virtual const IPart * CoreRules::IEncTemplateItemPropertiesOb::GetItemPart ( ) const
pure virtual

Embedded item-part reference (the actual item, e.g. "Cart"; read-only).

◆ GetItemPart() [2/2]

virtual IPart * CoreRules::IEncTemplateItemPropertiesOb::GetItemPart ( )
pure virtual

Embedded item-part reference (mutable).

◆ GetNumItemsDieA()

virtual long CoreRules::IEncTemplateItemPropertiesOb::GetNumItemsDieA ( ) const
pure virtual

Number-of-items die A.

◆ GetNumItemsDieM()

virtual long CoreRules::IEncTemplateItemPropertiesOb::GetNumItemsDieM ( ) const
pure virtual

Number-of-items die M.

◆ GetNumItemsDieN()

virtual long CoreRules::IEncTemplateItemPropertiesOb::GetNumItemsDieN ( ) const
pure virtual

Number-of-items die N.

◆ GetNumItemsDieS()

virtual long CoreRules::IEncTemplateItemPropertiesOb::GetNumItemsDieS ( ) const
pure virtual

Number-of-items die S.

◆ GetPercentChance()

virtual long CoreRules::IEncTemplateItemPropertiesOb::GetPercentChance ( ) const
pure virtual

Percent chance (0..100) the item appears when the template fires.

◆ GetPerItemMonster() [1/2]

virtual const IEncTemplateNumAppearOb * CoreRules::IEncTemplateItemPropertiesOb::GetPerItemMonster ( int index) const
pure virtual

Per-item-monster entry at index (read-only).

◆ GetPerItemMonster() [2/2]

virtual IEncTemplateNumAppearOb * CoreRules::IEncTemplateItemPropertiesOb::GetPerItemMonster ( int index)
pure virtual

Per-item-monster entry at index (mutable).

◆ GetPerItemMonsterCount()

virtual int CoreRules::IEncTemplateItemPropertiesOb::GetPerItemMonsterCount ( ) const
pure virtual

Number of per-item-monster entries.

◆ IsDirty()

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

Composite walk (own state + embedded monster/type/part + every array entry).

◆ MarkClean()

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

Clear dirty flag (recursive).

◆ RemoveDoubleMonsterAt()

virtual bool CoreRules::IEncTemplateItemPropertiesOb::RemoveDoubleMonsterAt ( int index)
pure virtual

Remove the doubled-count entry at index.

◆ RemoveEscortAt()

virtual bool CoreRules::IEncTemplateItemPropertiesOb::RemoveEscortAt ( int index)
pure virtual

Remove escort entry at index.

◆ RemovePerItemMonsterAt()

virtual bool CoreRules::IEncTemplateItemPropertiesOb::RemovePerItemMonsterAt ( int index)
pure virtual

Remove per-item-monster entry at index.

◆ SetBeyond()

virtual bool CoreRules::IEncTemplateItemPropertiesOb::SetBeyond ( long v)
pure virtual

Set "beyond".

Returns
false if negative.

◆ SetCurrencyDieA()

virtual bool CoreRules::IEncTemplateItemPropertiesOb::SetCurrencyDieA ( long v)
pure virtual

Set currency die A (adds).

Returns
false if outside 0..1000000.

◆ SetCurrencyDieM()

virtual bool CoreRules::IEncTemplateItemPropertiesOb::SetCurrencyDieM ( long v)
pure virtual

Set currency die M (multiplier).

Returns
false if outside 1..1000.

◆ SetCurrencyDieN()

virtual bool CoreRules::IEncTemplateItemPropertiesOb::SetCurrencyDieN ( long v)
pure virtual

Set currency die N (number of dice).

Returns
false if outside 1..1000000.

◆ SetCurrencyDieS()

virtual bool CoreRules::IEncTemplateItemPropertiesOb::SetCurrencyDieS ( long v)
pure virtual

Set currency die S (sides).

Returns
false if outside 1..1000.

◆ SetCurrencyType()

virtual bool CoreRules::IEncTemplateItemPropertiesOb::SetCurrencyType ( long v)
pure virtual

Set currency type.

Returns
false if outside {0..3} (PP/GP/SP/CP).

◆ SetDependentFlag()

virtual bool CoreRules::IEncTemplateItemPropertiesOb::SetDependentFlag ( long v)
pure virtual

Set dependent flag.

Returns
false if not 0/1.

◆ SetForEvery()

virtual bool CoreRules::IEncTemplateItemPropertiesOb::SetForEvery ( long v)
pure virtual

Set "for every".

Returns
false if negative.

◆ SetNumItemsDieA()

virtual bool CoreRules::IEncTemplateItemPropertiesOb::SetNumItemsDieA ( long v)
pure virtual

Set num-items die A (adds).

Returns
false if outside 0..1000000.

◆ SetNumItemsDieM()

virtual bool CoreRules::IEncTemplateItemPropertiesOb::SetNumItemsDieM ( long v)
pure virtual

Set num-items die M (multiplier).

Returns
false if outside 1..1000.

◆ SetNumItemsDieN()

virtual bool CoreRules::IEncTemplateItemPropertiesOb::SetNumItemsDieN ( long v)
pure virtual

Set num-items die N (number of dice).

Returns
false if outside 1..1000000.

◆ SetNumItemsDieS()

virtual bool CoreRules::IEncTemplateItemPropertiesOb::SetNumItemsDieS ( long v)
pure virtual

Set num-items die S (sides).

Returns
false if outside 1..1000.

◆ SetPercentChance()

virtual bool CoreRules::IEncTemplateItemPropertiesOb::SetPercentChance ( long v)
pure virtual

Set percent chance.

Returns
false if outside 0..100.
The documentation for this class was generated from the following file: