Learn how to Use Cloud Scripts
In this lesson on how to use PlayFab in Unity 3D, we will teach you more about Player Statistics. In our last video, we show you how to get and set player statistics from the client application but as I said in the last video, it can be a bad practice to send updates to the player statistics from the client-side. We will fix this by showing you how to send a request to run a server-side code hosted by PlayFab’s cloud scripts.
Documentation: https://api.playfab.com/docs/tutorials/landing-automation/writing-custom-cloud-script
SUBSCRIBE for regular Video Game making videos:
https://www.youtube.com/channel/UCyoayn_uVt2I55ZCUuBVRcQ?sub_confirmation=1
About Player Statistics
For getting started we want to go to our PlayFab dashboard. We will then want to click out our current project. We will then select Players and then we will select one of our player accounts. From here we need to click on statistics. In the statistics page, it is important to know that each statistic you add to a player account is then permanently associated with that player. The values of the stats can be changed by the key cannot. It is also important to know that you can add new stats just by typing in a new key in the statistics page and click Save Statistics.
Disabling Client POSTing
Now will go to the Setting – API Features and then we will uncheck the box we checked in the last lesson that says “Allow clients to post player statistics” and then we will click save.
Cloud Scripts – Server Code
Now we need to go to the Automation section which will take us to what is called Cloud Scripts. Cloud Scripts are server-side code written in JavaScript and hosted by PlayFab for free. In the default cloud script, you will see a function called MakeAPICall. This function currently will set one default statistic. We will customize this function so that it will receive value from our game and set the statistics we need for our game. Once you have this function created, you will then need to save and deploy this revision.
Client Request to Run Server Function
Now, it is time to go to our Unity project and open our PlayFabController script. Is side our script we need to create new functions that will request PlayFab to run our new Cloud Script function. There are some example functions written in the documentation I have to add up above. We will paste those functions into our code and then customize them so they will send the correct parameters to the correct JavaScript function.
Testing your Project
It is now time to test our project. We will save our script and go back to Unity. We then need to reassign the function that is paired to our Update Stats button. It should now be the new function we just created. We can then play our game. We then need to select our PlayFabController object and change the stats variables we have there. Then when we click the Update Stats button we should then be able to see the values of our player statistics change in our dashboard.
Unlock Code and Member Content
Cloud Script UpdatePlayerStats .js Function
handlers.UpdatePlayerStats = function (args, context) {
var request = {
PlayFabId: currentPlayerId, Statistics: [{
StatisticName: "PlayerLevel",
Value: args.Level
},
{
StatisticName: "PlayerHighScore",
Value: args.highScore
},
{
StatisticName: "apples",
Value: args.apples
}]
};
// The pre-defined "server" object has functions corresponding to each PlayFab server API
var playerStatResult = server.UpdatePlayerStatistics(request);
return{messageValue: "Updated Cloud Stats"}
};
PlayFabController.cs
using PlayFab;
using PlayFab.ClientModels;
using UnityEngine;
using PlayFab.DataModels;
using PlayFab.ProfilesModels;
using System.Collections.Generic;
using PlayFab.Json;
public class PlayFabController : MonoBehaviour
{
public static PlayFabController PFC;
private string userEmail;
private string userPassword;
private string username;
public GameObject loginPanel;
public GameObject addLoginPanel;
public GameObject recoverButton;
private void OnEnable()
{
if(PlayFabController.PFC == null)
{
PlayFabController.PFC = this;
}
else
{
if(PlayFabController.PFC != this)
{
Destroy(this.gameObject);
}
}
DontDestroyOnLoad(this.gameObject);
}
public void Start()
{
//Note: Setting title Id here can be skipped if you have set the value in Editor Extensions already.
if (string.IsNullOrEmpty(PlayFabSettings.TitleId))
{
PlayFabSettings.TitleId = "8741"; // Please change this value to your own titleId from PlayFab Game Manager
}
//PlayerPrefs.DeleteAll();
//var request = new LoginWithCustomIDRequest { CustomId = "GettingStartedGuide", CreateAccount = true };
//PlayFabClientAPI.LoginWithCustomID(request, OnLoginSuccess, OnLoginFailure);
if (PlayerPrefs.HasKey("EMAIL"))
{
userEmail = PlayerPrefs.GetString("EMAIL");
userPassword = PlayerPrefs.GetString("PASSWORD");
var request = new LoginWithEmailAddressRequest { Email = userEmail, Password = userPassword };
PlayFabClientAPI.LoginWithEmailAddress(request, OnLoginSuccess, OnLoginFailure);
}
else
{
#if UNITY_ANDROID
var requestAndroid = new LoginWithAndroidDeviceIDRequest { AndroidDeviceId = ReturnMobileID(), CreateAccount = true };
PlayFabClientAPI.LoginWithAndroidDeviceID(requestAndroid, OnLoginMobileSuccess, OnLoginMobileFailure);
#endif
#if UNITY_IOS
var requestIOS = new LoginWithIOSDeviceIDRequest { DeviceId = ReturnMobileID(), CreateAccount = true };
PlayFabClientAPI.LoginWithIOSDeviceID(requestIOS, OnLoginMobileSuccess, OnLoginMobileFailure);
#endif
}
}
#region Login
private void OnLoginSuccess(LoginResult result)
{
Debug.Log("Congratulations, you made your first successful API call!");
PlayerPrefs.SetString("EMAIL", userEmail);
PlayerPrefs.SetString("PASSWORD", userPassword);
loginPanel.SetActive(false);
recoverButton.SetActive(false);
GetStats();
//StartCloudHelloWorld();
}
private void OnLoginMobileSuccess(LoginResult result)
{
Debug.Log("Congratulations, you made your first successful API call!");
GetStats();
loginPanel.SetActive(false);
}
private void OnRegisterSuccess(RegisterPlayFabUserResult result)
{
Debug.Log("Congratulations, you made your first successful API call!");
PlayerPrefs.SetString("EMAIL", userEmail);
PlayerPrefs.SetString("PASSWORD", userPassword);
PlayFabClientAPI.UpdateUserTitleDisplayName(new UpdateUserTitleDisplayNameRequest { DisplayName = username }, OnDisplayName, OnLoginMobileFailure);
GetStats();
loginPanel.SetActive(false);
}
void OnDisplayName(UpdateUserTitleDisplayNameResult result)
{
Debug.Log(result.DisplayName + " is your new display name");
}
private void OnLoginFailure(PlayFabError error)
{
var registerRequest = new RegisterPlayFabUserRequest { Email = userEmail, Password = userPassword, Username = username };
PlayFabClientAPI.RegisterPlayFabUser(registerRequest, OnRegisterSuccess, OnRegisterFailure);
}
private void OnLoginMobileFailure(PlayFabError error)
{
Debug.Log(error.GenerateErrorReport());
}
private void OnRegisterFailure(PlayFabError error)
{
Debug.LogError(error.GenerateErrorReport());
}
public void GetUserEmail(string emailIn)
{
userEmail = emailIn;
}
public void GetUserPassword(string passwordIn)
{
userPassword = passwordIn;
}
public void GetUsername(string usernameIn)
{
username = usernameIn;
}
public void OnClickLogin()
{
var request = new LoginWithEmailAddressRequest { Email = userEmail, Password = userPassword };
PlayFabClientAPI.LoginWithEmailAddress(request, OnLoginSuccess, OnLoginFailure);
}
public static string ReturnMobileID()
{
string deviceID = SystemInfo.deviceUniqueIdentifier;
return deviceID;
}
public void OpenAddLogin()
{
addLoginPanel.SetActive(true);
}
public void OnClickAddLogin()
{
var addLoginRequest = new AddUsernamePasswordRequest { Email = userEmail, Password = userPassword, Username = username };
PlayFabClientAPI.AddUsernamePassword(addLoginRequest, OnAddLoginSuccess, OnRegisterFailure);
}
private void OnAddLoginSuccess(AddUsernamePasswordResult result)
{
Debug.Log("Congratulations, you made your first successful API call!");
GetStats();
PlayerPrefs.SetString("EMAIL", userEmail);
PlayerPrefs.SetString("PASSWORD", userPassword);
addLoginPanel.SetActive(false);
}
#endregion Login
public int playerLevel;
public int gameLevel;
public int playerHealth;
public int playerDamage;
public int playerHighScore;
#region PlayerStats
public void SetStats()
{
PlayFabClientAPI.UpdatePlayerStatistics(new UpdatePlayerStatisticsRequest
{
// request.Statistics is a list, so multiple StatisticUpdate objects can be defined if required.
Statistics = new List<StatisticUpdate> {
new StatisticUpdate { StatisticName = "PlayerLevel", Value = playerLevel },
new StatisticUpdate { StatisticName = "GameLevel", Value = gameLevel },
new StatisticUpdate { StatisticName = "PlayerHealth", Value = playerHealth },
new StatisticUpdate { StatisticName = "PlayerDamage", Value = playerDamage },
new StatisticUpdate { StatisticName = "PlayerHighScore", Value = playerHighScore },
}
},
result => { Debug.Log("User statistics updated"); },
error => { Debug.LogError(error.GenerateErrorReport()); });
}
void GetStats()
{
PlayFabClientAPI.GetPlayerStatistics(
new GetPlayerStatisticsRequest(),
OnGetStats,
error => Debug.LogError(error.GenerateErrorReport())
);
}
void OnGetStats(GetPlayerStatisticsResult result)
{
Debug.Log("Received the following Statistics:");
foreach (var eachStat in result.Statistics)
{
Debug.Log("Statistic (" + eachStat.StatisticName + "): " + eachStat.Value);
switch(eachStat.StatisticName)
{
case "PlayerLevel":
playerLevel = eachStat.Value;
break;
case "GameLevel":
gameLevel = eachStat.Value;
break;
case "PlayerHealth":
playerHealth = eachStat.Value;
break;
case "PlayerDamage":
playerDamage = eachStat.Value;
break;
case "PlayerHighScore":
playerHighScore = eachStat.Value;
break;
}
}
}
// Build the request object and access the API
public void StartCloudUpdatePlayerStats()
{
PlayFabClientAPI.ExecuteCloudScript(new ExecuteCloudScriptRequest()
{
FunctionName = "UpdatePlayerStats", // Arbitrary function name (must exist in your uploaded cloud.js file)
FunctionParameter = new { Level = playerLevel, highScore =playerHighScore, apple = 0 }, // The parameter provided to your function
GeneratePlayStreamEvent = true, // Optional - Shows this event in PlayStream
}, OnCloudUpdateStats, OnErrorShared);
}
// OnCloudHelloWorld defined in the next code block
private static void OnCloudUpdateStats(ExecuteCloudScriptResult result)
{
// Cloud Script returns arbitrary results, so you have to evaluate them one step and one parameter at a time
Debug.Log(JsonWrapper.SerializeObject(result.FunctionResult));
JsonObject jsonResult = (JsonObject)result.FunctionResult;
object messageValue;
jsonResult.TryGetValue("messageValue", out messageValue); // note how "messageValue" directly corresponds to the JSON values set in Cloud Script
Debug.Log((string)messageValue);
}
private static void OnErrorShared(PlayFabError error)
{
Debug.Log(error.GenerateErrorReport());
}
#endregion PlayerStats
}
using Photon.Chat;
using Photon.Pun;
using System.Collections;
using System.Collections.Generic;
using UnityEngine;
using UnityEngine.UI;
public class PhotonChatManager : MonoBehaviour, IChatClientListener
{
#region Setup
[SerializeField] GameObject joinChatButton;
ChatClient chatClient;
bool isConnected;
[SerializeField] string username;
public void UsernameOnValueChange(string valueIn)
{
username = valueIn;
}
public void ChatConnectOnClick()
{
isConnected = true;
chatClient = new ChatClient(this);
//chatClient.ChatRegion = "US";
chatClient.Connect(PhotonNetwork.PhotonServerSettings.AppSettings.AppIdChat, PhotonNetwork.AppVersion, new AuthenticationValues(username));
Debug.Log("Connenting");
}
#endregion Setup
#region General
[SerializeField] GameObject chatPanel;
string privateReceiver = "";
string currentChat;
[SerializeField] InputField chatField;
[SerializeField] Text chatDisplay;
// Start is called before the first frame update
void Start()
{
}
// Update is called once per frame
void Update()
{
if (isConnected)
{
chatClient.Service();
}
if (chatField.text != "" && Input.GetKey(KeyCode.Return))
{
SubmitPublicChatOnClick();
SubmitPrivateChatOnClick();
}
}
#endregion General
#region PublicChat
public void SubmitPublicChatOnClick()
{
if (privateReceiver == "")
{
chatClient.PublishMessage("RegionChannel", currentChat);
chatField.text = "";
currentChat = "";
}
}
public void TypeChatOnValueChange(string valueIn)
{
currentChat = valueIn;
}
#endregion PublicChat
#region PrivateChat
public void ReceiverOnValueChange(string valueIn)
{
privateReceiver = valueIn;
}
public void SubmitPrivateChatOnClick()
{
if (privateReceiver != "")
{
chatClient.SendPrivateMessage(privateReceiver, currentChat);
chatField.text = "";
currentChat = "";
}
}
#endregion PrivateChat
#region Callbacks
public void DebugReturn(DebugLevel level, string message)
{
//throw new System.NotImplementedException();
}
public void OnChatStateChange(ChatState state)
{
if(state == ChatState.Uninitialized)
{
isConnected = false;
joinChatButton.SetActive(true);
chatPanel.SetActive(false);
}
}
public void OnConnected()
{
Debug.Log("Connected");
joinChatButton.SetActive(false);
chatClient.Subscribe(new string[] { "RegionChannel" });
}
public void OnDisconnected()
{
isConnected = false;
joinChatButton.SetActive(true);
chatPanel.SetActive(false);
}
public void OnGetMessages(string channelName, string[] senders, object[] messages)
{
string msgs = "";
for (int i = 0; i < senders.Length; i++)
{
msgs = string.Format("{0}: {1}", senders[i], messages[i]);
chatDisplay.text += "\n" + msgs;
Debug.Log(msgs);
}
}
public void OnPrivateMessage(string sender, object message, string channelName)
{
string msgs = "";
msgs = string.Format("(Private) {0}: {1}", sender, message);
chatDisplay.text += "\n " + msgs;
Debug.Log(msgs);
}
public void OnStatusUpdate(string user, int status, bool gotMessage, object message)
{
throw new System.NotImplementedException();
}
public void OnSubscribed(string[] channels, bool[] results)
{
chatPanel.SetActive(true);
}
public void OnUnsubscribed(string[] channels)
{
throw new System.NotImplementedException();
}
public void OnUserSubscribed(string channel, string user)
{
throw new System.NotImplementedException();
}
public void OnUserUnsubscribed(string channel, string user)
{
throw new System.NotImplementedException();
}
#endregion Callbacks
}
