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

One encounter-template record. More...

#include <IEncTemplateOb.h>

Public Types

enum  { kTreasureTypes = 26 }
 Treasure-type slots (one entry per type A..Z). More...
enum  { kClimateFlags = 5 }
 Climate flag slots (Arctic / Sub-Arctic / Temperate / Sub-Tropical / Tropical). More...
enum  { kTerrainFlags = 32 }
 Terrain flag slots (32 environments; see SDK docs for the labels). More...

Public Member Functions

virtual ~IEncTemplateOb ()
virtual const char * GetName () const =0
 Template name (unique within the EncTemplate_Record table).
virtual bool SetName (const char *v)=0
 Rename the template.
virtual long GetFrequencyPct () const =0
 Frequency percent (0=Exempt, 4=VRare, 11=Rare, 20=Uncommon, 65=Common).
virtual bool SetFrequencyPct (long v)=0
 Set frequency percent.
virtual long GetHitDice () const =0
 Hit-dice band (filter for which power level of party this fits).
virtual bool SetHitDice (long v)=0
 Set hit-dice band.
virtual const char * GetMonsterType () const =0
 Monster type filter (e.g. "Humanoid", "Undead").
virtual bool SetMonsterType (const char *v)=0
 Set monster type filter.
virtual const char * GetDescription () const =0
 Free-form description shown in the editor.
virtual void SetDescription (const char *v)=0
 Set description.
virtual const char * GetTerrain () const =0
 Terrain description (free-form prose; separate from terrain-flag matrix).
virtual void SetTerrain (const char *v)=0
 Set terrain description.
virtual bool IsLairAndWandering () const =0
 true if this template fires in both lair and wandering encounters.
virtual void IsLairAndWandering (bool v)=0
 Set lair-and-wandering mode (clears the other two flags).
virtual bool IsLair () const =0
 true if this template fires only in lair encounters.
virtual void IsLair (bool v)=0
 Set lair-only mode (clears the other two flags).
virtual bool IsWandering () const =0
 true if this template fires only as a wandering encounter.
virtual void IsWandering (bool v)=0
 Set wandering-only mode (clears the other two flags).
virtual int GetMonsterPropsCount () const =0
 Number of Monster-Properties rows.
virtual const IEncTemplateMonsterPropertiesOb * GetMonsterProps (int index) const =0
 Monster-Properties row at index (read-only).
virtual IEncTemplateMonsterPropertiesOb * GetMonsterProps (int index)=0
 Monster-Properties row at index (mutable).
virtual bool AddMonsterProps (const IEncTemplateMonsterPropertiesOb *src)=0
 Append a deep copy of src as a Monster-Properties row.
virtual bool RemoveMonsterPropsAt (int index)=0
 Remove Monster-Properties row at index.
virtual void ClearMonsterProps ()=0
 Remove all Monster-Properties rows.
virtual int GetNPCPropsCount () const =0
 Number of NPC-Properties rows.
virtual const IEncTemplateNPCPropertiesOb * GetNPCProps (int index) const =0
 NPC-Properties row at index (read-only).
virtual IEncTemplateNPCPropertiesOb * GetNPCProps (int index)=0
 NPC-Properties row at index (mutable).
virtual bool AddNPCProps (const IEncTemplateNPCPropertiesOb *src)=0
 Append a deep copy of src as an NPC-Properties row.
virtual bool RemoveNPCPropsAt (int index)=0
 Remove NPC-Properties row at index.
virtual void ClearNPCProps ()=0
 Remove all NPC-Properties rows.
virtual int GetTrapCount () const =0
 Number of traps in this template.
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 int GetItemPropsCount () const =0
 Number of Item-Properties rows.
virtual const IEncTemplateItemPropertiesOb * GetItemProps (int index) const =0
 Item-Properties row at index (read-only).
virtual IEncTemplateItemPropertiesOb * GetItemProps (int index)=0
 Item-Properties row at index (mutable).
virtual bool AddItemProps (const IEncTemplateItemPropertiesOb *src)=0
 Append a deep copy of src as an Item-Properties row.
virtual bool RemoveItemPropsAt (int index)=0
 Remove Item-Properties row at index.
virtual void ClearItemProps ()=0
 Remove all Item-Properties rows.
virtual long GetTreasureTypeAmount (int index) const =0
 Treasure amount for type index ([0, kTreasureTypes) = A..Z).
virtual bool SetTreasureTypeAmount (int index, long v)=0
 Set treasure amount for type.
virtual long GetClimateFlag (int index) const =0
 Climate flag at slot ([0, kClimateFlags)).
virtual bool SetClimateFlag (int index, long v)=0
 Set climate flag at slot.
virtual long GetTerrainFlag (int index) const =0
 Terrain flag at slot ([0, kTerrainFlags)).
virtual bool SetTerrainFlag (int index, long v)=0
 Set terrain flag at slot.
virtual bool IsDirty () const =0
 Composite walk (own state + every owned sub-row + every trap).
virtual void MarkClean ()=0
 Clear dirty flag (recursive).
