ConditionMgr.h File Reference

#include "Define.h"
#include <list>
#include <map>

Go to the source code of this file.

Classes
struct	ConditionSourceInfo
struct	Condition
class	ConditionMgr

Macros
#define	sConditionMgr   ConditionMgr::instance()

Typedefs
typedef std::list< Condition * >	ConditionList
typedef std::map< uint32, ConditionList >	ConditionTypeContainer
typedef std::map< ConditionSourceType, ConditionTypeContainer >	ConditionContainer
typedef std::map< uint32, ConditionTypeContainer >	CreatureSpellConditionContainer
typedef std::map< uint32, ConditionTypeContainer >	NpcVendorConditionContainer
typedef std::map< std::pair< int32, uint32 >, ConditionTypeContainer >	SmartEventConditionContainer
typedef std::map< uint32, ConditionList >	ConditionReferenceContainer

Enumerations
enum	ConditionTypes {   CONDITION_NONE = 0 ,   CONDITION_AURA = 1 ,   CONDITION_ITEM = 2 ,   CONDITION_ITEM_EQUIPPED = 3 ,   CONDITION_ZONEID = 4 ,   CONDITION_REPUTATION_RANK = 5 ,   CONDITION_TEAM = 6 ,   CONDITION_SKILL = 7 ,   CONDITION_QUESTREWARDED = 8 ,   CONDITION_QUESTTAKEN = 9 ,   CONDITION_DRUNKENSTATE = 10 ,   CONDITION_WORLD_STATE = 11 ,   CONDITION_ACTIVE_EVENT = 12 ,   CONDITION_INSTANCE_INFO = 13 ,   CONDITION_QUEST_NONE = 14 ,   CONDITION_CLASS = 15 ,   CONDITION_RACE = 16 ,   CONDITION_ACHIEVEMENT = 17 ,   CONDITION_TITLE = 18 ,   CONDITION_SPAWNMASK = 19 ,   CONDITION_GENDER = 20 ,   CONDITION_UNIT_STATE = 21 ,   CONDITION_MAPID = 22 ,   CONDITION_AREAID = 23 ,   CONDITION_CREATURE_TYPE = 24 ,   CONDITION_SPELL = 25 ,   CONDITION_PHASEMASK = 26 ,   CONDITION_LEVEL = 27 ,   CONDITION_QUEST_COMPLETE = 28 ,   CONDITION_NEAR_CREATURE = 29 ,   CONDITION_NEAR_GAMEOBJECT = 30 ,   CONDITION_OBJECT_ENTRY_GUID = 31 ,   CONDITION_TYPE_MASK = 32 ,   CONDITION_RELATION_TO = 33 ,   CONDITION_REACTION_TO = 34 ,   CONDITION_DISTANCE_TO = 35 ,   CONDITION_ALIVE = 36 ,   CONDITION_HP_VAL = 37 ,   CONDITION_HP_PCT = 38 ,   CONDITION_REALM_ACHIEVEMENT = 39 ,   CONDITION_IN_WATER = 40 ,   CONDITION_TERRAIN_SWAP = 41 ,   CONDITION_STAND_STATE = 42 ,   CONDITION_DAILY_QUEST_DONE = 43 ,   CONDITION_CHARMED = 44 ,   CONDITION_PET_TYPE = 45 ,   CONDITION_TAXI = 46 ,   CONDITION_QUESTSTATE = 47 ,   CONDITION_QUEST_OBJECTIVE_PROGRESS = 48 ,   CONDITION_DIFFICULTY_ID = 49 ,   CONDITION_TC_END = 50 ,   CONDITION_AC_START = 100 ,   CONDITION_QUEST_SATISFY_EXCLUSIVE = 101 ,   CONDITION_HAS_AURA_TYPE = 102 ,   CONDITION_WORLD_SCRIPT = 103 ,   CONDITION_AC_END = 104 }
enum	ConditionSourceType {   CONDITION_SOURCE_TYPE_NONE = 0 ,   CONDITION_SOURCE_TYPE_CREATURE_LOOT_TEMPLATE = 1 ,   CONDITION_SOURCE_TYPE_DISENCHANT_LOOT_TEMPLATE = 2 ,   CONDITION_SOURCE_TYPE_FISHING_LOOT_TEMPLATE = 3 ,   CONDITION_SOURCE_TYPE_GAMEOBJECT_LOOT_TEMPLATE = 4 ,   CONDITION_SOURCE_TYPE_ITEM_LOOT_TEMPLATE = 5 ,   CONDITION_SOURCE_TYPE_MAIL_LOOT_TEMPLATE = 6 ,   CONDITION_SOURCE_TYPE_MILLING_LOOT_TEMPLATE = 7 ,   CONDITION_SOURCE_TYPE_PICKPOCKETING_LOOT_TEMPLATE = 8 ,   CONDITION_SOURCE_TYPE_PROSPECTING_LOOT_TEMPLATE = 9 ,   CONDITION_SOURCE_TYPE_REFERENCE_LOOT_TEMPLATE = 10 ,   CONDITION_SOURCE_TYPE_SKINNING_LOOT_TEMPLATE = 11 ,   CONDITION_SOURCE_TYPE_SPELL_LOOT_TEMPLATE = 12 ,   CONDITION_SOURCE_TYPE_SPELL_IMPLICIT_TARGET = 13 ,   CONDITION_SOURCE_TYPE_GOSSIP_MENU = 14 ,   CONDITION_SOURCE_TYPE_GOSSIP_MENU_OPTION = 15 ,   CONDITION_SOURCE_TYPE_CREATURE_TEMPLATE_VEHICLE = 16 ,   CONDITION_SOURCE_TYPE_SPELL = 17 ,   CONDITION_SOURCE_TYPE_SPELL_CLICK_EVENT = 18 ,   CONDITION_SOURCE_TYPE_QUEST_AVAILABLE = 19 ,   CONDITION_SOURCE_TYPE_UNUSED_20 = 20 ,   CONDITION_SOURCE_TYPE_VEHICLE_SPELL = 21 ,   CONDITION_SOURCE_TYPE_SMART_EVENT = 22 ,   CONDITION_SOURCE_TYPE_NPC_VENDOR = 23 ,   CONDITION_SOURCE_TYPE_SPELL_PROC = 24 ,   CONDITION_SOURCE_TYPE_TERRAIN_SWAP = 25 ,   CONDITION_SOURCE_TYPE_PHASE = 26 ,   CONDITION_SOURCE_TYPE_GRAVEYARD = 27 ,   CONDITION_SOURCE_TYPE_PLAYER_LOOT_TEMPLATE = 28 ,   CONDITION_SOURCE_TYPE_CREATURE_RESPAWN = 29 ,   CONDITION_SOURCE_TYPE_CREATURE_VISIBILITY = 30 ,   CONDITION_SOURCE_TYPE_MAX = 31 }
enum	RelationType {   RELATION_SELF = 0 ,   RELATION_IN_PARTY ,   RELATION_IN_RAID_OR_PARTY ,   RELATION_OWNED_BY ,   RELATION_PASSENGER_OF ,   RELATION_CREATED_BY ,   RELATION_MAX }
enum	InstanceInfo {   INSTANCE_INFO_DATA = 0 ,   INSTANCE_INFO_GUID_DATA ,   INSTANCE_INFO_BOSS_STATE ,   INSTANCE_INFO_DATA64 }
enum	{ MAX_CONDITION_TARGETS = 3 }

