ChatLogScript Class Reference

Inheritance diagram for ChatLogScript:

Public Member Functions
	ChatLogScript ()
bool	OnPlayerCanUseChat (Player *player, uint32 type, uint32 lang, std::string &msg) override
	This hook called before player sending message in default chat.
bool	OnPlayerCanUseChat (Player *player, uint32, uint32 lang, std::string &msg, Player *receiver) override
	This hook called before player sending message to other player via private.
bool	OnPlayerCanUseChat (Player *player, uint32 type, uint32 lang, std::string &msg, Group *group) override
	This hook called before player sending message to group.
bool	OnPlayerCanUseChat (Player *player, uint32 type, uint32 lang, std::string &msg, Guild *guild) override
	This hook called before player sending message to guild.
bool	OnPlayerCanUseChat (Player *player, uint32, uint32, std::string &msg, Channel *channel) override
	This hook called before player sending message to channel.
Public Member Functions inherited from PlayerScript
virtual void	OnPlayerJustDied (Player *)
virtual void	OnPlayerCalculateTalentsPoints (Player const *, uint32 &)
virtual void	OnPlayerReleasedGhost (Player *)
virtual void	OnPlayerSendInitialPacketsBeforeAddToMap (Player *, WorldPacket &)
virtual void	OnPlayerBattlegroundDesertion (Player *, BattlegroundDesertionType const)
virtual void	OnPlayerCompleteQuest (Player *, Quest const *)
virtual void	OnPlayerPVPKill (Player *, Player *)
virtual void	OnPlayerPVPFlagChange (Player *, bool)
virtual void	OnPlayerCreatureKill (Player *, Creature *)
virtual void	OnPlayerCreatureKilledByPet (Player *, Creature *)
virtual void	OnPlayerKilledByCreature (Creature *, Player *)
virtual void	OnPlayerLevelChanged (Player *, uint8)
virtual void	OnPlayerFreeTalentPointsChanged (Player *, uint32)
virtual void	OnPlayerTalentsReset (Player *, bool)
virtual bool	OnPlayerCanLearnTalent (Player *, TalentEntry const *, uint32)
virtual void	OnPlayerAfterSpecSlotChanged (Player *, uint8)
virtual void	OnPlayerBeforeUpdate (Player *, uint32)
virtual void	OnPlayerUpdate (Player *, uint32)
virtual void	OnPlayerMoneyChanged (Player *, int32 &)
virtual void	OnPlayerBeforeLootMoney (Player *, Loot *)
virtual void	OnPlayerGiveXP (Player *, uint32 &, Unit *, uint8)
virtual bool	OnPlayerReputationChange (Player *, uint32, int32 &, bool)
virtual void	OnPlayerReputationRankChange (Player *, uint32, ReputationRank, ReputationRank, bool)
virtual void	OnPlayerGiveReputation (Player *, int32, float &, ReputationSource)
virtual void	OnPlayerLearnSpell (Player *, uint32)
virtual void	OnPlayerForgotSpell (Player *, uint32)
virtual void	OnPlayerDuelRequest (Player *, Player *)
virtual void	OnPlayerDuelStart (Player *, Player *)
virtual void	OnPlayerDuelEnd (Player *, Player *, DuelCompleteType)
virtual void	OnPlayerBeforeSendChatMessage (Player *, uint32 &, uint32 &, std::string &)
virtual void	OnPlayerEmote (Player *, uint32)
virtual void	OnPlayerTextEmote (Player *, uint32, uint32, ObjectGuid)
virtual void	OnPlayerSpellCast (Player *, Spell *, bool)
virtual void	OnPlayerLoadFromDB (Player *)
virtual void	OnPlayerLogin (Player *)
virtual void	OnPlayerBeforeLogout (Player *)
virtual void	OnPlayerLogout (Player *)
virtual void	OnPlayerCreate (Player *)
virtual void	OnPlayerDelete (ObjectGuid, uint32)
virtual void	OnPlayerFailedDelete (ObjectGuid, uint32)
virtual void	OnPlayerSave (Player *)
virtual void	OnPlayerBindToInstance (Player *, Difficulty, uint32, bool)
virtual void	OnPlayerUpdateZone (Player *, uint32, uint32)
virtual void	OnPlayerUpdateArea (Player *, uint32, uint32)
virtual void	OnPlayerMapChanged (Player *)
virtual bool	OnPlayerBeforeTeleport (Player *, uint32, float, float, float, float, uint32, Unit *)
virtual void	OnPlayerUpdateFaction (Player *)
virtual void	OnPlayerAddToBattleground (Player *, Battleground *)
virtual void	OnPlayerQueueRandomDungeon (Player *, uint32 &)
virtual void	OnPlayerRemoveFromBattleground (Player *, Battleground *)
virtual void	OnPlayerAchievementComplete (Player *, AchievementEntry const *)
virtual bool	OnPlayerBeforeAchievementComplete (Player *, AchievementEntry const *)
virtual void	OnPlayerCriteriaProgress (Player *, AchievementCriteriaEntry const *)
virtual bool	OnPlayerBeforeCriteriaProgress (Player *, AchievementCriteriaEntry const *)
virtual void	OnPlayerAchievementSave (CharacterDatabaseTransaction, Player *, uint16, CompletedAchievementData)
virtual void	OnPlayerCriteriaSave (CharacterDatabaseTransaction, Player *, uint16, CriteriaProgress)
virtual void	OnPlayerGossipSelect (Player *, uint32, uint32, uint32)
virtual void	OnPlayerGossipSelectCode (Player *, uint32, uint32, uint32, const char *)
virtual void	OnPlayerBeingCharmed (Player *, Unit *, uint32, uint32)
virtual void	OnPlayerAfterSetVisibleItemSlot (Player *, uint8, Item *)
virtual void	OnPlayerAfterMoveItemFromInventory (Player *, Item *, uint8, uint8, bool)
virtual void	OnPlayerEquip (Player *, Item *, uint8, uint8, bool)
virtual void	OnPlayerUnequip (Player *, Item *)
virtual void	OnPlayerJoinBG (Player *)
virtual void	OnPlayerJoinArena (Player *)
virtual void	OnPlayerGetMaxPersonalArenaRatingRequirement (Player const *, uint32, uint32 &) const
virtual void	OnPlayerLootItem (Player *, Item *, uint32, ObjectGuid)
virtual void	OnPlayerBeforeFillQuestLootItem (Player *, LootItem &)
virtual void	OnPlayerStoreNewItem (Player *, Item *, uint32)
virtual void	OnPlayerCreateItem (Player *, Item *, uint32)
virtual void	OnPlayerQuestRewardItem (Player *, Item *, uint32)
virtual bool	OnPlayerCanPlaceAuctionBid (Player *, AuctionEntry *)
virtual void	OnPlayerGroupRollRewardItem (Player *, Item *, uint32, RollVote, Roll *)
virtual bool	OnPlayerBeforeOpenItem (Player *, Item *)
virtual bool	OnPlayerBeforeQuestComplete (Player *, uint32)
virtual void	OnPlayerQuestComputeXP (Player *, Quest const *, uint32 &)
virtual void	OnPlayerBeforeDurabilityRepair (Player *, ObjectGuid, ObjectGuid, float &, uint8)
virtual void	OnPlayerBeforeBuyItemFromVendor (Player *, ObjectGuid, uint32, uint32 &, uint8, uint8, uint8)
virtual void	OnPlayerBeforeStoreOrEquipNewItem (Player *, uint32, uint32 &, uint8, uint8, uint8, ItemTemplate const *, Creature *, VendorItem const *, bool)
virtual void	OnPlayerAfterStoreOrEquipNewItem (Player *, uint32, Item *, uint8, uint8, uint8, ItemTemplate const *, Creature *, VendorItem const *, bool)
virtual void	OnPlayerAfterUpdateMaxPower (Player *, Powers &, float &)
virtual void	OnPlayerAfterUpdateMaxHealth (Player *, float &)
virtual void	OnPlayerBeforeUpdateAttackPowerAndDamage (Player *, float &, float &, bool)
virtual void	OnPlayerAfterUpdateAttackPowerAndDamage (Player *, float &, float &, float &, float &, bool)
virtual void	OnPlayerBeforeInitTalentForLevel (Player *, uint8 &, uint32 &)
virtual void	OnPlayerFirstLogin (Player *)
virtual void	OnPlayerSetMaxLevel (Player *, uint32 &)
virtual bool	OnPlayerCanJoinInBattlegroundQueue (Player *, ObjectGuid, BattlegroundTypeId, uint8, GroupJoinBattlegroundResult &)
virtual bool	OnPlayerShouldBeRewardedWithMoneyInsteadOfExp (Player *)
virtual void	OnPlayerBeforeTempSummonInitStats (Player *, TempSummon *, uint32 &)
virtual void	OnPlayerBeforeGuardianInitStatsForLevel (Player *, Guardian *, CreatureTemplate const *, PetType &)
virtual void	OnPlayerAfterGuardianInitStatsForLevel (Player *, Guardian *)
virtual void	OnPlayerBeforeLoadPetFromDB (Player *, uint32 &, uint32 &, bool &, bool &)
virtual bool	OnPlayerCanJoinInArenaQueue (Player *, ObjectGuid, uint8, BattlegroundTypeId, uint8, uint8, GroupJoinBattlegroundResult &)
virtual bool	OnPlayerCanBattleFieldPort (Player *, uint8, BattlegroundTypeId, uint8)
virtual bool	OnPlayerCanGroupInvite (Player *, std::string &)
virtual bool	OnPlayerCanGroupAccept (Player *, Group *)
virtual bool	OnPlayerCanSellItem (Player *, Item *, Creature *)
virtual bool	OnPlayerCanSendMail (Player *, ObjectGuid, ObjectGuid, std::string &, std::string &, uint32, uint32, Item *)
virtual void	OnPlayerPetitionBuy (Player *, Creature *, uint32 &, uint32 &, uint32 &)
virtual void	OnPlayerPetitionShowList (Player *, Creature *, uint32 &, uint32 &, uint32 &)
virtual void	OnPlayerRewardKillRewarder (Player *, KillRewarder *, bool, float &)
virtual bool	OnPlayerCanGiveMailRewardAtGiveLevel (Player *, uint8)
virtual void	OnPlayerDeleteFromDB (CharacterDatabaseTransaction, uint32)
virtual bool	OnPlayerCanRepopAtGraveyard (Player *)
virtual Optional< bool >	OnPlayerIsClass (Player const *, Classes, ClassContext)
virtual void	OnPlayerGetMaxSkillValue (Player *, uint32, int32 &, bool)
virtual bool	OnPlayerHasActivePowerType (Player const *, Powers)
virtual void	OnPlayerUpdateGatheringSkill (Player *, uint32, uint32, uint32, uint32, uint32, uint32 &)
	This hook called before gathering skill gain is applied to the character.