virtual IEncTemplateOb * Clone () const =0
 Deep copy via Serialize round-trip.

Detailed Description

One encounter-template record.

Created and owned by an IEncTemplateRecord (the EncTemplate_Record global table); consumers typically reach instances via the table.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Treasure-type slots (one entry per type A..Z).

Enumerator
kTreasureTypes 

◆ anonymous enum

anonymous enum

Terrain flag slots (32 environments; see SDK docs for the labels).

Enumerator
kTerrainFlags 

◆ anonymous enum

anonymous enum

Climate flag slots (Arctic / Sub-Arctic / Temperate / Sub-Tropical / Tropical).

Enumerator
kClimateFlags 

Constructor & Destructor Documentation

◆ ~IEncTemplateOb()

virtual CoreRules::IEncTemplateOb::~IEncTemplateOb ( )
inlinevirtual

Member Function Documentation

◆ AddItemProps()

virtual bool CoreRules::IEncTemplateOb::AddItemProps ( const IEncTemplateItemPropertiesOb * src)
pure virtual

Append a deep copy of src as an Item-Properties row.

◆ AddMonsterProps()

virtual bool CoreRules::IEncTemplateOb::AddMonsterProps ( const IEncTemplateMonsterPropertiesOb * src)
pure virtual

Append a deep copy of src as a Monster-Properties row.

◆ AddNPCProps()

virtual bool CoreRules::IEncTemplateOb::AddNPCProps ( const IEncTemplateNPCPropertiesOb * src)
pure virtual

Append a deep copy of src as an NPC-Properties row.

◆ AddTrap()

virtual bool CoreRules::IEncTemplateOb::AddTrap ( const ITrapOb * src)
pure virtual

Append a deep copy of src as a trap.

◆ ClearItemProps()

virtual void CoreRules::IEncTemplateOb::ClearItemProps ( )
pure virtual

Remove all Item-Properties rows.

◆ ClearMonsterProps()

virtual void CoreRules::IEncTemplateOb::ClearMonsterProps ( )
pure virtual

Remove all Monster-Properties rows.

◆ ClearNPCProps()

virtual void CoreRules::IEncTemplateOb::ClearNPCProps ( )
pure virtual

Remove all NPC-Properties rows.

◆ ClearTraps()

virtual void CoreRules::IEncTemplateOb::ClearTraps ( )
pure virtual

Remove all traps.

◆ Clone()

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

Deep copy via Serialize round-trip.

◆ GetClimateFlag()

virtual long CoreRules::IEncTemplateOb::GetClimateFlag ( int index) const
pure virtual

Climate flag at slot ([0, kClimateFlags)).

◆ GetDescription()

virtual const char * CoreRules::IEncTemplateOb::GetDescription ( ) const
pure virtual

Free-form description shown in the editor.

◆ GetFrequencyPct()

virtual long CoreRules::IEncTemplateOb::GetFrequencyPct ( ) const
pure virtual

Frequency percent (0=Exempt, 4=VRare, 11=Rare, 20=Uncommon, 65=Common).

◆ GetHitDice()

virtual long CoreRules::IEncTemplateOb::GetHitDice ( ) const
pure virtual

Hit-dice band (filter for which power level of party this fits).

◆ GetItemProps() [1/2]

virtual const IEncTemplateItemPropertiesOb * CoreRules::IEncTemplateOb::GetItemProps ( int index) const
pure virtual

Item-Properties row at index (read-only).

◆ GetItemProps() [2/2]

virtual IEncTemplateItemPropertiesOb * CoreRules::IEncTemplateOb::GetItemProps ( int index)
pure virtual

Item-Properties row at index (mutable).

◆ GetItemPropsCount()

virtual int CoreRules::IEncTemplateOb::GetItemPropsCount ( ) const
pure virtual

Number of Item-Properties rows.

◆ GetMonsterProps() [1/2]

virtual const IEncTemplateMonsterPropertiesOb * CoreRules::IEncTemplateOb::GetMonsterProps ( int index) const
pure virtual

Monster-Properties row at index (read-only).

◆ GetMonsterProps() [2/2]

virtual IEncTemplateMonsterPropertiesOb * CoreRules::IEncTemplateOb::GetMonsterProps ( int index)
pure virtual

Monster-Properties row at index (mutable).

◆ GetMonsterPropsCount()

virtual int CoreRules::IEncTemplateOb::GetMonsterPropsCount ( ) const
pure virtual

Number of Monster-Properties rows.

◆ GetMonsterType()

virtual const char * CoreRules::IEncTemplateOb::GetMonsterType ( ) const
pure virtual

Monster type filter (e.g. "Humanoid", "Undead").

◆ GetName()

virtual const char * CoreRules::IEncTemplateOb::GetName ( ) const
pure virtual

Template name (unique within the EncTemplate_Record table).

◆ GetNPCProps() [1/2]

virtual const IEncTemplateNPCPropertiesOb * CoreRules::IEncTemplateOb::GetNPCProps ( int index) const
pure virtual

NPC-Properties row at index (read-only).

