CoreRules::IEncTemplateNumAppearOb Class Reference

One escort/per-item monster entry (dice + monster reference). More...

#include <IEncTemplateNumAppearOb.h>

Public Member Functions
virtual	~IEncTemplateNumAppearOb ()
virtual long	GetDiceN () const =0
	Dice-N component of the Number-Appearing roll.
virtual long	GetDiceS () const =0
	Dice-S component.
virtual long	GetDiceM () const =0
	Dice-M (multiplier) component.
virtual long	GetDiceA () const =0
	Dice-A (adds) component.
virtual bool	SetDiceN (long v)=0
	Set dice-N (number of dice).
virtual bool	SetDiceS (long v)=0
	Set dice-S (sides).
virtual bool	SetDiceM (long v)=0
	Set dice-M (multiplier).
virtual bool	SetDiceA (long v)=0
	Set dice-A (adds).
virtual const IMonsterOb *	GetMonster () const =0
	The embedded monster's stat block (read-only).
virtual IMonsterOb *	GetMonster ()=0
	The embedded monster's stat block (mutable).
virtual bool	CopyMonsterFrom (const IMonsterOb *src)=0
	Deep-copy another monster's state into this entry's embedded slot.
virtual bool	IsDirty () const =0
	Composite dirty walk (own dice + embedded monster).
virtual void	MarkClean ()=0
	Clear dirty flag (recursive).
virtual IEncTemplateNumAppearOb *	Clone () const =0
	Deep copy via Serialize round-trip.

Detailed Description

One escort/per-item monster entry (dice + monster reference).

Created and owned by an IEncTemplateItemPropertiesOb; consumers don't construct these directly.

Constructor & Destructor Documentation

~IEncTemplateNumAppearOb()

virtual CoreRules::IEncTemplateNumAppearOb::~IEncTemplateNumAppearOb ( )

inlinevirtual

Member Function Documentation

Clone()

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

pure virtual

Deep copy via Serialize round-trip.

CopyMonsterFrom()

virtual bool CoreRules::IEncTemplateNumAppearOb::CopyMonsterFrom ( const IMonsterOb * src )

pure virtual

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

Returns

false if src is null.

GetDiceA()

virtual long CoreRules::IEncTemplateNumAppearOb::GetDiceA ( ) const

pure virtual

Dice-A (adds) component.

GetDiceM()

virtual long CoreRules::IEncTemplateNumAppearOb::GetDiceM ( ) const

pure virtual

Dice-M (multiplier) component.

GetDiceN()

virtual long CoreRules::IEncTemplateNumAppearOb::GetDiceN ( ) const

pure virtual

Dice-N component of the Number-Appearing roll.

GetDiceS()

virtual long CoreRules::IEncTemplateNumAppearOb::GetDiceS ( ) const

pure virtual

Dice-S component.

GetMonster() [1/2]

virtual const IMonsterOb * CoreRules::IEncTemplateNumAppearOb::GetMonster ( ) const

pure virtual

The embedded monster's stat block (read-only).

GetMonster() [2/2]

virtual IMonsterOb * CoreRules::IEncTemplateNumAppearOb::GetMonster ( )

pure virtual

The embedded monster's stat block (mutable).

IsDirty()

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

pure virtual

Composite dirty walk (own dice + embedded monster).

MarkClean()

virtual void CoreRules::IEncTemplateNumAppearOb::MarkClean ( )

pure virtual

Clear dirty flag (recursive).

SetDiceA()

virtual bool CoreRules::IEncTemplateNumAppearOb::SetDiceA ( long v )

pure virtual

Set dice-A (adds).

Returns

false if outside 0..1000000.

SetDiceM()

virtual bool CoreRules::IEncTemplateNumAppearOb::SetDiceM ( long v )

pure virtual

Set dice-M (multiplier).

Returns

false if outside 1..1000.

SetDiceN()

virtual bool CoreRules::IEncTemplateNumAppearOb::SetDiceN ( long v )

pure virtual

Set dice-N (number of dice).

Returns

false if outside 1..1000000.

SetDiceS()

virtual bool CoreRules::IEncTemplateNumAppearOb::SetDiceS ( long v )

pure virtual

Set dice-S (sides).

Returns

false if outside 1..1000.

---

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

• CoreRules/include/CoreRules/IEncTemplateNumAppearOb.h