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

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

#include <IEncTemplateMonsterPropertiesOb.h>

Public Member Functions

virtual ~IEncTemplateMonsterPropertiesOb ()
virtual long GetSelectionDieN () const =0
 Selection die N component.
virtual long GetSelectionDieS () const =0
 Selection die S component.
virtual long GetSelectionDieM () const =0
 Selection die M component.
virtual long GetSelectionDieA () const =0
 Selection die A component.
virtual bool SetSelectionDieN (long v)=0
 Set selection die N (number of dice).
virtual bool SetSelectionDieS (long v)=0
 Set selection die S (sides).
virtual bool SetSelectionDieM (long v)=0
 Set selection die M (multiplier).
virtual bool SetSelectionDieA (long v)=0
 Set selection die A (adds).
virtual long GetAdditionalDieN () const =0
 Additional-monsters die N component.
virtual long GetAdditionalDieS () const =0
 Additional-monsters die S component.
virtual long GetAdditionalDieM () const =0
 Additional-monsters die M component.
virtual long GetAdditionalDieA () const =0
 Additional-monsters die A component.
virtual bool SetAdditionalDieN (long v)=0
 Set additional die N (number of dice).
virtual bool SetAdditionalDieS (long v)=0
 Set additional die S (sides).
virtual bool SetAdditionalDieM (long v)=0
 Set additional die M (multiplier).
virtual bool SetAdditionalDieA (long v)=0
 Set additional die A (adds).
virtual long GetDependentFlag () const =0
 "Dependent on the following" flag.
virtual long GetAndFlag () const =0
 "And" selector flag.
virtual long GetOrFlag () const =0
 "Or" selector flag.
virtual long GetPercentChance () const =0
 Percentage chance these monsters appear.
virtual long GetForEvery () const =0
 "For every n dependent" multiplier.
virtual long GetBeyond () const =0
 "Beyond" threshold.
virtual bool SetDependentFlag (long v)=0
 Set dependent flag.
virtual bool SetAndFlag (long v)=0
 Set "and" flag.
virtual bool SetOrFlag (long v)=0
 Set "or" flag.
virtual bool SetPercentChance (long v)=0
 Set percentage chance.
virtual bool SetForEvery (long v)=0
 Set "for every".
virtual bool SetBeyond (long v)=0
 Set "beyond".
virtual const char * GetFixedMonsterName () const =0
 Fixed-monster name ("can't be removed" entry in the editor).
virtual bool SetFixedMonsterName (const char *v)=0
 Set fixed-monster name.
virtual const char * GetAndOrMonsterName () const =0
 Picker-driven And/Or monster name.
virtual bool SetAndOrMonsterName (const char *v)=0
 Set And/Or monster name.
virtual const char * GetDependentMonsterName () const =0
 Dependent monster name (empty if defined as type).
virtual bool SetDependentMonsterName (const char *v)=0
 Set dependent monster name.
virtual const char * GetMonsterTypeName () const =0
 Monster-type name (empty if defined as monster).
virtual bool SetMonsterTypeName (const char *v)=0
 Set monster-type name.
virtual const char * GetAlphaBitmap () const =0
 Alpha-channel bitmap filename (empty if defined as monster).
virtual void SetAlphaBitmap (const char *v)=0
 Set alpha bitmap filename.
virtual int GetAlphaIndex () const =0
 Alpha-channel index.
virtual void SetAlphaIndex (int v)=0
 Set alpha index.
virtual const char * GetActualBitmap () const =0
 Actual rendered bitmap filename (empty if defined as monster).
virtual void SetActualBitmap (const char *v)=0
 Set actual bitmap filename.
virtual int GetAppearingCount () const =0
 Number of appearing-monster entries (entry 0 is the fixed monster).
virtual const IMonsterOb * GetAppearing (int index) const =0
 Appearing monster at index (nullptr if out of range).
virtual IMonsterOb * GetAppearing (int index)=0
 Mutable view (mutate fields via the IMonsterOb interface).
virtual bool AddAppearing (const IMonsterOb *src)=0
 Append a deep copy of src to the array.
virtual bool RemoveAppearingAt (int index)=0
 Remove the appearing-monster at index (deletes the owned record).
virtual void ClearAppearing ()=0
 Remove and delete every appearing monster.
virtual bool IsDirty () const =0
 Composite walk (own state + every owned appearing monster).
virtual void MarkClean ()=0
 Clear dirty flag (recursive).
virtual IEncTemplateMonsterPropertiesOb * Clone () const =0
 Deep copy.

Detailed Description

One Monster Properties row inside an encounter template.

Constructor & Destructor Documentation

◆ ~IEncTemplateMonsterPropertiesOb()