◆ GetNPCProps() [2/2]

virtual IEncTemplateNPCPropertiesOb * CoreRules::IEncTemplateOb::GetNPCProps ( int index)
pure virtual

NPC-Properties row at index (mutable).

◆ GetNPCPropsCount()

virtual int CoreRules::IEncTemplateOb::GetNPCPropsCount ( ) const
pure virtual

Number of NPC-Properties rows.

◆ GetTerrain()

virtual const char * CoreRules::IEncTemplateOb::GetTerrain ( ) const
pure virtual

Terrain description (free-form prose; separate from terrain-flag matrix).

◆ GetTerrainFlag()

virtual long CoreRules::IEncTemplateOb::GetTerrainFlag ( int index) const
pure virtual

Terrain flag at slot ([0, kTerrainFlags)).

◆ GetTrap() [1/2]

virtual const ITrapOb * CoreRules::IEncTemplateOb::GetTrap ( int index) const
pure virtual

Trap at index (read-only).

◆ GetTrap() [2/2]

virtual ITrapOb * CoreRules::IEncTemplateOb::GetTrap ( int index)
pure virtual

Trap at index (mutable).

◆ GetTrapCount()

virtual int CoreRules::IEncTemplateOb::GetTrapCount ( ) const
pure virtual

Number of traps in this template.

◆ GetTreasureTypeAmount()

virtual long CoreRules::IEncTemplateOb::GetTreasureTypeAmount ( int index) const
pure virtual

Treasure amount for type index ([0, kTreasureTypes) = A..Z).

◆ IsDirty()

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

Composite walk (own state + every owned sub-row + every trap).

◆ IsLair() [1/2]

virtual bool CoreRules::IEncTemplateOb::IsLair ( ) const
pure virtual

true if this template fires only in lair encounters.

◆ IsLair() [2/2]

virtual void CoreRules::IEncTemplateOb::IsLair ( bool v)
pure virtual

Set lair-only mode (clears the other two flags).

◆ IsLairAndWandering() [1/2]

virtual bool CoreRules::IEncTemplateOb::IsLairAndWandering ( ) const
pure virtual

true if this template fires in both lair and wandering encounters.

◆ IsLairAndWandering() [2/2]

virtual void CoreRules::IEncTemplateOb::IsLairAndWandering ( bool v)
pure virtual

Set lair-and-wandering mode (clears the other two flags).

◆ IsWandering() [1/2]

virtual bool CoreRules::IEncTemplateOb::IsWandering ( ) const
pure virtual

true if this template fires only as a wandering encounter.

◆ IsWandering() [2/2]

virtual void CoreRules::IEncTemplateOb::IsWandering ( bool v)
pure virtual

Set wandering-only mode (clears the other two flags).

◆ MarkClean()

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

Clear dirty flag (recursive).

◆ RemoveItemPropsAt()

virtual bool CoreRules::IEncTemplateOb::RemoveItemPropsAt ( int index)
pure virtual

Remove Item-Properties row at index.

◆ RemoveMonsterPropsAt()

virtual bool CoreRules::IEncTemplateOb::RemoveMonsterPropsAt ( int index)
pure virtual

Remove Monster-Properties row at index.

◆ RemoveNPCPropsAt()

virtual bool CoreRules::IEncTemplateOb::RemoveNPCPropsAt ( int index)
pure virtual

Remove NPC-Properties row at index.

◆ RemoveTrapAt()

virtual bool CoreRules::IEncTemplateOb::RemoveTrapAt ( int index)
pure virtual

Remove trap at index.

◆ SetClimateFlag()

virtual bool CoreRules::IEncTemplateOb::SetClimateFlag ( int index,
long v )
pure virtual

Set climate flag at slot.

◆ SetDescription()

virtual void CoreRules::IEncTemplateOb::SetDescription ( const char * v)
pure virtual

Set description.

◆ SetFrequencyPct()

virtual bool CoreRules::IEncTemplateOb::SetFrequencyPct ( long v)
pure virtual

Set frequency percent.

◆ SetHitDice()

virtual bool CoreRules::IEncTemplateOb::SetHitDice ( long v)
pure virtual

Set hit-dice band.

◆ SetMonsterType()

virtual bool CoreRules::IEncTemplateOb::SetMonsterType ( const char * v)
pure virtual

Set monster type filter.

◆ SetName()

virtual bool CoreRules::IEncTemplateOb::SetName ( const char * v)
pure virtual

Rename the template.

Returns
false if another template in the containing table already has this name.

◆ SetTerrain()

virtual void CoreRules::IEncTemplateOb::SetTerrain ( const char * v)
pure virtual

Set terrain description.

◆ SetTerrainFlag()

virtual bool CoreRules::IEncTemplateOb::SetTerrainFlag ( int index,
long v )
pure virtual

Set terrain flag at slot.

◆ SetTreasureTypeAmount()

virtual bool CoreRules::IEncTemplateOb::SetTreasureTypeAmount ( int index,
long v )
pure virtual

Set treasure amount for type.

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