virtual void	OnPlayerUpdateCraftingSkill (Player *, SkillLineAbilityEntry const *, uint32, uint32 &)
	This hook is called before crafting skill gain is applied to the character.
virtual bool	OnPlayerUpdateFishingSkill (Player *, int32, int32, int32, int32)
virtual bool	OnPlayerCanAreaExploreAndOutdoor (Player *)
virtual void	OnPlayerVictimRewardBefore (Player *, Player *, uint32 &, int32 &)
virtual void	OnPlayerVictimRewardAfter (Player *, Player *, uint32 &, int32 &, float &)
virtual void	OnPlayerCustomScalingStatValueBefore (Player *, ItemTemplate const *, uint8, bool, uint32 &)
virtual void	OnPlayerCustomScalingStatValue (Player *, ItemTemplate const *, uint32 &, int32 &, uint8, uint32, ScalingStatValuesEntry const *)
virtual void	OnPlayerApplyItemModsBefore (Player *, uint8, bool, uint8, uint32, int32 &)
virtual void	OnPlayerApplyEnchantmentItemModsBefore (Player *, Item *, EnchantmentSlot, bool, uint32, uint32 &)
virtual void	OnPlayerApplyWeaponDamage (Player *, uint8, ItemTemplate const *, float &, float &, uint8)
virtual bool	OnPlayerCanArmorDamageModifier (Player *)
virtual void	OnPlayerGetFeralApBonus (Player *, int32 &, int32, ItemTemplate const *, ScalingStatValuesEntry const *)
virtual bool	OnPlayerCanApplyWeaponDependentAuraDamageMod (Player *, Item *, WeaponAttackType, AuraEffect const *, bool)
virtual bool	OnPlayerCanApplyEquipSpell (Player *, SpellInfo const *, Item *, bool, bool)
virtual bool	OnPlayerCanApplyEquipSpellsItemSet (Player *, ItemSetEffect *)
virtual bool	OnPlayerCanCastItemCombatSpell (Player *, Unit *, WeaponAttackType, uint32, uint32, Item *, ItemTemplate const *)
virtual bool	OnPlayerCanCastItemUseSpell (Player *, Item *, SpellCastTargets const &, uint8, uint32)
virtual void	OnPlayerApplyAmmoBonuses (Player *, ItemTemplate const *, float &)
virtual bool	OnPlayerCanEquipItem (Player *, uint8, uint16 &, Item *, bool, bool)
virtual bool	OnPlayerCanUnequipItem (Player *, uint16, bool)
virtual bool	OnPlayerCanUseItem (Player *, ItemTemplate const *, InventoryResult &)
virtual bool	OnPlayerCanSaveEquipNewItem (Player *, Item *, uint16, bool)
virtual bool	OnPlayerCanApplyEnchantment (Player *, Item *, EnchantmentSlot, bool, bool, bool)
virtual void	OnPlayerGetQuestRate (Player *, float &)
virtual bool	OnPlayerPassedQuestKilledMonsterCredit (Player *, Quest const *, uint32, uint32, ObjectGuid)
virtual bool	OnPlayerCheckItemInSlotAtLoadInventory (Player *, Item *, uint8, uint8 &, uint16 &)
virtual bool	OnPlayerNotAvoidSatisfy (Player *, DungeonProgressionRequirements const *, uint32, bool)
virtual bool	OnPlayerNotVisibleGloballyFor (Player *, Player const *)
virtual void	OnPlayerGetArenaPersonalRating (Player *, uint8, uint32 &)
virtual void	OnPlayerGetArenaTeamId (Player *, uint8, uint32 &)
virtual void	OnPlayerIsFFAPvP (Player *, bool &)
virtual void	OnPlayerFfaPvpStateUpdate (Player *, bool)
virtual void	OnPlayerIsPvP (Player *, bool &)
virtual void	OnPlayerGetMaxSkillValueForLevel (Player *, uint16 &)
virtual bool	OnPlayerNotSetArenaTeamInfoField (Player *, uint8, ArenaTeamInfoType, uint32)
virtual bool	OnPlayerCanJoinLfg (Player *, uint8, std::set< uint32 > &, const std::string &)
virtual bool	OnPlayerCanEnterMap (Player *, MapEntry const *, InstanceTemplate const *, MapDifficulty const *, bool)
virtual bool	OnPlayerCanInitTrade (Player *, Player *)
virtual bool	OnPlayerCanSetTradeItem (Player *, Item *, uint8)
	This hook called just before finishing the handling of the action of a player setting an item in a trade slot.
