Add missing docs

This commit is contained in:
Sofia 2017-05-11 06:13:02 +03:00
parent 810f6a428f
commit c6b2c6f8f4
3 changed files with 11 additions and 3 deletions

View File

@ -1,5 +1,9 @@
 
namespace Cyber.Entities { namespace Cyber.Entities {
/// <summary>
/// Contains information about the interactable SyncBase's syncing style.
/// </summary>
public struct InteractableSyncdata { public struct InteractableSyncdata {
/// <summary> /// <summary>
@ -15,8 +19,8 @@ namespace Cyber.Entities {
/// <summary> /// <summary>
/// Creates an InteractibleSyncdata struct. /// Creates an InteractibleSyncdata struct.
/// </summary> /// </summary>
/// <param name="RequiresSyncing">Weather this interactible requires syncing (like a door) or not (like a bell).</param> /// <param name="requiresSyncing">Weather this interactible requires syncing (like a door) or not (like a bell).</param>
/// <param name="PublicInteractions">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).</param> /// <param name="publicInteractions">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).</param>
public InteractableSyncdata(bool requiresSyncing, bool publicInteractions) { public InteractableSyncdata(bool requiresSyncing, bool publicInteractions) {
RequiresSyncing = requiresSyncing; RequiresSyncing = requiresSyncing;
PublicInteractions = publicInteractions; PublicInteractions = publicInteractions;

View File

@ -158,6 +158,10 @@ namespace Cyber.Entities {
} }
} }
/// <summary>
/// Returns the list of id's on the static objects that exist on the world by default.
/// </summary>
/// <returns></returns>
public int[] GetStaticSyncBaseIDList() { public int[] GetStaticSyncBaseIDList() {
return StaticSyncBaseIDList.ToArray(); return StaticSyncBaseIDList.ToArray();
} }

View File

@ -21,7 +21,7 @@ namespace Cyber.Networking.Messages {
/// <summary> /// <summary>
/// Creates an InteraktionPkt, which contains the message "someone interacted". /// Creates an InteraktionPkt, which contains the message "someone interacted".
/// </summary> /// </summary>
/// <param name="SyncBaseID"></param> /// <param name="syncBaseID">The Sync Base ID of the interacted thing.</param>
public InteractionPkt(int syncBaseID) { public InteractionPkt(int syncBaseID) {
InteractSyncBaseID = syncBaseID; InteractSyncBaseID = syncBaseID;
} }