CoreRules::IEncounterMonsterPackageOb Class Reference

One monster group inside an encounter. More...

#include <IEncounterMonsterPackageOb.h>

Public Member Functions
virtual	~IEncounterMonsterPackageOb ()
virtual long	GetCount () const =0
	Number of monster instances appearing in this package.
virtual bool	SetCount (long v)=0
	Set count.
virtual const IMonsterOb *	GetMonsterDetails () const =0
	Embedded monster's stat block (read-only).
virtual IMonsterOb *	GetMonsterDetails ()=0
	Embedded monster's stat block (mutable – mutate in place).
virtual bool	CopyMonsterDetailsFrom (const IMonsterOb *src)=0
	Deep-copy another monster's state into this package's slot.
virtual int	GetHPRollCount () const =0
	Number of pre-rolled HP entries (typically matches GetCount()).
virtual const IEncounterMonHpOb *	GetHPRoll (int index) const =0
	HP-roll entry at index (read-only).
virtual IEncounterMonHpOb *	GetHPRoll (int index)=0
	HP-roll entry at index (mutable).
virtual bool	AddHPRoll (const IEncounterMonHpOb *src)=0
	Append a deep copy of src to the HP-roll array.
virtual bool	RemoveHPRollAt (int index)=0
	Remove HP-roll at index (deletes the owned record).
virtual void	ClearHPRolls ()=0
	Remove all HP rolls.
virtual bool	IsDirty () const =0
	Composite walk (own state + embedded monster + every HP roll).
virtual void	MarkClean ()=0
	Clear dirty flag (recursive).
virtual IEncounterMonsterPackageOb *	Clone () const =0
	Deep copy via Serialize round-trip.

Detailed Description

One monster group inside an encounter.

Constructor & Destructor Documentation

~IEncounterMonsterPackageOb()

virtual CoreRules::IEncounterMonsterPackageOb::~IEncounterMonsterPackageOb ( )

inlinevirtual

Member Function Documentation

AddHPRoll()

virtual bool CoreRules::IEncounterMonsterPackageOb::AddHPRoll ( const IEncounterMonHpOb * src )

pure virtual

Append a deep copy of src to the HP-roll array.

ClearHPRolls()

virtual void CoreRules::IEncounterMonsterPackageOb::ClearHPRolls ( )

pure virtual

Remove all HP rolls.

Clone()

virtual IEncounterMonsterPackageOb * CoreRules::IEncounterMonsterPackageOb::Clone ( ) const

pure virtual

Deep copy via Serialize round-trip.

CopyMonsterDetailsFrom()

virtual bool CoreRules::IEncounterMonsterPackageOb::CopyMonsterDetailsFrom ( const IMonsterOb * src )

pure virtual

Deep-copy another monster's state into this package's slot.

Returns

false if src is null.

GetCount()

virtual long CoreRules::IEncounterMonsterPackageOb::GetCount ( ) const

pure virtual

Number of monster instances appearing in this package.

GetHPRoll() [1/2]

virtual const IEncounterMonHpOb * CoreRules::IEncounterMonsterPackageOb::GetHPRoll ( int index ) const

pure virtual

HP-roll entry at index (read-only).

GetHPRoll() [2/2]

virtual IEncounterMonHpOb * CoreRules::IEncounterMonsterPackageOb::GetHPRoll ( int index )

pure virtual

HP-roll entry at index (mutable).

GetHPRollCount()

virtual int CoreRules::IEncounterMonsterPackageOb::GetHPRollCount ( ) const

pure virtual

Number of pre-rolled HP entries (typically matches GetCount()).

GetMonsterDetails() [1/2]

virtual const IMonsterOb * CoreRules::IEncounterMonsterPackageOb::GetMonsterDetails ( ) const

pure virtual

Embedded monster's stat block (read-only).

GetMonsterDetails() [2/2]

virtual IMonsterOb * CoreRules::IEncounterMonsterPackageOb::GetMonsterDetails ( )

pure virtual

Embedded monster's stat block (mutable – mutate in place).

IsDirty()

virtual bool CoreRules::IEncounterMonsterPackageOb::IsDirty ( ) const

pure virtual

Composite walk (own state + embedded monster + every HP roll).

MarkClean()

virtual void CoreRules::IEncounterMonsterPackageOb::MarkClean ( )

pure virtual

Clear dirty flag (recursive).

RemoveHPRollAt()

virtual bool CoreRules::IEncounterMonsterPackageOb::RemoveHPRollAt ( int index )

pure virtual

Remove HP-roll at index (deletes the owned record).

SetCount()

virtual bool CoreRules::IEncounterMonsterPackageOb::SetCount ( long v )

pure virtual

Set count.

Returns

false if v < 0.

---

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

• CoreRules/include/CoreRules/IEncounterMonsterPackageOb.h