From 563269d3591a71656db27118b6f59c6e55b99c92 Mon Sep 17 00:00:00 2001 From: David Cernat Date: Sat, 7 Jul 2018 20:16:36 +0300 Subject: [PATCH] [Server] Bring comments up-to-date for packet-sending script functions --- apps/openmw-mp/Script/Functions/Books.hpp | 4 +- apps/openmw-mp/Script/Functions/Chat.hpp | 4 +- apps/openmw-mp/Script/Functions/Dialogue.hpp | 4 +- apps/openmw-mp/Script/Functions/Factions.hpp | 4 +- apps/openmw-mp/Script/Functions/Items.hpp | 4 +- apps/openmw-mp/Script/Functions/Objects.hpp | 40 +++++++++---------- apps/openmw-mp/Script/Functions/Quests.hpp | 12 +++--- apps/openmw-mp/Script/Functions/Spells.hpp | 4 +- .../openmw-mp/Script/Functions/Worldstate.hpp | 8 ++-- 9 files changed, 42 insertions(+), 42 deletions(-) diff --git a/apps/openmw-mp/Script/Functions/Books.hpp b/apps/openmw-mp/Script/Functions/Books.hpp index d9932062d..a9a653877 100644 --- a/apps/openmw-mp/Script/Functions/Books.hpp +++ b/apps/openmw-mp/Script/Functions/Books.hpp @@ -58,8 +58,8 @@ public: * \param pid The player ID whose book changes should be used. * \param sendToOtherPlayers Whether this packet should be sent to players other than the * player attached to the packet (false by default). - * \param sendToAttachedPlayer Whether the packet should be sent to the player attached - * to the packet (true by default). + * \param skipAttachedPlayer Whether the packet should skip being sent to the player attached + * to the packet (false by default). * \return void */ static void SendBookChanges(unsigned short pid, bool sendToOtherPlayers, bool skipAttachedPlayer) noexcept; diff --git a/apps/openmw-mp/Script/Functions/Chat.hpp b/apps/openmw-mp/Script/Functions/Chat.hpp index 3d736f4b7..cdf1e1f05 100644 --- a/apps/openmw-mp/Script/Functions/Chat.hpp +++ b/apps/openmw-mp/Script/Functions/Chat.hpp @@ -19,8 +19,8 @@ public: * \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 sendToAttachedPlayer Whether the packet should be sent to the player attached - * to the packet (true by default). + * \param skipAttachedPlayer Whether the packet should skip being sent to the player attached + * to the packet (false by default). * \return void */ static void SendMessage(unsigned short pid, const char *message, bool sendToOtherPlayers, bool skipAttachedPlayer) noexcept; diff --git a/apps/openmw-mp/Script/Functions/Dialogue.hpp b/apps/openmw-mp/Script/Functions/Dialogue.hpp index 9ae5e4ed0..b86a2f01e 100644 --- a/apps/openmw-mp/Script/Functions/Dialogue.hpp +++ b/apps/openmw-mp/Script/Functions/Dialogue.hpp @@ -61,8 +61,8 @@ public: * \param pid The player ID whose topic changes should be used. * \param sendToOtherPlayers Whether this packet should be sent to players other than the * player attached to the packet (false by default). - * \param sendToAttachedPlayer Whether the packet should be sent to the player attached - * to the packet (true by default). + * \param skipAttachedPlayer Whether the packet should skip being sent to the player attached + * to the packet (false by default). * \return void */ static void SendTopicChanges(unsigned short pid, bool sendToOtherPlayers, bool skipAttachedPlayer) noexcept; diff --git a/apps/openmw-mp/Script/Functions/Factions.hpp b/apps/openmw-mp/Script/Functions/Factions.hpp index 6a05e7161..8fe91af6d 100644 --- a/apps/openmw-mp/Script/Functions/Factions.hpp +++ b/apps/openmw-mp/Script/Functions/Factions.hpp @@ -146,8 +146,8 @@ public: * \param pid The player ID whose faction changes should be used. * \param sendToOtherPlayers Whether this packet should be sent to players other than the * player attached to the packet (false by default). - * \param sendToAttachedPlayer Whether the packet should be sent to the player attached - * to the packet (true by default). + * \param skipAttachedPlayer Whether the packet should skip being sent to the player attached + * to the packet (false by default). * \return void */ static void SendFactionChanges(unsigned short pid, bool sendToOtherPlayers, bool skipAttachedPlayer) noexcept; diff --git a/apps/openmw-mp/Script/Functions/Items.hpp b/apps/openmw-mp/Script/Functions/Items.hpp index 2cfec98ed..f146534a0 100644 --- a/apps/openmw-mp/Script/Functions/Items.hpp +++ b/apps/openmw-mp/Script/Functions/Items.hpp @@ -213,8 +213,8 @@ public: * \param pid The player ID whose inventory changes should be used. * \param sendToOtherPlayers Whether this packet should be sent to players other than the * player attached to the packet (false by default). - * \param sendToAttachedPlayer Whether the packet should be sent to the player attached - * to the packet (true by default). + * \param skipAttachedPlayer Whether the packet should skip being sent to the player attached + * to the packet (false by default). * \return void */ static void SendInventoryChanges(unsigned short pid, bool sendToOtherPlayers, bool skipAttachedPlayer) noexcept; diff --git a/apps/openmw-mp/Script/Functions/Objects.hpp b/apps/openmw-mp/Script/Functions/Objects.hpp index f90c8bade..b7c0bab6c 100644 --- a/apps/openmw-mp/Script/Functions/Objects.hpp +++ b/apps/openmw-mp/Script/Functions/Objects.hpp @@ -781,8 +781,8 @@ public: * * \param sendToOtherPlayers Whether this packet should be sent to players other than the * player attached to the packet (false by default). - * \param sendToAttachedPlayer Whether the packet should be sent to the player attached - * to the packet (true by default). + * \param skipAttachedPlayer Whether the packet should skip being sent to the player attached + * to the packet (false by default). * \return void */ static void SendObjectPlace(bool sendToOtherPlayers, bool skipAttachedPlayer) noexcept; @@ -792,8 +792,8 @@ public: * * \param sendToOtherPlayers Whether this packet should be sent to players other than the * player attached to the packet (false by default). - * \param sendToAttachedPlayer Whether the packet should be sent to the player attached - * to the packet (true by default). + * \param skipAttachedPlayer Whether the packet should skip being sent to the player attached + * to the packet (false by default). * \return void */ static void SendObjectSpawn(bool sendToOtherPlayers, bool skipAttachedPlayer) noexcept; @@ -813,8 +813,8 @@ public: * * \param sendToOtherPlayers Whether this packet should be sent to players other than the * player attached to the packet (false by default). - * \param sendToAttachedPlayer Whether the packet should be sent to the player attached - * to the packet (true by default). + * \param skipAttachedPlayer Whether the packet should skip being sent to the player attached + * to the packet (false by default). * \return void */ static void SendObjectLock(bool sendToOtherPlayers, bool skipAttachedPlayer) noexcept; @@ -834,8 +834,8 @@ public: * * \param sendToOtherPlayers Whether this packet should be sent to players other than the * player attached to the packet (false by default). - * \param sendToAttachedPlayer Whether the packet should be sent to the player attached - * to the packet (true by default). + * \param skipAttachedPlayer Whether the packet should skip being sent to the player attached + * to the packet (false by default). * \return void */ static void SendObjectScale(bool sendToOtherPlayers, bool skipAttachedPlayer) noexcept; @@ -845,8 +845,8 @@ public: * * \param sendToOtherPlayers Whether this packet should be sent to players other than the * player attached to the packet (false by default). - * \param sendToAttachedPlayer Whether the packet should be sent to the player attached - * to the packet (true by default). + * \param skipAttachedPlayer Whether the packet should skip being sent to the player attached + * to the packet (false by default). * \return void */ static void SendObjectState(bool sendToOtherPlayers, bool skipAttachedPlayer) noexcept; @@ -856,8 +856,8 @@ public: * * \param sendToOtherPlayers Whether this packet should be sent to players other than the * player attached to the packet (false by default). - * \param sendToAttachedPlayer Whether the packet should be sent to the player attached - * to the packet (true by default). + * \param skipAttachedPlayer Whether the packet should skip being sent to the player attached + * to the packet (false by default). * \return void */ static void SendDoorState(bool sendToOtherPlayers, bool skipAttachedPlayer) noexcept; @@ -867,8 +867,8 @@ public: * * \param sendToOtherPlayers Whether this packet should be sent to players other than the * player attached to the packet (false by default). - * \param sendToAttachedPlayer Whether the packet should be sent to the player attached - * to the packet (true by default). + * \param skipAttachedPlayer Whether the packet should skip being sent to the player attached + * to the packet (false by default). * \return void */ static void SendDoorDestination(bool sendToOtherPlayers, bool skipAttachedPlayer) noexcept; @@ -878,8 +878,8 @@ public: * * \param sendToOtherPlayers Whether this packet should be sent to players other than the * player attached to the packet (false by default). - * \param sendToAttachedPlayer Whether the packet should be sent to the player attached - * to the packet (true by default). + * \param skipAttachedPlayer Whether the packet should skip being sent to the player attached + * to the packet (false by default). * \return void */ static void SendContainer(bool sendToOtherPlayers, bool skipAttachedPlayer) noexcept; @@ -889,8 +889,8 @@ public: * * \param sendToOtherPlayers Whether this packet should be sent to players other than the * player attached to the packet (false by default). - * \param sendToAttachedPlayer Whether the packet should be sent to the player attached - * to the packet (true by default). + * \param skipAttachedPlayer Whether the packet should skip being sent to the player attached + * to the packet (false by default). * \return void */ static void SendVideoPlay(bool sendToOtherPlayers, bool skipAttachedPlayer) noexcept; @@ -900,8 +900,8 @@ public: * * \param sendToOtherPlayers Whether this packet should be sent to players other than the * player attached to the packet (false by default). - * \param sendToAttachedPlayer Whether the packet should be sent to the player attached - * to the packet (true by default). + * \param skipAttachedPlayer Whether the packet should skip being sent to the player attached + * to the packet (false by default). * \return void */ static void SendConsoleCommand(bool sendToOtherPlayers, bool skipAttachedPlayer) noexcept; diff --git a/apps/openmw-mp/Script/Functions/Quests.hpp b/apps/openmw-mp/Script/Functions/Quests.hpp index 14d3abe06..615bff486 100644 --- a/apps/openmw-mp/Script/Functions/Quests.hpp +++ b/apps/openmw-mp/Script/Functions/Quests.hpp @@ -177,8 +177,8 @@ public: * \param pid The player ID whose journal changes should be used. * \param sendToOtherPlayers Whether this packet should be sent to players other than the * player attached to the packet (false by default). - * \param sendToAttachedPlayer Whether the packet should be sent to the player attached - * to the packet (true by default). + * \param skipAttachedPlayer Whether the packet should skip being sent to the player attached + * to the packet (false by default). * \return void */ static void SendJournalChanges(unsigned short pid, bool sendToOtherPlayers, bool skipAttachedPlayer) noexcept; @@ -189,8 +189,8 @@ public: * \param pid The player ID whose kill count changes should be used. * \param sendToOtherPlayers Whether this packet should be sent to players other than the * player attached to the packet (false by default). - * \param sendToAttachedPlayer Whether the packet should be sent to the player attached - * to the packet (true by default). + * \param skipAttachedPlayer Whether the packet should skip being sent to the player attached + * to the packet (false by default). * \return void */ static void SendKillChanges(unsigned short pid, bool sendToOtherPlayers, bool skipAttachedPlayer) noexcept; @@ -201,8 +201,8 @@ public: * \param pid The player ID whose reputation should be used. * \param sendToOtherPlayers Whether this packet should be sent to players other than the * player attached to the packet (false by default). - * \param sendToAttachedPlayer Whether the packet should be sent to the player attached - * to the packet (true by default). + * \param skipAttachedPlayer Whether the packet should skip being sent to the player attached + * to the packet (false by default). * \return void */ static void SendReputation(unsigned short pid, bool sendToOtherPlayers, bool skipAttachedPlayer) noexcept; diff --git a/apps/openmw-mp/Script/Functions/Spells.hpp b/apps/openmw-mp/Script/Functions/Spells.hpp index 266bc8fee..3d31b74f8 100644 --- a/apps/openmw-mp/Script/Functions/Spells.hpp +++ b/apps/openmw-mp/Script/Functions/Spells.hpp @@ -257,8 +257,8 @@ public: * \param pid The player ID whose spellbook changes should be used. * \param sendToOtherPlayers Whether this packet should be sent to players other than the * player attached to the packet (false by default). - * \param sendToAttachedPlayer Whether the packet should be sent to the player attached - * to the packet (true by default). + * \param skipAttachedPlayer Whether the packet should skip being sent to the player attached + * to the packet (false by default). * \return void */ static void SendSpellbookChanges(unsigned short pid, bool sendToOtherPlayers, bool skipAttachedPlayer) noexcept; diff --git a/apps/openmw-mp/Script/Functions/Worldstate.hpp b/apps/openmw-mp/Script/Functions/Worldstate.hpp index 1598105ea..9ba77b120 100644 --- a/apps/openmw-mp/Script/Functions/Worldstate.hpp +++ b/apps/openmw-mp/Script/Functions/Worldstate.hpp @@ -232,8 +232,8 @@ public: * \param pid The player ID attached to the packet. * \param sendToOtherPlayers Whether this packet should be sent to players other than the * player attached to the packet (false by default). - * \param sendToAttachedPlayer Whether the packet should be sent to the player attached - * to the packet (true by default). + * \param skipAttachedPlayer Whether the packet should skip being sent to the player attached + * to the packet (false by default). * \return void */ static void SendWorldTime(unsigned short pid, bool sendToOtherPlayers, bool skipAttachedPlayer) noexcept; @@ -245,8 +245,8 @@ public: * \param pid The player ID attached to the packet. * \param sendToOtherPlayers Whether this packet should be sent to players other than the * player attached to the packet (false by default). - * \param sendToAttachedPlayer Whether the packet should be sent to the player attached - * to the packet (true by default). + * \param skipAttachedPlayer Whether the packet should skip being sent to the player attached + * to the packet (false by default). * \return void */ static void SendWorldCollisionOverride(unsigned short pid, bool sendToOtherPlayers, bool skipAttachedPlayer) noexcept;