virtual void	OnPlayerSetServerSideVisibility (Player *, ServerSideVisibilityType &, AccountTypes &)
virtual void	OnPlayerSetServerSideVisibilityDetect (Player *, ServerSideVisibilityType &, AccountTypes &)
virtual void	OnPlayerResurrect (Player *, float, bool &)
virtual void	OnPlayerBeforeChooseGraveyard (Player *, TeamId, bool, uint32 &)
virtual void	OnPlayerLearnTalents (Player *, uint32, uint32, uint32)
	This hook called after player learning talents.
virtual void	OnPlayerEnterCombat (Player *, Unit *)
	This hook called after player entering combat.
virtual void	OnPlayerLeaveCombat (Player *)
	This hook called after player leave combat.
virtual void	OnPlayerQuestAbandon (Player *, uint32)
	This hook called after player abandoning quest.
virtual bool	OnPlayerCanFlyInZone (Player *, uint32, uint32, SpellInfo const *)
	This hook called before other CanFlyChecks are applied.
virtual void	AnticheatSetCanFlybyServer (Player *, bool)
virtual void	AnticheatSetUnderACKmount (Player *)
virtual void	AnticheatSetRootACKUpd (Player *)
virtual void	AnticheatSetJumpingbyOpcode (Player *, bool)
virtual void	AnticheatUpdateMovementInfo (Player *, MovementInfo const &)
virtual bool	AnticheatHandleDoubleJump (Player *, Unit *)
virtual bool	AnticheatCheckMovementInfo (Player *, MovementInfo const &, Unit *, bool)
virtual bool	OnPlayerCanSendErrorAlreadyLooted (Player *)
	This hook is called, to avoid displaying the error message that the body has already been stripped.
