[Server] Bring comments up-to-date for packet-sending script functions

0.6.3
David Cernat 7 years ago
parent 2f1ef049d2
commit 563269d359

@ -58,8 +58,8 @@ public:
* \param pid The player ID whose book changes should be used. * \param pid The player ID whose book changes should be used.
* \param sendToOtherPlayers Whether this packet should be sent to players other than the * \param sendToOtherPlayers Whether this packet should be sent to players other than the
* player attached to the packet (false by default). * player attached to the packet (false by default).
* \param sendToAttachedPlayer Whether the packet should be sent to the player attached * \param skipAttachedPlayer Whether the packet should skip being sent to the player attached
* to the packet (true by default). * to the packet (false by default).
* \return void * \return void
*/ */
static void SendBookChanges(unsigned short pid, bool sendToOtherPlayers, bool skipAttachedPlayer) noexcept; static void SendBookChanges(unsigned short pid, bool sendToOtherPlayers, bool skipAttachedPlayer) noexcept;

@ -19,8 +19,8 @@ public:
* \param message The contents of the message. * \param message The contents of the message.
* \param sendToOtherPlayers Whether this packet should be sent to players other than the * \param sendToOtherPlayers Whether this packet should be sent to players other than the
* player attached to the packet (false by default). * player attached to the packet (false by default).
* \param sendToAttachedPlayer Whether the packet should be sent to the player attached * \param skipAttachedPlayer Whether the packet should skip being sent to the player attached
* to the packet (true by default). * to the packet (false by default).
* \return void * \return void
*/ */
static void SendMessage(unsigned short pid, const char *message, bool sendToOtherPlayers, bool skipAttachedPlayer) noexcept; static void SendMessage(unsigned short pid, const char *message, bool sendToOtherPlayers, bool skipAttachedPlayer) noexcept;

@ -61,8 +61,8 @@ public:
* \param pid The player ID whose topic changes should be used. * \param pid The player ID whose topic changes should be used.
* \param sendToOtherPlayers Whether this packet should be sent to players other than the * \param sendToOtherPlayers Whether this packet should be sent to players other than the
* player attached to the packet (false by default). * player attached to the packet (false by default).
* \param sendToAttachedPlayer Whether the packet should be sent to the player attached * \param skipAttachedPlayer Whether the packet should skip being sent to the player attached
* to the packet (true by default). * to the packet (false by default).
* \return void * \return void
*/ */
static void SendTopicChanges(unsigned short pid, bool sendToOtherPlayers, bool skipAttachedPlayer) noexcept; static void SendTopicChanges(unsigned short pid, bool sendToOtherPlayers, bool skipAttachedPlayer) noexcept;

@ -146,8 +146,8 @@ public:
* \param pid The player ID whose faction changes should be used. * \param pid The player ID whose faction changes should be used.
* \param sendToOtherPlayers Whether this packet should be sent to players other than the * \param sendToOtherPlayers Whether this packet should be sent to players other than the
* player attached to the packet (false by default). * player attached to the packet (false by default).
* \param sendToAttachedPlayer Whether the packet should be sent to the player attached * \param skipAttachedPlayer Whether the packet should skip being sent to the player attached
* to the packet (true by default). * to the packet (false by default).
* \return void * \return void
*/ */
static void SendFactionChanges(unsigned short pid, bool sendToOtherPlayers, bool skipAttachedPlayer) noexcept; static void SendFactionChanges(unsigned short pid, bool sendToOtherPlayers, bool skipAttachedPlayer) noexcept;

@ -213,8 +213,8 @@ public:
* \param pid The player ID whose inventory changes should be used. * \param pid The player ID whose inventory changes should be used.
* \param sendToOtherPlayers Whether this packet should be sent to players other than the * \param sendToOtherPlayers Whether this packet should be sent to players other than the
* player attached to the packet (false by default). * player attached to the packet (false by default).
* \param sendToAttachedPlayer Whether the packet should be sent to the player attached * \param skipAttachedPlayer Whether the packet should skip being sent to the player attached
* to the packet (true by default). * to the packet (false by default).
* \return void * \return void
*/ */
static void SendInventoryChanges(unsigned short pid, bool sendToOtherPlayers, bool skipAttachedPlayer) noexcept; static void SendInventoryChanges(unsigned short pid, bool sendToOtherPlayers, bool skipAttachedPlayer) noexcept;