virtual CoreRules::IEncTemplateMonsterPropertiesOb::~IEncTemplateMonsterPropertiesOb ( )
inlinevirtual

Member Function Documentation

◆ AddAppearing()

virtual bool CoreRules::IEncTemplateMonsterPropertiesOb::AddAppearing ( const IMonsterOb * src)
pure virtual

Append a deep copy of src to the array.

Returns
false if src is null.

◆ ClearAppearing()

virtual void CoreRules::IEncTemplateMonsterPropertiesOb::ClearAppearing ( )
pure virtual

Remove and delete every appearing monster.

◆ Clone()

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

Deep copy.

◆ GetActualBitmap()

virtual const char * CoreRules::IEncTemplateMonsterPropertiesOb::GetActualBitmap ( ) const
pure virtual

Actual rendered bitmap filename (empty if defined as monster).

◆ GetAdditionalDieA()

virtual long CoreRules::IEncTemplateMonsterPropertiesOb::GetAdditionalDieA ( ) const
pure virtual

Additional-monsters die A component.

◆ GetAdditionalDieM()

virtual long CoreRules::IEncTemplateMonsterPropertiesOb::GetAdditionalDieM ( ) const
pure virtual

Additional-monsters die M component.

◆ GetAdditionalDieN()

virtual long CoreRules::IEncTemplateMonsterPropertiesOb::GetAdditionalDieN ( ) const
pure virtual

Additional-monsters die N component.

◆ GetAdditionalDieS()

virtual long CoreRules::IEncTemplateMonsterPropertiesOb::GetAdditionalDieS ( ) const
pure virtual

Additional-monsters die S component.

◆ GetAlphaBitmap()

virtual const char * CoreRules::IEncTemplateMonsterPropertiesOb::GetAlphaBitmap ( ) const
pure virtual

Alpha-channel bitmap filename (empty if defined as monster).

◆ GetAlphaIndex()

virtual int CoreRules::IEncTemplateMonsterPropertiesOb::GetAlphaIndex ( ) const
pure virtual

Alpha-channel index.

◆ GetAndFlag()

virtual long CoreRules::IEncTemplateMonsterPropertiesOb::GetAndFlag ( ) const
pure virtual

"And" selector flag.

◆ GetAndOrMonsterName()

virtual const char * CoreRules::IEncTemplateMonsterPropertiesOb::GetAndOrMonsterName ( ) const
pure virtual

Picker-driven And/Or monster name.

◆ GetAppearing() [1/2]

virtual const IMonsterOb * CoreRules::IEncTemplateMonsterPropertiesOb::GetAppearing ( int index) const
pure virtual

Appearing monster at index (nullptr if out of range).

◆ GetAppearing() [2/2]

virtual IMonsterOb * CoreRules::IEncTemplateMonsterPropertiesOb::GetAppearing ( int index)
pure virtual

Mutable view (mutate fields via the IMonsterOb interface).

◆ GetAppearingCount()

virtual int CoreRules::IEncTemplateMonsterPropertiesOb::GetAppearingCount ( ) const
pure virtual

Number of appearing-monster entries (entry 0 is the fixed monster).

◆ GetBeyond()

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

"Beyond" threshold.

◆ GetDependentFlag()

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

"Dependent on the following" flag.

◆ GetDependentMonsterName()

virtual const char * CoreRules::IEncTemplateMonsterPropertiesOb::GetDependentMonsterName ( ) const
pure virtual

Dependent monster name (empty if defined as type).

◆ GetFixedMonsterName()

virtual const char * CoreRules::IEncTemplateMonsterPropertiesOb::GetFixedMonsterName ( ) const
pure virtual

Fixed-monster name ("can't be removed" entry in the editor).

◆ GetForEvery()

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

"For every n dependent" multiplier.

◆ GetMonsterTypeName()

virtual const char * CoreRules::IEncTemplateMonsterPropertiesOb::GetMonsterTypeName ( ) const
pure virtual

Monster-type name (empty if defined as monster).

◆ GetOrFlag()

virtual long CoreRules::IEncTemplateMonsterPropertiesOb::GetOrFlag ( ) const
pure virtual

"Or" selector flag.

◆ GetPercentChance()

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

Percentage chance these monsters appear.

◆ GetSelectionDieA()

virtual long CoreRules::IEncTemplateMonsterPropertiesOb::GetSelectionDieA ( ) const
pure virtual

Selection die A component.

◆ GetSelectionDieM()

virtual long CoreRules::IEncTemplateMonsterPropertiesOb::GetSelectionDieM ( ) const
pure virtual

Selection die M component.

◆ GetSelectionDieN()

virtual long CoreRules::IEncTemplateMonsterPropertiesOb::GetSelectionDieN ( ) const
pure virtual

Selection die N component.