Macro Definition Documentation

sConditionMgr

#define sConditionMgr   ConditionMgr::instance()

Typedef Documentation

ConditionContainer

typedef std::map<ConditionSourceType, ConditionTypeContainer> ConditionContainer

ConditionList

typedef std::list<Condition*> ConditionList

ConditionReferenceContainer

typedef std::map<uint32, ConditionList> ConditionReferenceContainer

ConditionTypeContainer

typedef std::map<uint32, ConditionList> ConditionTypeContainer

CreatureSpellConditionContainer

typedef std::map<uint32, ConditionTypeContainer> CreatureSpellConditionContainer

NpcVendorConditionContainer

typedef std::map<uint32, ConditionTypeContainer> NpcVendorConditionContainer

SmartEventConditionContainer

typedef std::map<std::pair<int32, uint32 >, ConditionTypeContainer> SmartEventConditionContainer

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
MAX_CONDITION_TARGETS

{
    MAX_CONDITION_TARGETS = 3,
};

ConditionSourceType

enum ConditionSourceType

Documentation on implementing a new ConditionSourceType: Step 1: Check for the lowest free ID. Look for CONDITION_SOURCE_TYPE_UNUSED_XX in the enum. Then define the new source type.

Step 2: Determine and map the parameters for the new condition source type.