virtual void	OnPlayerAfterCreatureLoot (Player *)
	It is used when an item is taken from a creature.
virtual void	OnPlayerAfterCreatureLootMoney (Player *)
	After a creature's money is taken.
virtual bool	OnPlayerCanUpdateSkill (Player *, uint32)
virtual void	OnPlayerBeforeUpdateSkill (Player *, uint32, uint32 &, uint32, uint32)
virtual void	OnPlayerUpdateSkill (Player *, uint32, uint32, uint32, uint32, uint32)
virtual bool	OnPlayerCanResurrect (Player *)
	This hook is called, to avoid player resurrect.
virtual bool	OnPlayerCanGiveLevel (Player *, uint8)
	This hook is called, to cancel the normal level up flow.
virtual void	OnPlayerSendListInventory (Player *, ObjectGuid, uint32 &)
	This hook is called whenever a player interacts with a vendor, and is then shown the vendor list.
virtual void	OnPlayerGetReputationPriceDiscount (Player const *, Creature const *, float &)
	This hook is called whenever a player attempts to buy items, repair, take taxis, or learn spells. This then uses this information to call OnPlayerGetReputationPriceDiscoun(Player, FactionTemplateEntry, float)
virtual void	OnPlayerGetReputationPriceDiscount (Player const *, FactionTemplateEntry const *, float &)
	This hook is called whenever a player attempts to buy items, repair, take taxis, or learn spells. It is also called when continuing along taxis.
