From ad2881cd7528401a3daa4b23732d8506634e93e6 Mon Sep 17 00:00:00 2001 From: mordentral Date: Wed, 4 Apr 2018 10:40:26 -0400 Subject: [PATCH] Updated some documentation comments Prepping for auto documentation generation Former-commit-id: a26d6bbb5c6ba5e11d096bfaa486fd08c5b149ff --- .../AdvancedSessions/Classes/AdvancedFriendsGameInstance.h | 1 + .../Source/AdvancedSessions/Classes/AdvancedVoiceLibrary.h | 2 ++ .../AdvancedSessions/Classes/GetUserPrivilegeCallbackProxy.h | 2 +- .../Source/AdvancedSessions/Classes/LoginUserCallbackProxy.h | 2 +- .../AdvancedSteamSessions/Classes/AdvancedSteamFriendsLibrary.h | 1 + .../Classes/SteamRequestGroupOfficersCallbackProxy.h | 2 +- 6 files changed, 7 insertions(+), 3 deletions(-) diff --git a/AdvancedSessions/Source/AdvancedSessions/Classes/AdvancedFriendsGameInstance.h b/AdvancedSessions/Source/AdvancedSessions/Classes/AdvancedFriendsGameInstance.h index 7f8abd2..7b49eee 100644 --- a/AdvancedSessions/Source/AdvancedSessions/Classes/AdvancedFriendsGameInstance.h +++ b/AdvancedSessions/Source/AdvancedSessions/Classes/AdvancedFriendsGameInstance.h @@ -65,6 +65,7 @@ public: void OnSessionInviteAcceptedMaster(const bool bWasSuccessful, int32 LocalPlayer, TSharedPtr PersonInviting, const FOnlineSessionSearchResult& SessionToJoin); // After a session invite has been accepted by the local player this event is triggered, call JoinSession on the session result to join it + // This function is currently not hooked up in any of Epics default subsystems, it is here for custom subsystems UFUNCTION(BlueprintImplementableEvent, Category = "AdvancedFriends") void OnSessionInviteAccepted(int32 LocalPlayerNum, FBPUniqueNetId PersonInvited, const FBlueprintSessionResult& SessionToJoin); diff --git a/AdvancedSessions/Source/AdvancedSessions/Classes/AdvancedVoiceLibrary.h b/AdvancedSessions/Source/AdvancedSessions/Classes/AdvancedVoiceLibrary.h index 6f4c945..a483d1f 100644 --- a/AdvancedSessions/Source/AdvancedSessions/Classes/AdvancedVoiceLibrary.h +++ b/AdvancedSessions/Source/AdvancedSessions/Classes/AdvancedVoiceLibrary.h @@ -48,6 +48,7 @@ public: static bool RegisterLocalTalker(uint8 LocalPlayerNum = 0); // Registers all signed in players as local talkers + // This is already done automatically, only do it manually if you unregistered someone UFUNCTION(BlueprintCallable, Category = "Online|AdvancedVoice") static void RegisterAllLocalTalkers(); @@ -60,6 +61,7 @@ public: static void UnRegisterAllLocalTalkers(); // Registers a remote player as a talker + // This is already done automatically, only do it manually if you unregistered someone UFUNCTION(BlueprintCallable, Category = "Online|AdvancedVoice") static bool RegisterRemoteTalker(const FBPUniqueNetId& UniqueNetId); diff --git a/AdvancedSessions/Source/AdvancedSessions/Classes/GetUserPrivilegeCallbackProxy.h b/AdvancedSessions/Source/AdvancedSessions/Classes/GetUserPrivilegeCallbackProxy.h index cea6d6b..4acef32 100644 --- a/AdvancedSessions/Source/AdvancedSessions/Classes/GetUserPrivilegeCallbackProxy.h +++ b/AdvancedSessions/Source/AdvancedSessions/Classes/GetUserPrivilegeCallbackProxy.h @@ -21,7 +21,7 @@ class UGetUserPrivilegeCallbackProxy : public UOnlineBlueprintCallProxyBase UPROPERTY(BlueprintAssignable) FEmptyOnlineDelegate OnFailure; - // Logs out of the identity interface + // Gets the privilage of the user UFUNCTION(BlueprintCallable, meta=(BlueprintInternalUseOnly = "true", WorldContext="WorldContextObject"), Category = "Online|AdvancedIdentity") static UGetUserPrivilegeCallbackProxy* GetUserPrivilege(UObject* WorldContextObject, const EBPUserPrivileges & PrivilegeToCheck, const FBPUniqueNetId & PlayerUniqueNetID); diff --git a/AdvancedSessions/Source/AdvancedSessions/Classes/LoginUserCallbackProxy.h b/AdvancedSessions/Source/AdvancedSessions/Classes/LoginUserCallbackProxy.h index 36ea654..f35161f 100644 --- a/AdvancedSessions/Source/AdvancedSessions/Classes/LoginUserCallbackProxy.h +++ b/AdvancedSessions/Source/AdvancedSessions/Classes/LoginUserCallbackProxy.h @@ -20,7 +20,7 @@ class ULoginUserCallbackProxy : public UOnlineBlueprintCallProxyBase UPROPERTY(BlueprintAssignable) FEmptyOnlineDelegate OnFailure; - // Logs out of the identity interface + // Logs into the identity interface UFUNCTION(BlueprintCallable, meta=(BlueprintInternalUseOnly = "true", WorldContext="WorldContextObject"), Category = "Online|AdvancedIdentity") static ULoginUserCallbackProxy* LoginUser(UObject* WorldContextObject, class APlayerController* PlayerController, FString UserID, FString UserToken); diff --git a/AdvancedSteamSessions/Source/AdvancedSteamSessions/Classes/AdvancedSteamFriendsLibrary.h b/AdvancedSteamSessions/Source/AdvancedSteamSessions/Classes/AdvancedSteamFriendsLibrary.h index a1a562e..8cb332e 100644 --- a/AdvancedSteamSessions/Source/AdvancedSteamSessions/Classes/AdvancedSteamFriendsLibrary.h +++ b/AdvancedSteamSessions/Source/AdvancedSteamSessions/Classes/AdvancedSteamFriendsLibrary.h @@ -88,6 +88,7 @@ public: UFUNCTION(BlueprintCallable, Category = "Online|AdvancedFriends|SteamAPI", meta = (ExpandEnumAsExecs = "Result")) static void GetSteamFriendGamePlayed(const FBPUniqueNetId UniqueNetId, EBlueprintResultSwitch &Result, FString & GameName, int32 & AppID); + // Get a full list of steam groups UFUNCTION(BlueprintCallable, Category = "Online|SteamAPI|SteamGroups") static void GetSteamGroups(TArray & SteamGroups); }; diff --git a/AdvancedSteamSessions/Source/AdvancedSteamSessions/Classes/SteamRequestGroupOfficersCallbackProxy.h b/AdvancedSteamSessions/Source/AdvancedSteamSessions/Classes/SteamRequestGroupOfficersCallbackProxy.h index 6e5e769..eae4029 100644 --- a/AdvancedSteamSessions/Source/AdvancedSteamSessions/Classes/SteamRequestGroupOfficersCallbackProxy.h +++ b/AdvancedSteamSessions/Source/AdvancedSteamSessions/Classes/SteamRequestGroupOfficersCallbackProxy.h @@ -75,7 +75,7 @@ class USteamRequestGroupOfficersCallbackProxy : public UOnlineBlueprintCallProxy UPROPERTY(BlueprintAssignable) FBlueprintGroupOfficerDetailsDelegate OnFailure; - // Retruns a list of steam group officers + // Returns a list of steam group officers UFUNCTION(BlueprintCallable, meta=(BlueprintInternalUseOnly = "true", WorldContext="WorldContextObject"), Category = "Online|SteamAPI|SteamGroups") static USteamRequestGroupOfficersCallbackProxy* GetSteamGroupOfficerList(UObject* WorldContextObject, FBPUniqueNetId GroupUniqueNetID);