Step 3: Add a case block to ConditionMgr::isSourceTypeValid with the new condition type and validate the parameters.

Step 4: If your condition can be grouped (determined in step 2), add a rule for it in ConditionMgr::CanHaveSourceGroupSet, following the example of the existing types.

Step 5: Define the maximum available condition targets in ConditionMgr::GetMaxAvailableConditionTargets.

The following steps only apply if your condition can be grouped:

Step 6: Determine how you are going to store your conditions. You need to add a new storage container for it in ConditionMgr class, along with a function like: ConditionList GetConditionsForXXXYourNewSourceTypeXXX(parameters...)

The above function should be placed in upper level (practical) code that actually checks the conditions.

Step 7: Implement loading for your source type in ConditionMgr::LoadConditions.

Step 8: Implement memory cleaning for your source type in ConditionMgr::Clean.

Enumerator
CONDITION_SOURCE_TYPE_NONE
CONDITION_SOURCE_TYPE_CREATURE_LOOT_TEMPLATE
CONDITION_SOURCE_TYPE_DISENCHANT_LOOT_TEMPLATE
CONDITION_SOURCE_TYPE_FISHING_LOOT_TEMPLATE
CONDITION_SOURCE_TYPE_GAMEOBJECT_LOOT_TEMPLATE
CONDITION_SOURCE_TYPE_ITEM_LOOT_TEMPLATE
CONDITION_SOURCE_TYPE_MAIL_LOOT_TEMPLATE
CONDITION_SOURCE_TYPE_MILLING_LOOT_TEMPLATE
CONDITION_SOURCE_TYPE_PICKPOCKETING_LOOT_TEMPLATE
CONDITION_SOURCE_TYPE_PROSPECTING_LOOT_TEMPLATE
CONDITION_SOURCE_TYPE_REFERENCE_LOOT_TEMPLATE
CONDITION_SOURCE_TYPE_SKINNING_LOOT_TEMPLATE
CONDITION_SOURCE_TYPE_SPELL_LOOT_TEMPLATE
CONDITION_SOURCE_TYPE_SPELL_IMPLICIT_TARGET
CONDITION_SOURCE_TYPE_GOSSIP_MENU
CONDITION_SOURCE_TYPE_GOSSIP_MENU_OPTION
CONDITION_SOURCE_TYPE_CREATURE_TEMPLATE_VEHICLE
CONDITION_SOURCE_TYPE_SPELL
CONDITION_SOURCE_TYPE_SPELL_CLICK_EVENT
CONDITION_SOURCE_TYPE_QUEST_AVAILABLE
CONDITION_SOURCE_TYPE_UNUSED_20
CONDITION_SOURCE_TYPE_VEHICLE_SPELL
CONDITION_SOURCE_TYPE_SMART_EVENT
CONDITION_SOURCE_TYPE_NPC_VENDOR
CONDITION_SOURCE_TYPE_SPELL_PROC
CONDITION_SOURCE_TYPE_TERRAIN_SWAP
CONDITION_SOURCE_TYPE_PHASE
CONDITION_SOURCE_TYPE_GRAVEYARD
CONDITION_SOURCE_TYPE_PLAYER_LOOT_TEMPLATE
CONDITION_SOURCE_TYPE_CREATURE_RESPAWN
CONDITION_SOURCE_TYPE_CREATURE_VISIBILITY
CONDITION_SOURCE_TYPE_MAX

