CoreRules::IEncounterOb Class Reference

One encounter record. More...

#include <IEncounterOb.h>

Public Member Functions
virtual	~IEncounterOb ()=default
virtual const char *	GetName () const =0
	Encounter name (unique within Encounter_Record).
virtual bool	SetName (const char *v)=0
	Rename the encounter.
virtual const char *	GetType () const =0
	Encounter type (free-form classifier, e.g. "Wandering", "Lair").
virtual void	SetType (const char *v)=0
	Set encounter type.
virtual const char *	GetTemplateName () const =0
	Name of the encounter template this encounter was generated from.
virtual void	SetTemplateName (const char *v)=0
	Set template name.
virtual const char *	GetDescription () const =0
	Free-form description shown in the editor / runtime.
virtual void	SetDescription (const char *v)=0
	Set description.
virtual int	GetMonsterPackageCount () const =0
	Number of monster groups in this encounter.
virtual const IEncounterMonsterPackageOb *	GetMonsterPackage (int index) const =0
	Monster package at index (read-only).
virtual IEncounterMonsterPackageOb *	GetMonsterPackage (int index)=0
	Monster package at index (mutable).
virtual bool	AddMonsterPackage (const IEncounterMonsterPackageOb *src)=0
	Append a deep copy of src as a monster package.
virtual bool	RemoveMonsterPackageAt (int index)=0
	Remove monster package at index (deletes the owned record).
virtual void	ClearMonsterPackages ()=0
	Remove and delete every monster package.
virtual int	GetNPCPackageCount () const =0
	Number of NPC groups in this encounter.
virtual const IEncounterNPCPackageOb *	GetNPCPackage (int index) const =0
	NPC package at index (read-only).
virtual IEncounterNPCPackageOb *	GetNPCPackage (int index)=0
	NPC package at index (mutable).
virtual bool	AddNPCPackage (const IEncounterNPCPackageOb *src)=0
	Append a deep copy of src as an NPC package.
virtual bool	RemoveNPCPackageAt (int index)=0
	Remove NPC package at index.
virtual void	ClearNPCPackages ()=0
	Remove all NPC packages.
virtual int	GetTrapCount () const =0
	Number of traps in this encounter.
virtual const ITrapOb *	GetTrap (int index) const =0
	Trap at index (read-only).
virtual ITrapOb *	GetTrap (int index)=0
	Trap at index (mutable).
virtual bool	AddTrap (const ITrapOb *src)=0
	Append a deep copy of src as a trap.
virtual bool	RemoveTrapAt (int index)=0
	Remove trap at index.
virtual void	ClearTraps ()=0
	Remove all traps.
virtual const IInventoryBundle *	GetTreasure () const =0
	Treasure bundle (read-only).