virtual void	OnPlayerLearnTaxiNode (Player const *, uint32)
	This hook is called when a player learns a new flight path node.
virtual void	OnPlayerBeforeGetLevelForXPGain (Player const *, uint8 &)
	This hook is called when XP is calculated for the player, and is used to modify the player level used in the XP formulas.
Public Member Functions inherited from ScriptObject
virtual bool	IsDatabaseBound () const
virtual bool	isAfterLoadScript () const
virtual void	checkValidity ()
const std::string &	GetName () const
uint16	GetTotalAvailableHooks ()

Additional Inherited Members
Protected Member Functions inherited from PlayerScript
	PlayerScript (const char *name, std::vector< uint16 > enabledHooks=std::vector< uint16 >())
Protected Member Functions inherited from ScriptObject
	ScriptObject (const char *name, uint16 totalAvailableHooks=0)
virtual	~ScriptObject ()=default

Detailed Description

Constructor & Destructor Documentation

ChatLogScript()

ChatLogScript::ChatLogScript ( )

inline

                    :
        PlayerScript("ChatLogScript",
        {
            PLAYERHOOK_CAN_PLAYER_USE_CHAT,
            PLAYERHOOK_CAN_PLAYER_USE_PRIVATE_CHAT,
            PLAYERHOOK_CAN_PLAYER_USE_GROUP_CHAT,
            PLAYERHOOK_CAN_PLAYER_USE_GUILD_CHAT,
            PLAYERHOOK_CAN_PLAYER_USE_CHANNEL_CHAT,
        })
    {
    }

References PLAYERHOOK_CAN_PLAYER_USE_CHANNEL_CHAT, PLAYERHOOK_CAN_PLAYER_USE_CHAT, PLAYERHOOK_CAN_PLAYER_USE_GROUP_CHAT, PLAYERHOOK_CAN_PLAYER_USE_GUILD_CHAT, and PLAYERHOOK_CAN_PLAYER_USE_PRIVATE_CHAT.

Member Function Documentation

OnPlayerCanUseChat() [1/5]

bool ChatLogScript::OnPlayerCanUseChat ( Player *  , uint32  , uint32  , std::string &    )

inlineoverridevirtual

This hook called before player sending message in default chat.