{
    CONDITION_SOURCE_TYPE_NONE                           = 0,
    CONDITION_SOURCE_TYPE_CREATURE_LOOT_TEMPLATE         = 1,
    CONDITION_SOURCE_TYPE_DISENCHANT_LOOT_TEMPLATE       = 2,
    CONDITION_SOURCE_TYPE_FISHING_LOOT_TEMPLATE          = 3,
    CONDITION_SOURCE_TYPE_GAMEOBJECT_LOOT_TEMPLATE       = 4,
    CONDITION_SOURCE_TYPE_ITEM_LOOT_TEMPLATE             = 5,
    CONDITION_SOURCE_TYPE_MAIL_LOOT_TEMPLATE             = 6,
    CONDITION_SOURCE_TYPE_MILLING_LOOT_TEMPLATE          = 7,
    CONDITION_SOURCE_TYPE_PICKPOCKETING_LOOT_TEMPLATE    = 8,
    CONDITION_SOURCE_TYPE_PROSPECTING_LOOT_TEMPLATE      = 9,
    CONDITION_SOURCE_TYPE_REFERENCE_LOOT_TEMPLATE        = 10,
    CONDITION_SOURCE_TYPE_SKINNING_LOOT_TEMPLATE         = 11,
    CONDITION_SOURCE_TYPE_SPELL_LOOT_TEMPLATE            = 12,
    CONDITION_SOURCE_TYPE_SPELL_IMPLICIT_TARGET          = 13,
    CONDITION_SOURCE_TYPE_GOSSIP_MENU                    = 14,
    CONDITION_SOURCE_TYPE_GOSSIP_MENU_OPTION             = 15,
    CONDITION_SOURCE_TYPE_CREATURE_TEMPLATE_VEHICLE      = 16,
    CONDITION_SOURCE_TYPE_SPELL                          = 17,
    CONDITION_SOURCE_TYPE_SPELL_CLICK_EVENT              = 18,
    CONDITION_SOURCE_TYPE_QUEST_AVAILABLE                = 19,
    CONDITION_SOURCE_TYPE_UNUSED_20                      = 20, // placeholder
    CONDITION_SOURCE_TYPE_VEHICLE_SPELL                  = 21,
    CONDITION_SOURCE_TYPE_SMART_EVENT                    = 22,
    CONDITION_SOURCE_TYPE_NPC_VENDOR                     = 23,
    CONDITION_SOURCE_TYPE_SPELL_PROC                     = 24,
    CONDITION_SOURCE_TYPE_TERRAIN_SWAP                   = 25, // don't use on 3.3.5a
    CONDITION_SOURCE_TYPE_PHASE                          = 26, // don't use on 3.3.5a
    CONDITION_SOURCE_TYPE_GRAVEYARD                      = 27, // don't use on 3.3.5a
    CONDITION_SOURCE_TYPE_PLAYER_LOOT_TEMPLATE           = 28,
    CONDITION_SOURCE_TYPE_CREATURE_RESPAWN               = 29,
    CONDITION_SOURCE_TYPE_CREATURE_VISIBILITY            = 30,
    CONDITION_SOURCE_TYPE_MAX                            = 31 // placeholder
};

ConditionTypes

enum ConditionTypes

Enumerator
CONDITION_NONE
CONDITION_AURA
CONDITION_ITEM
CONDITION_ITEM_EQUIPPED
CONDITION_ZONEID
CONDITION_REPUTATION_RANK
CONDITION_TEAM
CONDITION_SKILL
CONDITION_QUESTREWARDED
CONDITION_QUESTTAKEN
CONDITION_DRUNKENSTATE
CONDITION_WORLD_STATE
CONDITION_ACTIVE_EVENT
CONDITION_INSTANCE_INFO
CONDITION_QUEST_NONE
CONDITION_CLASS
CONDITION_RACE
CONDITION_ACHIEVEMENT
CONDITION_TITLE
CONDITION_SPAWNMASK
CONDITION_GENDER
CONDITION_UNIT_STATE
CONDITION_MAPID
CONDITION_AREAID
CONDITION_CREATURE_TYPE
CONDITION_SPELL
CONDITION_PHASEMASK
CONDITION_LEVEL
CONDITION_QUEST_COMPLETE
CONDITION_NEAR_CREATURE
CONDITION_NEAR_GAMEOBJECT
CONDITION_OBJECT_ENTRY_GUID
CONDITION_TYPE_MASK
CONDITION_RELATION_TO
CONDITION_REACTION_TO
CONDITION_DISTANCE_TO
CONDITION_ALIVE
CONDITION_HP_VAL
CONDITION_HP_PCT
CONDITION_REALM_ACHIEVEMENT
CONDITION_IN_WATER
CONDITION_TERRAIN_SWAP
CONDITION_STAND_STATE
CONDITION_DAILY_QUEST_DONE
CONDITION_CHARMED
CONDITION_PET_TYPE
CONDITION_TAXI
CONDITION_QUESTSTATE
CONDITION_QUEST_OBJECTIVE_PROGRESS
CONDITION_DIFFICULTY_ID
CONDITION_TC_END
CONDITION_AC_START
CONDITION_QUEST_SATISFY_EXCLUSIVE
CONDITION_HAS_AURA_TYPE
CONDITION_WORLD_SCRIPT
CONDITION_AC_END