virtual IInventoryBundle *	GetTreasure ()=0
	Treasure bundle (mutable – mutate via the bundle's own API).
virtual const IInventoryBundle *	GetAdditionalItems () const =0
	Additional-items bundle (read-only).
virtual IInventoryBundle *	GetAdditionalItems ()=0
	Additional-items bundle (mutable).
virtual bool	IsDirty () const =0
	Composite walk (own state + every owned sub-record + both bundles).
virtual void	MarkClean ()=0
	Clear dirty flag (recursive).
virtual IEncounterOb *	Clone () const =0
	Deep copy via Serialize round-trip.

Detailed Description

One encounter record.

Constructor & Destructor Documentation

~IEncounterOb()

virtual CoreRules::IEncounterOb::~IEncounterOb ( )

virtualdefault

Member Function Documentation

AddMonsterPackage()

virtual bool CoreRules::IEncounterOb::AddMonsterPackage ( const IEncounterMonsterPackageOb * src )

pure virtual

Append a deep copy of src as a monster package.

AddNPCPackage()

virtual bool CoreRules::IEncounterOb::AddNPCPackage ( const IEncounterNPCPackageOb * src )

pure virtual

Append a deep copy of src as an NPC package.

AddTrap()

virtual bool CoreRules::IEncounterOb::AddTrap ( const ITrapOb * src )

pure virtual

Append a deep copy of src as a trap.

ClearMonsterPackages()

virtual void CoreRules::IEncounterOb::ClearMonsterPackages ( )

pure virtual

Remove and delete every monster package.

ClearNPCPackages()

virtual void CoreRules::IEncounterOb::ClearNPCPackages ( )

pure virtual

Remove all NPC packages.

ClearTraps()

virtual void CoreRules::IEncounterOb::ClearTraps ( )

pure virtual

Remove all traps.

Clone()

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

pure virtual

Deep copy via Serialize round-trip.

GetAdditionalItems() [1/2]

virtual const IInventoryBundle * CoreRules::IEncounterOb::GetAdditionalItems ( ) const

pure virtual

Additional-items bundle (read-only).

GetAdditionalItems() [2/2]

virtual IInventoryBundle * CoreRules::IEncounterOb::GetAdditionalItems ( )

pure virtual

Additional-items bundle (mutable).

GetDescription()

virtual const char * CoreRules::IEncounterOb::GetDescription ( ) const

pure virtual

Free-form description shown in the editor / runtime.

GetMonsterPackage() [1/2]

virtual const IEncounterMonsterPackageOb * CoreRules::IEncounterOb::GetMonsterPackage ( int index ) const

pure virtual

Monster package at index (read-only).

GetMonsterPackage() [2/2]

virtual IEncounterMonsterPackageOb * CoreRules::IEncounterOb::GetMonsterPackage ( int index )

pure virtual

Monster package at index (mutable).

GetMonsterPackageCount()

virtual int CoreRules::IEncounterOb::GetMonsterPackageCount ( ) const

pure virtual

Number of monster groups in this encounter.

GetName()

virtual const char * CoreRules::IEncounterOb::GetName ( ) const

pure virtual

Encounter name (unique within Encounter_Record).

GetNPCPackage() [1/2]

virtual const IEncounterNPCPackageOb * CoreRules::IEncounterOb::GetNPCPackage ( int index ) const

pure virtual

NPC package at index (read-only).

GetNPCPackage() [2/2]

virtual IEncounterNPCPackageOb * CoreRules::IEncounterOb::GetNPCPackage ( int index )

pure virtual

NPC package at index (mutable).

GetNPCPackageCount()

virtual int CoreRules::IEncounterOb::GetNPCPackageCount ( ) const

pure virtual

Number of NPC groups in this encounter.

GetTemplateName()

virtual const char * CoreRules::IEncounterOb::GetTemplateName ( ) const

pure virtual

Name of the encounter template this encounter was generated from.

GetTrap() [1/2]

virtual const ITrapOb * CoreRules::IEncounterOb::GetTrap ( int index ) const

pure virtual

Trap at index (read-only).

GetTrap() [2/2]

virtual ITrapOb * CoreRules::IEncounterOb::GetTrap ( int index )

pure virtual

Trap at index (mutable).

GetTrapCount()

virtual int CoreRules::IEncounterOb::GetTrapCount ( ) const

pure virtual

Number of traps in this encounter.

GetTreasure() [1/2]

virtual const IInventoryBundle * CoreRules::IEncounterOb::GetTreasure ( ) const

pure virtual

Treasure bundle (read-only).

GetTreasure() [2/2]

virtual IInventoryBundle * CoreRules::IEncounterOb::GetTreasure ( )

pure virtual

Treasure bundle (mutable – mutate via the bundle's own API).

GetType()

virtual const char * CoreRules::IEncounterOb::GetType ( ) const

pure virtual

Encounter type (free-form classifier, e.g. "Wandering", "Lair").

IsDirty()

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

pure virtual

Composite walk (own state + every owned sub-record + both bundles).

MarkClean()

virtual void CoreRules::IEncounterOb::MarkClean ( )

pure virtual

Clear dirty flag (recursive).

RemoveMonsterPackageAt()

virtual bool CoreRules::IEncounterOb::RemoveMonsterPackageAt ( int index )

pure virtual

Remove monster package at index (deletes the owned record).

RemoveNPCPackageAt()

virtual bool CoreRules::IEncounterOb::RemoveNPCPackageAt ( int index )

pure virtual

Remove NPC package at index.

RemoveTrapAt()

virtual bool CoreRules::IEncounterOb::RemoveTrapAt ( int index )

pure virtual

Remove trap at index.

SetDescription()

virtual void CoreRules::IEncounterOb::SetDescription ( const char * v )

pure virtual

Set description.

SetName()

virtual bool CoreRules::IEncounterOb::SetName ( const char * v )

pure virtual

Rename the encounter.

Returns

false if another encounter in the table already has this name.

SetTemplateName()

virtual void CoreRules::IEncounterOb::SetTemplateName ( const char * v )

pure virtual

Set template name.

SetType()

virtual void CoreRules::IEncounterOb::SetType ( const char * v )

pure virtual

Set encounter type.

---

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

• CoreRules/include/CoreRules/IEncounterOb.h