Parameters

player	Contains information about the Player sender
type	Contains information about the chat message type
language	Contains information about the language type
msg	Contains information about the message

Returns

True if you want to continue sending the message, false if you want to disable sending the message

Reimplemented from PlayerScript.

    {
        if (!sWorld->getBoolConfig(CONFIG_CHATLOG_ENABLED))
            return true;
 
        std::string logType = "";
        std::string chatType = "";
 
        switch (type)
        {
            case CHAT_MSG_SAY:
                logType = "chat.say";
                chatType = "says";
                break;
            case CHAT_MSG_EMOTE:
                logType = "chat.emote";
                chatType = "emotes";
                break;
            case CHAT_MSG_YELL:
                logType = "chat.yell";
                chatType = "yells";
                break;
            default:
                return true;
        }
 
        LOG_INFO(logType, "Player {} {} (language {}): {}",
            player->GetName(), chatType, lang, msg);
 
        return true;
    }

References CHAT_MSG_EMOTE, CHAT_MSG_SAY, CHAT_MSG_YELL, CONFIG_CHATLOG_ENABLED, WorldObject::GetName(), LOG_INFO, and sWorld.

OnPlayerCanUseChat() [2/5]

bool ChatLogScript::OnPlayerCanUseChat ( Player *  , uint32  , uint32  , std::string &  , Group *    )

inlineoverridevirtual

This hook called before player sending message to group.

Parameters

player	Contains information about the Player sender
type	Contains information about the chat message type
language	Contains information about the language type
msg	Contains information about the message
group	Contains information about the Group

Returns

True if you want to continue sending the message, false if you want to disable sending the message

NOTE: LANG_ADDON can only be sent by client in "PARTY", "RAID", "GUILD", "BATTLEGROUND", "WHISPER"

Reimplemented from PlayerScript.

    {
        if (!sWorld->getBoolConfig(CONFIG_CHATLOG_ENABLED))
            return true;
 
        std::string logType = (lang != LANG_ADDON) ? "chat." : "chat.addon.";
        std::string msgType = "";
 
        switch (type)
        {
            case CHAT_MSG_PARTY:
            case CHAT_MSG_PARTY_LEADER:
                msgType = "party";
                break;
            case CHAT_MSG_RAID:
            case CHAT_MSG_RAID_LEADER:
            case CHAT_MSG_RAID_WARNING:
                msgType = "raid";
                break;
            case CHAT_MSG_BATTLEGROUND:
            case CHAT_MSG_BATTLEGROUND_LEADER:
                msgType = "bg";
                break;
            default:
                return true;
        }
 
        std::string role = (type == CHAT_MSG_PARTY_LEADER || type == CHAT_MSG_RAID_LEADER || type == CHAT_MSG_BATTLEGROUND_LEADER) ? "Leader player" : "Player";
        std::string action = (type == CHAT_MSG_RAID_WARNING) ? "sends raid warning" : "tells";
        std::string targetGroup = group ? group->GetLeaderName() : "<unknown>";
 
        LOG_INFO(logType + msgType, "{} {} {} {} with leader {}: {}",
            role, player->GetName(), action, msgType, targetGroup, msg);
 
        return true;
    }

References CHAT_MSG_BATTLEGROUND, CHAT_MSG_BATTLEGROUND_LEADER, CHAT_MSG_PARTY, CHAT_MSG_PARTY_LEADER, CHAT_MSG_RAID, CHAT_MSG_RAID_LEADER, CHAT_MSG_RAID_WARNING, CONFIG_CHATLOG_ENABLED, Group::GetLeaderName(), WorldObject::GetName(), LANG_ADDON, LOG_INFO, and sWorld.

OnPlayerCanUseChat() [3/5]

bool ChatLogScript::OnPlayerCanUseChat ( Player *  , uint32  , uint32  , std::string &  , Guild *    )

inlineoverridevirtual

This hook called before player sending message to guild.

Parameters

player	Contains information about the Player sender
type	Contains information about the chat message type
language	Contains information about the language type
msg	Contains information about the message
guild	Contains information about the Guild

Returns

True if you want to continue sending the message, false if you want to disable sending the message