@ -781,8 +781,8 @@ public:
* *
* \param sendToOtherPlayers Whether this packet should be sent to players other than the * \param sendToOtherPlayers Whether this packet should be sent to players other than the
* player attached to the packet (false by default). * player attached to the packet (false by default).
* \param sendToAttachedPlayer Whether the packet should be sent to the player attached * \param skipAttachedPlayer Whether the packet should skip being sent to the player attached
* to the packet (true by default). * to the packet (false by default).
* \return void * \return void
*/ */
static void SendObjectPlace(bool sendToOtherPlayers, bool skipAttachedPlayer) noexcept; 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 * \param sendToOtherPlayers Whether this packet should be sent to players other than the
* player attached to the packet (false by default). * player attached to the packet (false by default).
* \param sendToAttachedPlayer Whether the packet should be sent to the player attached * \param skipAttachedPlayer Whether the packet should skip being sent to the player attached
* to the packet (true by default). * to the packet (false by default).
* \return void * \return void
*/ */
static void SendObjectSpawn(bool sendToOtherPlayers, bool skipAttachedPlayer) noexcept; 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 * \param sendToOtherPlayers Whether this packet should be sent to players other than the
* player attached to the packet (false by default). * player attached to the packet (false by default).
* \param sendToAttachedPlayer Whether the packet should be sent to the player attached * \param skipAttachedPlayer Whether the packet should skip being sent to the player attached
* to the packet (true by default). * to the packet (false by default).
* \return void * \return void
*/ */
static void SendObjectLock(bool sendToOtherPlayers, bool skipAttachedPlayer) noexcept; 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 * \param sendToOtherPlayers Whether this packet should be sent to players other than the
* player attached to the packet (false by default). * player attached to the packet (false by default).
* \param sendToAttachedPlayer Whether the packet should be sent to the player attached * \param skipAttachedPlayer Whether the packet should skip being sent to the player attached
* to the packet (true by default). * to the packet (false by default).
* \return void * \return void
*/ */
static void SendObjectScale(bool sendToOtherPlayers, bool skipAttachedPlayer) noexcept; 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 * \param sendToOtherPlayers Whether this packet should be sent to players other than the
* player attached to the packet (false by default). * player attached to the packet (false by default).
* \param sendToAttachedPlayer Whether the packet should be sent to the player attached * \param skipAttachedPlayer Whether the packet should skip being sent to the player attached
* to the packet (true by default). * to the packet (false by default).
* \return void * \return void
*/ */
static void SendObjectState(bool sendToOtherPlayers, bool skipAttachedPlayer) noexcept; 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 * \param sendToOtherPlayers Whether this packet should be sent to players other than the
* player attached to the packet (false by default). * player attached to the packet (false by default).
* \param sendToAttachedPlayer Whether the packet should be sent to the player attached * \param skipAttachedPlayer Whether the packet should skip being sent to the player attached
* to the packet (true by default). * to the packet (false by default).
* \return void * \return void
*/ */
static void SendDoorState(bool sendToOtherPlayers, bool skipAttachedPlayer) noexcept; 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 * \param sendToOtherPlayers Whether this packet should be sent to players other than the
* player attached to the packet (false by default). * player attached to the packet (false by default).
* \param sendToAttachedPlayer Whether the packet should be sent to the player attached * \param skipAttachedPlayer Whether the packet should skip being sent to the player attached
* to the packet (true by default). * to the packet (false by default).
* \return void * \return void
*/ */
static void SendDoorDestination(bool sendToOtherPlayers, bool skipAttachedPlayer) noexcept; 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 * \param sendToOtherPlayers Whether this packet should be sent to players other than the
* player attached to the packet (false by default). * player attached to the packet (false by default).
* \param sendToAttachedPlayer Whether the packet should be sent to the player attached * \param skipAttachedPlayer Whether the packet should skip being sent to the player attached
* to the packet (true by default). * to the packet (false by default).
* \return void * \return void
*/ */
static void SendContainer(bool sendToOtherPlayers, bool skipAttachedPlayer) noexcept; 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 * \param sendToOtherPlayers Whether this packet should be sent to players other than the
* player attached to the packet (false by default). * player attached to the packet (false by default).
* \param sendToAttachedPlayer Whether the packet should be sent to the player attached * \param skipAttachedPlayer Whether the packet should skip being sent to the player attached
* to the packet (true by default). * to the packet (false by default).
* \return void * \return void
*/ */
static void SendVideoPlay(bool sendToOtherPlayers, bool skipAttachedPlayer) noexcept; 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 * \param sendToOtherPlayers Whether this packet should be sent to players other than the
* player attached to the packet (false by default). * player attached to the packet (false by default).
* \param sendToAttachedPlayer Whether the packet should be sent to the player attached * \param skipAttachedPlayer Whether the packet should skip being sent to the player attached
* to the packet (true by default). * to the packet (false by default).
* \return void * \return void
*/ */
static void SendConsoleCommand(bool sendToOtherPlayers, bool skipAttachedPlayer) noexcept; static void SendConsoleCommand(bool sendToOtherPlayers, bool skipAttachedPlayer) noexcept;

