From 2e8a2d0f2a5c8609c0d8e31315a89c276eb4f6a1 Mon Sep 17 00:00:00 2001 From: JohnCorby Date: Thu, 23 Dec 2021 16:53:22 -0800 Subject: [PATCH] update docs again --- QSB/Messaging/QSBMessage.cs | 6 ++++++ QSB/Messaging/QSBWorldObjectMessage.cs | 3 +++ 2 files changed, 9 insertions(+) diff --git a/QSB/Messaging/QSBMessage.cs b/QSB/Messaging/QSBMessage.cs index c1989f13..3c806060 100644 --- a/QSB/Messaging/QSBMessage.cs +++ b/QSB/Messaging/QSBMessage.cs @@ -16,21 +16,27 @@ namespace QSB.Messaging /// public uint To = uint.MaxValue; + /// /// call the base method when overriding + /// public override void Serialize(QNetworkWriter writer) { writer.Write(From); writer.Write(To); } + /// /// call the base method when overriding + /// public override void Deserialize(QNetworkReader reader) { From = reader.ReadUInt32(); To = reader.ReadUInt32(); } + /// /// checked before calling either OnReceive + /// public virtual bool ShouldReceive => true; public virtual void OnReceiveRemote() { } public virtual void OnReceiveLocal() { } diff --git a/QSB/Messaging/QSBWorldObjectMessage.cs b/QSB/Messaging/QSBWorldObjectMessage.cs index b3d91ec7..bca15f92 100644 --- a/QSB/Messaging/QSBWorldObjectMessage.cs +++ b/QSB/Messaging/QSBWorldObjectMessage.cs @@ -27,6 +27,9 @@ namespace QSB.Messaging ObjectId = reader.ReadInt32(); } + /// + /// sets WorldObject using ObjectId + /// public override bool ShouldReceive { get