NOTE: LANG_ADDON can only be sent by client in "PARTY", "RAID", "GUILD", "BATTLEGROUND", "WHISPER"

Reimplemented from PlayerScript.

    {
        if (!sWorld->getBoolConfig(CONFIG_CHATLOG_ENABLED))
            return true;
 
        std::string logType = (lang != LANG_ADDON) ? "chat." : "chat.addon.";
        std::string msgType = "";
 
        switch (type)
        {
            case CHAT_MSG_GUILD:
                msgType = "guild";
                break;
            case CHAT_MSG_OFFICER:
                msgType = "guild.officer";
                break;
            default:
                return true;
        }
 
        LOG_INFO(logType + msgType, "Player {} tells {} \"{}\": {}",
            player->GetName(), msgType, guild ? guild->GetName() : "<unknown>", msg);
 
        return true;
    }

References CHAT_MSG_GUILD, CHAT_MSG_OFFICER, CONFIG_CHATLOG_ENABLED, WorldObject::GetName(), Guild::GetName(), LANG_ADDON, LOG_INFO, and sWorld.

OnPlayerCanUseChat() [4/5]

bool ChatLogScript::OnPlayerCanUseChat ( Player *  , uint32  , uint32  , std::string &  , Player *    )

inlineoverridevirtual

This hook called before player sending message to other player via private.

Parameters

player	Contains information about the Player sender
type	Contains information about the chat message type
language	Contains information about the language type
msg	Contains information about the message
receiver	Contains information about the Player receiver

Returns

True if you want to continue sending the message, false if you want to disable sending the message

NOTE: LANG_ADDON can only be sent by client in "PARTY", "RAID", "GUILD", "BATTLEGROUND", "WHISPER"

Reimplemented from PlayerScript.

    {
        if (!sWorld->getBoolConfig(CONFIG_CHATLOG_ENABLED))
            return true;
 
        std::string logType = (lang != LANG_ADDON) ? "chat." : "chat.addon.";
        std::string msgType = "whisper";
 
        LOG_INFO(logType + msgType, "Player {} {} {}: {}",
               player->GetName(), msgType, receiver ? receiver->GetName() : "<unknown>", msg);
 
        return true;
    }

References CONFIG_CHATLOG_ENABLED, WorldObject::GetName(), LANG_ADDON, LOG_INFO, and sWorld.

OnPlayerCanUseChat() [5/5]

bool ChatLogScript::OnPlayerCanUseChat ( Player *  , uint32  , uint32  , std::string &  , Channel *    )

inlineoverridevirtual

This hook called before player sending message to channel.

Parameters

player	Contains information about the Player sender
type	Contains information about the chat message type
language	Contains information about the language type
msg	Contains information about the message
channel	Contains information about the Channel

Returns

True if you want to continue sending the message, false if you want to disable sending the message

Reimplemented from PlayerScript.

    {
        if (!sWorld->getBoolConfig(CONFIG_CHATLOG_ENABLED))
            return true;
 
        bool isSystem = channel &&
                        (channel->HasFlag(CHANNEL_FLAG_TRADE) ||
                         channel->HasFlag(CHANNEL_FLAG_GENERAL) ||
                         channel->HasFlag(CHANNEL_FLAG_CITY) ||
                         channel->HasFlag(CHANNEL_FLAG_LFG));
 
        if (isSystem)
        {
            LOG_INFO("chat.channel", "Player {} tells channel {}: {}",
                player->GetName(), channel->GetName(), msg);
        }
        else
        {
            // Allow to log custom channels. i.e. world channel
            // in that case set config: Logger.channel.world=6,Chat
            std::string channelName = channel ? channel->GetName() : "<unknown>";
            LOG_INFO("chat.channel." + channelName, "Player {} tells channel {}: {}",
                player->GetName(), channelName, msg);
        }
 
        return true;
    }

References CHANNEL_FLAG_CITY, CHANNEL_FLAG_GENERAL, CHANNEL_FLAG_LFG, CHANNEL_FLAG_TRADE, CONFIG_CHATLOG_ENABLED, Channel::GetName(), WorldObject::GetName(), Channel::HasFlag(), LOG_INFO, and sWorld.

---

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

• azerothcore-wotlk/src/server/scripts/World/chat_log.cpp