From c6b2c6f8f494f17d0b940693dfe3ba4a5332ff99 Mon Sep 17 00:00:00 2001 From: teascade Date: Thu, 11 May 2017 06:13:02 +0300 Subject: [PATCH] Add missing docs --- Assets/Scripts/Entities/InteractableSyncdata.cs | 8 ++++++-- Assets/Scripts/Entities/SyncDB.cs | 4 ++++ Assets/Scripts/Networking/Messages/InteractionPkt.cs | 2 +- 3 files changed, 11 insertions(+), 3 deletions(-) diff --git a/Assets/Scripts/Entities/InteractableSyncdata.cs b/Assets/Scripts/Entities/InteractableSyncdata.cs index 3928cb7..15c997f 100644 --- a/Assets/Scripts/Entities/InteractableSyncdata.cs +++ b/Assets/Scripts/Entities/InteractableSyncdata.cs @@ -1,5 +1,9 @@  namespace Cyber.Entities { + + /// + /// Contains information about the interactable SyncBase's syncing style. + /// public struct InteractableSyncdata { /// @@ -15,8 +19,8 @@ namespace Cyber.Entities { /// /// Creates an InteractibleSyncdata struct. /// - /// Weather this interactible requires syncing (like a door) or not (like a bell). - /// Weather interacting with this interactible should send a TCP-packet (like a bell or a door) or not (like opening a screen where you can type). + /// Weather this interactible requires syncing (like a door) or not (like a bell). + /// Weather interacting with this interactible should send a TCP-packet (like a bell or a door) or not (like opening a screen where you can type). public InteractableSyncdata(bool requiresSyncing, bool publicInteractions) { RequiresSyncing = requiresSyncing; PublicInteractions = publicInteractions; diff --git a/Assets/Scripts/Entities/SyncDB.cs b/Assets/Scripts/Entities/SyncDB.cs index d9ed6be..628a2c1 100644 --- a/Assets/Scripts/Entities/SyncDB.cs +++ b/Assets/Scripts/Entities/SyncDB.cs @@ -158,6 +158,10 @@ namespace Cyber.Entities { } } + /// + /// Returns the list of id's on the static objects that exist on the world by default. + /// + /// public int[] GetStaticSyncBaseIDList() { return StaticSyncBaseIDList.ToArray(); } diff --git a/Assets/Scripts/Networking/Messages/InteractionPkt.cs b/Assets/Scripts/Networking/Messages/InteractionPkt.cs index aa1af53..63cf651 100644 --- a/Assets/Scripts/Networking/Messages/InteractionPkt.cs +++ b/Assets/Scripts/Networking/Messages/InteractionPkt.cs @@ -21,7 +21,7 @@ namespace Cyber.Networking.Messages { /// /// Creates an InteraktionPkt, which contains the message "someone interacted". /// - /// + /// The Sync Base ID of the interacted thing. public InteractionPkt(int syncBaseID) { InteractSyncBaseID = syncBaseID; }