◆ GetSelectionDieS()

virtual long CoreRules::IEncTemplateMonsterPropertiesOb::GetSelectionDieS ( ) const
pure virtual

Selection die S component.

◆ IsDirty()

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

Composite walk (own state + every owned appearing monster).

◆ MarkClean()

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

Clear dirty flag (recursive).

◆ RemoveAppearingAt()

virtual bool CoreRules::IEncTemplateMonsterPropertiesOb::RemoveAppearingAt ( int index)
pure virtual

Remove the appearing-monster at index (deletes the owned record).

◆ SetActualBitmap()

virtual void CoreRules::IEncTemplateMonsterPropertiesOb::SetActualBitmap ( const char * v)
pure virtual

Set actual bitmap filename.

◆ SetAdditionalDieA()

virtual bool CoreRules::IEncTemplateMonsterPropertiesOb::SetAdditionalDieA ( long v)
pure virtual

Set additional die A (adds).

Returns
false if outside 0..1000000.

◆ SetAdditionalDieM()

virtual bool CoreRules::IEncTemplateMonsterPropertiesOb::SetAdditionalDieM ( long v)
pure virtual

Set additional die M (multiplier).

Returns
false if outside 1..1000.

◆ SetAdditionalDieN()

virtual bool CoreRules::IEncTemplateMonsterPropertiesOb::SetAdditionalDieN ( long v)
pure virtual

Set additional die N (number of dice).

Returns
false if outside 1..1000000.

◆ SetAdditionalDieS()

virtual bool CoreRules::IEncTemplateMonsterPropertiesOb::SetAdditionalDieS ( long v)
pure virtual

Set additional die S (sides).

Returns
false if outside 1..1000.

◆ SetAlphaBitmap()

virtual void CoreRules::IEncTemplateMonsterPropertiesOb::SetAlphaBitmap ( const char * v)
pure virtual

Set alpha bitmap filename.

◆ SetAlphaIndex()

virtual void CoreRules::IEncTemplateMonsterPropertiesOb::SetAlphaIndex ( int v)
pure virtual

Set alpha index.

◆ SetAndFlag()

virtual bool CoreRules::IEncTemplateMonsterPropertiesOb::SetAndFlag ( long v)
pure virtual

Set "and" flag.

Returns
false if not 0/1.

◆ SetAndOrMonsterName()

virtual bool CoreRules::IEncTemplateMonsterPropertiesOb::SetAndOrMonsterName ( const char * v)
pure virtual

Set And/Or monster name.

Returns
false if non-empty and not in Monster_Record.

◆ SetBeyond()

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

Set "beyond".

Returns
false if negative.

◆ SetDependentFlag()

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

Set dependent flag.

Returns
false if not 0/1.

◆ SetDependentMonsterName()

virtual bool CoreRules::IEncTemplateMonsterPropertiesOb::SetDependentMonsterName ( const char * v)
pure virtual

Set dependent monster name.

Returns
false if non-empty and not in Monster_Record.

◆ SetFixedMonsterName()

virtual bool CoreRules::IEncTemplateMonsterPropertiesOb::SetFixedMonsterName ( const char * v)
pure virtual

Set fixed-monster name.

Returns
false if non-empty and not in Monster_Record.

◆ SetForEvery()

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

Set "for every".

Returns
false if negative.

◆ SetMonsterTypeName()

virtual bool CoreRules::IEncTemplateMonsterPropertiesOb::SetMonsterTypeName ( const char * v)
pure virtual

Set monster-type name.

Returns
false if non-empty and not in MonsterType_Record.

◆ SetOrFlag()

virtual bool CoreRules::IEncTemplateMonsterPropertiesOb::SetOrFlag ( long v)
pure virtual

Set "or" flag.

Returns
false if not 0/1.

◆ SetPercentChance()

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

Set percentage chance.

Returns
false if outside 0..100.

◆ SetSelectionDieA()

virtual bool CoreRules::IEncTemplateMonsterPropertiesOb::SetSelectionDieA ( long v)
pure virtual

Set selection die A (adds).

Returns
false if outside 0..1000000.

◆ SetSelectionDieM()

virtual bool CoreRules::IEncTemplateMonsterPropertiesOb::SetSelectionDieM ( long v)
pure virtual

Set selection die M (multiplier).

Returns
false if outside 1..1000.

◆ SetSelectionDieN()

virtual bool CoreRules::IEncTemplateMonsterPropertiesOb::SetSelectionDieN ( long v)
pure virtual

Set selection die N (number of dice).

Returns
false if outside 1..1000000.

◆ SetSelectionDieS()

virtual bool CoreRules::IEncTemplateMonsterPropertiesOb::SetSelectionDieS ( long v)
pure virtual

Set selection die S (sides).

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