@ -177,8 +177,8 @@ public:
* \param pid The player ID whose journal changes should be used. * \param pid The player ID whose journal changes should be used.
* \param sendToOtherPlayers Whether this packet should be sent to players other than the * \param sendToOtherPlayers Whether this packet should be sent to players other than the
* player attached to the packet (false by default). * player attached to the packet (false by default).
* \param sendToAttachedPlayer Whether the packet should be sent to the player attached * \param skipAttachedPlayer Whether the packet should skip being sent to the player attached
* to the packet (true by default). * to the packet (false by default).
* \return void * \return void
*/ */
static void SendJournalChanges(unsigned short pid, bool sendToOtherPlayers, bool skipAttachedPlayer) noexcept; 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 pid The player ID whose kill count changes should be used.
* \param sendToOtherPlayers Whether this packet should be sent to players other than the * \param sendToOtherPlayers Whether this packet should be sent to players other than the
* player attached to the packet (false by default). * player attached to the packet (false by default).
* \param sendToAttachedPlayer Whether the packet should be sent to the player attached * \param skipAttachedPlayer Whether the packet should skip being sent to the player attached
* to the packet (true by default). * to the packet (false by default).
* \return void * \return void
*/ */
static void SendKillChanges(unsigned short pid, bool sendToOtherPlayers, bool skipAttachedPlayer) noexcept; 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 pid The player ID whose reputation should be used.
* \param sendToOtherPlayers Whether this packet should be sent to players other than the * \param sendToOtherPlayers Whether this packet should be sent to players other than the
* player attached to the packet (false by default). * player attached to the packet (false by default).
* \param sendToAttachedPlayer Whether the packet should be sent to the player attached * \param skipAttachedPlayer Whether the packet should skip being sent to the player attached
* to the packet (true by default). * to the packet (false by default).
* \return void * \return void
*/ */
static void SendReputation(unsigned short pid, bool sendToOtherPlayers, bool skipAttachedPlayer) noexcept; static void SendReputation(unsigned short pid, bool sendToOtherPlayers, bool skipAttachedPlayer) noexcept;

@ -257,8 +257,8 @@ public:
* \param pid The player ID whose spellbook changes should be used. * \param pid The player ID whose spellbook changes should be used.
* \param sendToOtherPlayers Whether this packet should be sent to players other than the * \param sendToOtherPlayers Whether this packet should be sent to players other than the
* player attached to the packet (false by default). * player attached to the packet (false by default).
* \param sendToAttachedPlayer Whether the packet should be sent to the player attached * \param skipAttachedPlayer Whether the packet should skip being sent to the player attached
* to the packet (true by default). * to the packet (false by default).
* \return void * \return void
*/ */
static void SendSpellbookChanges(unsigned short pid, bool sendToOtherPlayers, bool skipAttachedPlayer) noexcept; static void SendSpellbookChanges(unsigned short pid, bool sendToOtherPlayers, bool skipAttachedPlayer) noexcept;

@ -232,8 +232,8 @@ public:
* \param pid The player ID attached to the packet. * \param pid The player ID attached to the packet.
* \param sendToOtherPlayers Whether this packet should be sent to players other than the * \param sendToOtherPlayers Whether this packet should be sent to players other than the
* player attached to the packet (false by default). * player attached to the packet (false by default).
* \param sendToAttachedPlayer Whether the packet should be sent to the player attached * \param skipAttachedPlayer Whether the packet should skip being sent to the player attached
* to the packet (true by default). * to the packet (false by default).
* \return void * \return void
*/ */
static void SendWorldTime(unsigned short pid, bool sendToOtherPlayers, bool skipAttachedPlayer) noexcept; 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 pid The player ID attached to the packet.
* \param sendToOtherPlayers Whether this packet should be sent to players other than the * \param sendToOtherPlayers Whether this packet should be sent to players other than the
* player attached to the packet (false by default). * player attached to the packet (false by default).
* \param sendToAttachedPlayer Whether the packet should be sent to the player attached * \param skipAttachedPlayer Whether the packet should skip being sent to the player attached
* to the packet (true by default). * to the packet (false by default).
* \return void * \return void
*/ */
static void SendWorldCollisionOverride(unsigned short pid, bool sendToOtherPlayers, bool skipAttachedPlayer) noexcept; static void SendWorldCollisionOverride(unsigned short pid, bool sendToOtherPlayers, bool skipAttachedPlayer) noexcept;

Loading…
Cancel
Save