{
    // value1                           value2          value3
    CONDITION_NONE                      = 0,            // 0                0              0                  always true
    CONDITION_AURA                      = 1,            // spell_id         effindex       use target?        true if player (or target, if value3) has aura of spell_id with effect effindex
    CONDITION_ITEM                      = 2,            // item_id          count          bank               true if has #count of item_ids (if 'bank' is set it searches in bank slots too)
    CONDITION_ITEM_EQUIPPED             = 3,            // item_id          0              0                  true if has item_id equipped
    CONDITION_ZONEID                    = 4,            // zone_id          0              0                  true if in zone_id
    CONDITION_REPUTATION_RANK           = 5,            // faction_id       rankMask       0                  true if has min_rank for faction_id
    CONDITION_TEAM                      = 6,            // player_team      0,             0                  469 - Alliance, 67 - Horde)
    CONDITION_SKILL                     = 7,            // skill_id         skill_value    0                  true if has skill_value for skill_id
    CONDITION_QUESTREWARDED             = 8,            // quest_id         0              0                  true if quest_id was rewarded before
    CONDITION_QUESTTAKEN                = 9,            // quest_id         0,             0                  true while quest active
    CONDITION_DRUNKENSTATE              = 10,           // DrunkenState     0,             0                  true if player is drunk enough
    CONDITION_WORLD_STATE               = 11,           // index            value          0                  true if world has the value for the index
    CONDITION_ACTIVE_EVENT              = 12,           // event_id         0              0                  true if event is active
    CONDITION_INSTANCE_INFO             = 13,           // entry            data           type               true if the instance info defined by type (enum InstanceInfo) equals data.
    CONDITION_QUEST_NONE                = 14,           // quest_id         0              0                  true if doesn't have quest saved
    CONDITION_CLASS                     = 15,           // class            0              0                  true if player's class is equal to class
    CONDITION_RACE                      = 16,           // race             0              0                  true if player's race is equal to race
    CONDITION_ACHIEVEMENT               = 17,           // achievement_id   0              0                  true if achievement is complete
    CONDITION_TITLE                     = 18,           // title id         0              0                  true if player has title
    CONDITION_SPAWNMASK                 = 19,           // spawnMask        0              0                  true if in spawnMask
    CONDITION_GENDER                    = 20,           // gender           0              0                  true if player's gender is equal to gender
    CONDITION_UNIT_STATE                = 21,           // unitState        0              0                  true if unit has unitState
    CONDITION_MAPID                     = 22,           // map_id           0              0                  true if in map_id
    CONDITION_AREAID                    = 23,           // area_id          0              0                  true if in area_id
    CONDITION_CREATURE_TYPE             = 24,           // cinfo.type       0              0                  true if creature_template.type = value1
    CONDITION_SPELL                     = 25,           // spell_id         0              0                  true if player has learned spell
    CONDITION_PHASEMASK                 = 26,           // phasemask        0              0                  true if object is in phasemask
    CONDITION_LEVEL                     = 27,           // level            ComparisonType 0                  true if unit's level is equal to param1 (param2 can modify the statement)
    CONDITION_QUEST_COMPLETE            = 28,           // quest_id         0              0                  true if player has quest_id with all objectives complete, but not yet rewarded
    CONDITION_NEAR_CREATURE             = 29,           // creature entry   distance       dead               true if there is a creature of entry in range
    CONDITION_NEAR_GAMEOBJECT           = 30,           // gameobject entry distance       GoState            true if there is a gameobject of entry in range (param3 can check for GoState, 0 = dont't check, 1 = Ready , 2 = Not Ready)
    CONDITION_OBJECT_ENTRY_GUID         = 31,           // TypeID           entry          guid/Attackable    true if object is type TypeID and the entry is 0 or matches entry of the object or matches guid of the object
    CONDITION_TYPE_MASK                 = 32,           // TypeMask         0              0                  true if object is type object's TypeMask matches provided TypeMask
    CONDITION_RELATION_TO               = 33,           // ConditionTarget  RelationType   0                  true if object is in given relation with object specified by ConditionTarget
    CONDITION_REACTION_TO               = 34,           // ConditionTarget  rankMask       0                  true if object's reaction matches rankMask object specified by ConditionTarget
    CONDITION_DISTANCE_TO               = 35,           // ConditionTarget  distance       ComparisonType     true if object and ConditionTarget are within distance given by parameters
    CONDITION_ALIVE                     = 36,           // 0                0              0                  true if unit is alive
    CONDITION_HP_VAL                    = 37,           // hpVal            ComparisonType 0                  true if unit's hp matches given value
    CONDITION_HP_PCT                    = 38,           // hpPct            ComparisonType 0                  true if unit's hp matches given pct
    CONDITION_REALM_ACHIEVEMENT         = 39,           // achievement_id   0              0                  true if realm achievement is complete
    CONDITION_IN_WATER                  = 40,           // 0                0              0                  true if unit in water
    CONDITION_TERRAIN_SWAP              = 41,           // don't use on 3.3.5a
    CONDITION_STAND_STATE               = 42,           // stateType        state          0                  true if unit matches specified sitstate (0,x: has exactly state x; 1,0: any standing state; 1,1: any sitting state;)
    CONDITION_DAILY_QUEST_DONE          = 43,           // quest id         0              0                  true if daily quest has been completed for the day
    CONDITION_CHARMED                   = 44,           // 0                0              0                  true if unit is currently charmed
    CONDITION_PET_TYPE                  = 45,           // mask             0              0                  true if player has a pet of given type(s)
    CONDITION_TAXI                      = 46,           // 0                0              0                  true if player is on taxi
    CONDITION_QUESTSTATE                = 47,           // quest_id         state_mask     0                  true if player is in any of the provided quest states for the quest (1 = not taken, 2 = completed, 8 = in progress, 32 = failed, 64 = rewarded)
    CONDITION_QUEST_OBJECTIVE_PROGRESS = 48,            // quest_id         objectiveIndex objectiveCount     true if player has reached the specified objectiveCount quest progress for the objectiveIndex for the specified quest
    CONDITION_DIFFICULTY_ID            = 49,            // Difficulty       0              0                  true is map has difficulty id
    CONDITION_TC_END                   = 50,            // placeholder
 
    CONDITION_AC_START                 = 100,
    CONDITION_QUEST_SATISFY_EXCLUSIVE  = 101,           // quest_id         0              0                  true if satisfied exclusive group
    CONDITION_HAS_AURA_TYPE            = 102,           // aura_type        0              0                  true if has aura type
    CONDITION_WORLD_SCRIPT             = 103,           // conditionId      state          0                  true if WorldState::IsConditionFulfilled returns true
 
    CONDITION_AC_END                   = 104            // placeholder
};

InstanceInfo

enum InstanceInfo

Enumerator
INSTANCE_INFO_DATA
INSTANCE_INFO_GUID_DATA
INSTANCE_INFO_BOSS_STATE
INSTANCE_INFO_DATA64

{
    INSTANCE_INFO_DATA = 0,
    INSTANCE_INFO_GUID_DATA,
    INSTANCE_INFO_BOSS_STATE,
    INSTANCE_INFO_DATA64
};

RelationType

enum RelationType

Enumerator
RELATION_SELF
RELATION_IN_PARTY
RELATION_IN_RAID_OR_PARTY
RELATION_OWNED_BY
RELATION_PASSENGER_OF
RELATION_CREATED_BY
RELATION_MAX

{
    RELATION_SELF = 0,
    RELATION_IN_PARTY,
    RELATION_IN_RAID_OR_PARTY,
    RELATION_OWNED_BY,
    RELATION_PASSENGER_OF,
    RELATION_CREATED_BY,
    RELATION_MAX
};