openmw-tes3coop/apps/openmw-mp/Script/Functions/Chat.h

#ifndef OPENMW_CHATAPI_HPP
#define OPENMW_CHATAPI_HPP

#include "../api.h"

NAMESPACE_BEGIN(ChatFunctions)
    /**
    * \brief Send a message to a certain player.
    *
    * \param pid The player ID.
    * \param message The contents of the message.
    * \param sendToOtherPlayers Whether this packet should be sent to players other than the
    *                           player attached to the packet (false by default).
    * \param skipAttachedPlayer Whether the packet should skip being sent to the player attached
    *                           to the packet (false by default).
    * \return void
    */
    API_FUNCTION void CDECL SendMessage(PlayerId pid, const char *message, bool sendToOtherPlayers, bool skipAttachedPlayer) NOEXCEPT;

    /**
    * \brief Remove all messages from chat for a certain player.
    *
    * \param pid The player ID.
    * \return void
    */
    API_FUNCTION void CDECL CleanChatForPid(PlayerId pid);

    /**
    * \brief Remove all messages from chat for everyone on the server.
    *
    * \return void
    */
    API_FUNCTION void CDECL CleanChat();
NAMESPACE_END()

#endif //OPENMW_CHATAPI_HPP