Newer
Older
fall / Build / fall_Data / Managed / UnityEngine.GameCenterModule.xml
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<doc>
  <members>
    <assembly>
      <name>UnityEngine.GameCenterModule</name>
    </assembly>
    <member name="T:UnityEngine.Social">
      <summary>
        <para>Generic access to the Social API.</para>
      </summary>
    </member>
    <member name="P:UnityEngine.Social.localUser">
      <summary>
        <para>The local user (potentially not logged in).</para>
      </summary>
    </member>
    <member name="P:UnityEngine.Social.Active">
      <summary>
        <para>This is the currently active social platform. </para>
      </summary>
    </member>
    <member name="M:UnityEngine.Social.CreateAchievement">
      <summary>
        <para>Create an IAchievement instance.</para>
      </summary>
    </member>
    <member name="M:UnityEngine.Social.CreateLeaderboard">
      <summary>
        <para>Create an ILeaderboard instance.</para>
      </summary>
    </member>
    <member name="M:UnityEngine.Social.LoadAchievementDescriptions(System.Action`1&lt;UnityEngine.SocialPlatforms.IAchievementDescription[]&gt;)">
      <summary>
        <para>Loads the achievement descriptions accociated with this application.</para>
      </summary>
      <param name="callback"></param>
    </member>
    <member name="M:UnityEngine.Social.LoadAchievements(System.Action`1&lt;UnityEngine.SocialPlatforms.IAchievement[]&gt;)">
      <summary>
        <para>Load the achievements the logged in user has already achieved or reported progress on.</para>
      </summary>
      <param name="callback"></param>
    </member>
    <member name="M:UnityEngine.Social.LoadScores(System.String,System.Action`1&lt;UnityEngine.SocialPlatforms.IScore[]&gt;)">
      <summary>
        <para>Load a default set of scores from the given leaderboard.</para>
      </summary>
      <param name="leaderboardID"></param>
      <param name="callback"></param>
    </member>
    <member name="M:UnityEngine.Social.LoadUsers(System.String[],System.Action`1&lt;UnityEngine.SocialPlatforms.IUserProfile[]&gt;)">
      <summary>
        <para>Load the user profiles accociated with the given array of user IDs.</para>
      </summary>
      <param name="userIDs"></param>
      <param name="callback"></param>
    </member>
    <member name="M:UnityEngine.Social.ReportProgress(System.String,System.Double,System.Action`1&lt;System.Boolean&gt;)">
      <summary>
        <para>Reports the progress of an achievement.</para>
      </summary>
      <param name="achievementID"></param>
      <param name="progress"></param>
      <param name="callback"></param>
    </member>
    <member name="M:UnityEngine.Social.ReportScore(System.Int64,System.String,System.Action`1&lt;System.Boolean&gt;)">
      <summary>
        <para>Report a score to a specific leaderboard.</para>
      </summary>
      <param name="score"></param>
      <param name="board"></param>
      <param name="callback"></param>
    </member>
    <member name="M:UnityEngine.Social.ShowAchievementsUI">
      <summary>
        <para>Show a default/system view of the games achievements.</para>
      </summary>
    </member>
    <member name="M:UnityEngine.Social.ShowLeaderboardUI">
      <summary>
        <para>Show a default/system view of the games leaderboards.</para>
      </summary>
    </member>
    <member name="?:UnityEngine.SocialPlatforms.IAchievement">
      <summary>
        <para>Information for a user's achievement.</para>
      </summary>
    </member>
    <member name="P:UnityEngine.SocialPlatforms.IAchievement.completed">
      <summary>
        <para>Set to true when percentCompleted is 100.0.</para>
      </summary>
    </member>
    <member name="P:UnityEngine.SocialPlatforms.IAchievement.hidden">
      <summary>
        <para>This achievement is currently hidden from the user.</para>
      </summary>
    </member>
    <member name="P:UnityEngine.SocialPlatforms.IAchievement.id">
      <summary>
        <para>The unique identifier of this achievement.</para>
      </summary>
    </member>
    <member name="P:UnityEngine.SocialPlatforms.IAchievement.lastReportedDate">
      <summary>
        <para>Set by server when percentCompleted is updated.</para>
      </summary>
    </member>
    <member name="P:UnityEngine.SocialPlatforms.IAchievement.percentCompleted">
      <summary>
        <para>Progress for this achievement.</para>
      </summary>
    </member>
    <member name="M:UnityEngine.SocialPlatforms.IAchievement.ReportProgress(System.Action`1&lt;System.Boolean&gt;)">
      <summary>
        <para>Send notification about progress on this achievement.</para>
      </summary>
      <param name="callback"></param>
    </member>
    <member name="?:UnityEngine.SocialPlatforms.IAchievementDescription">
      <summary>
        <para>Static data describing an achievement.</para>
      </summary>
    </member>
    <member name="P:UnityEngine.SocialPlatforms.IAchievementDescription.achievedDescription">
      <summary>
        <para>Description when the achivement is completed.</para>
      </summary>
    </member>
    <member name="P:UnityEngine.SocialPlatforms.IAchievementDescription.hidden">
      <summary>
        <para>Hidden achievement are not shown in the list until the percentCompleted has been touched (even if it's 0.0).</para>
      </summary>
    </member>
    <member name="P:UnityEngine.SocialPlatforms.IAchievementDescription.id">
      <summary>
        <para>Unique identifier for this achievement description.</para>
      </summary>
    </member>
    <member name="P:UnityEngine.SocialPlatforms.IAchievementDescription.image">
      <summary>
        <para>Image representation of the achievement.</para>
      </summary>
    </member>
    <member name="P:UnityEngine.SocialPlatforms.IAchievementDescription.points">
      <summary>
        <para>Point value of this achievement.</para>
      </summary>
    </member>
    <member name="P:UnityEngine.SocialPlatforms.IAchievementDescription.title">
      <summary>
        <para>Human readable title.</para>
      </summary>
    </member>
    <member name="P:UnityEngine.SocialPlatforms.IAchievementDescription.unachievedDescription">
      <summary>
        <para>Description when the achivement has not been completed.</para>
      </summary>
    </member>
    <member name="?:UnityEngine.SocialPlatforms.ILeaderboard">
      <summary>
        <para>The leaderboard contains the scores of all players for a particular game.</para>
      </summary>
    </member>
    <member name="P:UnityEngine.SocialPlatforms.ILeaderboard.id">
      <summary>
        <para>Unique identifier for this leaderboard.</para>
      </summary>
    </member>
    <member name="P:UnityEngine.SocialPlatforms.ILeaderboard.loading">
      <summary>
        <para>The leaderboad is in the process of loading scores.</para>
      </summary>
    </member>
    <member name="P:UnityEngine.SocialPlatforms.ILeaderboard.localUserScore">
      <summary>
        <para>The leaderboard score of the logged in user.</para>
      </summary>
    </member>
    <member name="P:UnityEngine.SocialPlatforms.ILeaderboard.maxRange">
      <summary>
        <para>The total amount of scores the leaderboard contains.</para>
      </summary>
    </member>
    <member name="P:UnityEngine.SocialPlatforms.ILeaderboard.range">
      <summary>
        <para>The rank range this leaderboard returns.</para>
      </summary>
    </member>
    <member name="P:UnityEngine.SocialPlatforms.ILeaderboard.scores">
      <summary>
        <para>The leaderboard scores returned by a query.</para>
      </summary>
    </member>
    <member name="P:UnityEngine.SocialPlatforms.ILeaderboard.timeScope">
      <summary>
        <para>The time period/scope searched by this leaderboard.</para>
      </summary>
    </member>
    <member name="P:UnityEngine.SocialPlatforms.ILeaderboard.title">
      <summary>
        <para>The human readable title of this leaderboard.</para>
      </summary>
    </member>
    <member name="P:UnityEngine.SocialPlatforms.ILeaderboard.userScope">
      <summary>
        <para>The users scope searched by this leaderboard.</para>
      </summary>
    </member>
    <member name="M:UnityEngine.SocialPlatforms.ILeaderboard.LoadScores(System.Action`1&lt;System.Boolean&gt;)">
      <summary>
        <para>Load scores according to the filters set on this leaderboard.</para>
      </summary>
      <param name="callback"></param>
    </member>
    <member name="M:UnityEngine.SocialPlatforms.ILeaderboard.SetUserFilter(System.String[])">
      <summary>
        <para>Only search for these user IDs.</para>
      </summary>
      <param name="userIDs">List of user ids.</param>
    </member>
    <member name="?:UnityEngine.SocialPlatforms.ILocalUser">
      <summary>
        <para>Represents the local or currently logged in user.</para>
      </summary>
    </member>
    <member name="P:UnityEngine.SocialPlatforms.ILocalUser.authenticated">
      <summary>
        <para>Checks if the current user has been authenticated.</para>
      </summary>
    </member>
    <member name="P:UnityEngine.SocialPlatforms.ILocalUser.friends">
      <summary>
        <para>The users friends list.</para>
      </summary>
    </member>
    <member name="P:UnityEngine.SocialPlatforms.ILocalUser.underage">
      <summary>
        <para>Is the user underage?</para>
      </summary>
    </member>
    <member name="M:UnityEngine.SocialPlatforms.ILocalUser.Authenticate(System.Action`1&lt;System.Boolean&gt;)">
      <summary>
        <para>Authenticate the local user to the current active Social API implementation and fetch his profile data.</para>
      </summary>
      <param name="callback">Callback that is called whenever the authentication operation is finished. The first parameter is a Boolean identifying whether the authentication operation was successful. The optional second argument contains a string identifying any errors (if available) if the operation was unsuccessful.</param>
    </member>
    <member name="M:UnityEngine.SocialPlatforms.ILocalUser.Authenticate(System.Action`2&lt;System.Boolean,System.String&gt;)">
      <summary>
        <para>Authenticate the local user to the current active Social API implementation and fetch his profile data.</para>
      </summary>
      <param name="callback">Callback that is called whenever the authentication operation is finished. The first parameter is a Boolean identifying whether the authentication operation was successful. The optional second argument contains a string identifying any errors (if available) if the operation was unsuccessful.</param>
    </member>
    <member name="M:UnityEngine.SocialPlatforms.ILocalUser.LoadFriends(System.Action`1&lt;System.Boolean&gt;)">
      <summary>
        <para>Fetches the friends list of the logged in user. The friends list on the ISocialPlatform.localUser|Social.localUser instance is populated if this call succeeds.</para>
      </summary>
      <param name="callback"></param>
    </member>
    <member name="?:UnityEngine.SocialPlatforms.IScore">
      <summary>
        <para>A game score.</para>
      </summary>
    </member>
    <member name="P:UnityEngine.SocialPlatforms.IScore.date">
      <summary>
        <para>The date the score was achieved.</para>
      </summary>
    </member>
    <member name="P:UnityEngine.SocialPlatforms.IScore.formattedValue">
      <summary>
        <para>The correctly formatted value of the score, like X points or X kills.</para>
      </summary>
    </member>
    <member name="P:UnityEngine.SocialPlatforms.IScore.leaderboardID">
      <summary>
        <para>The ID of the leaderboard this score belongs to.</para>
      </summary>
    </member>
    <member name="P:UnityEngine.SocialPlatforms.IScore.rank">
      <summary>
        <para>The rank or position of the score in the leaderboard. </para>
      </summary>
    </member>
    <member name="P:UnityEngine.SocialPlatforms.IScore.userID">
      <summary>
        <para>The user who owns this score.</para>
      </summary>
    </member>
    <member name="P:UnityEngine.SocialPlatforms.IScore.value">
      <summary>
        <para>The score value achieved.</para>
      </summary>
    </member>
    <member name="M:UnityEngine.SocialPlatforms.IScore.ReportScore(System.Action`1&lt;System.Boolean&gt;)">
      <summary>
        <para>Report this score instance.</para>
      </summary>
      <param name="callback"></param>
    </member>
    <member name="?:UnityEngine.SocialPlatforms.ISocialPlatform">
      <summary>
        <para>The generic Social API interface which implementations must inherit.</para>
      </summary>
    </member>
    <member name="P:UnityEngine.SocialPlatforms.ISocialPlatform.localUser">
      <summary>
        <para>See Social.localUser.</para>
      </summary>
    </member>
    <member name="M:UnityEngine.SocialPlatforms.ISocialPlatform.CreateAchievement">
      <summary>
        <para>See Social.CreateAchievement..</para>
      </summary>
    </member>
    <member name="M:UnityEngine.SocialPlatforms.ISocialPlatform.CreateLeaderboard">
      <summary>
        <para>See Social.CreateLeaderboard.</para>
      </summary>
    </member>
    <member name="M:UnityEngine.SocialPlatforms.ISocialPlatform.LoadAchievementDescriptions(System.Action`1&lt;UnityEngine.SocialPlatforms.IAchievementDescription[]&gt;)">
      <summary>
        <para>See Social.LoadAchievementDescriptions.</para>
      </summary>
      <param name="callback"></param>
    </member>
    <member name="M:UnityEngine.SocialPlatforms.ISocialPlatform.LoadAchievements(System.Action`1&lt;UnityEngine.SocialPlatforms.IAchievement[]&gt;)">
      <summary>
        <para>See Social.LoadAchievements.</para>
      </summary>
      <param name="callback"></param>
    </member>
    <member name="M:UnityEngine.SocialPlatforms.ISocialPlatform.LoadScores(System.String,System.Action`1&lt;UnityEngine.SocialPlatforms.IScore[]&gt;)">
      <summary>
        <para>See Social.LoadScores.</para>
      </summary>
      <param name="leaderboardID"></param>
      <param name="callback"></param>
      <param name="board"></param>
    </member>
    <member name="M:UnityEngine.SocialPlatforms.ISocialPlatform.LoadScores(UnityEngine.SocialPlatforms.ILeaderboard,System.Action`1&lt;System.Boolean&gt;)">
      <summary>
        <para>See Social.LoadScores.</para>
      </summary>
      <param name="leaderboardID"></param>
      <param name="callback"></param>
      <param name="board"></param>
    </member>
    <member name="M:UnityEngine.SocialPlatforms.ISocialPlatform.LoadUsers(System.String[],System.Action`1&lt;UnityEngine.SocialPlatforms.IUserProfile[]&gt;)">
      <summary>
        <para>See Social.LoadUsers.</para>
      </summary>
      <param name="userIDs"></param>
      <param name="callback"></param>
    </member>
    <member name="M:UnityEngine.SocialPlatforms.ISocialPlatform.ReportProgress(System.String,System.Double,System.Action`1&lt;System.Boolean&gt;)">
      <summary>
        <para>See Social.ReportProgress.</para>
      </summary>
      <param name="achievementID"></param>
      <param name="progress"></param>
      <param name="callback"></param>
    </member>
    <member name="M:UnityEngine.SocialPlatforms.ISocialPlatform.ReportScore(System.Int64,System.String,System.Action`1&lt;System.Boolean&gt;)">
      <summary>
        <para>See Social.ReportScore.</para>
      </summary>
      <param name="score"></param>
      <param name="board"></param>
      <param name="callback"></param>
    </member>
    <member name="M:UnityEngine.SocialPlatforms.ISocialPlatform.ShowAchievementsUI">
      <summary>
        <para>See Social.ShowAchievementsUI.</para>
      </summary>
    </member>
    <member name="M:UnityEngine.SocialPlatforms.ISocialPlatform.ShowLeaderboardUI">
      <summary>
        <para>See Social.ShowLeaderboardUI.</para>
      </summary>
    </member>
    <member name="?:UnityEngine.SocialPlatforms.IUserProfile">
      <summary>
        <para>Represents generic user instances, like friends of the local user.</para>
      </summary>
    </member>
    <member name="P:UnityEngine.SocialPlatforms.IUserProfile.id">
      <summary>
        <para>This users unique identifier.</para>
      </summary>
    </member>
    <member name="P:UnityEngine.SocialPlatforms.IUserProfile.image">
      <summary>
        <para>Avatar image of the user.</para>
      </summary>
    </member>
    <member name="P:UnityEngine.SocialPlatforms.IUserProfile.isFriend">
      <summary>
        <para>Is this user a friend of the current logged in user?</para>
      </summary>
    </member>
    <member name="P:UnityEngine.SocialPlatforms.IUserProfile.state">
      <summary>
        <para>Presence state of the user.</para>
      </summary>
    </member>
    <member name="P:UnityEngine.SocialPlatforms.IUserProfile.userName">
      <summary>
        <para>This user's username or alias.</para>
      </summary>
    </member>
    <member name="T:UnityEngine.SocialPlatforms.Range">
      <summary>
        <para>The score range a leaderboard query should include.</para>
      </summary>
    </member>
    <member name="F:UnityEngine.SocialPlatforms.Range.count">
      <summary>
        <para>The total amount of scores retreived.</para>
      </summary>
    </member>
    <member name="F:UnityEngine.SocialPlatforms.Range.from">
      <summary>
        <para>The rank of the first score which is returned.</para>
      </summary>
    </member>
    <member name="M:UnityEngine.SocialPlatforms.Range.#ctor(System.Int32,System.Int32)">
      <summary>
        <para>Constructor for a score range, the range starts from a specific value and contains a maxium score count.</para>
      </summary>
      <param name="fromValue">The minimum allowed value.</param>
      <param name="valueCount">The number of possible values.</param>
    </member>
    <member name="T:UnityEngine.SocialPlatforms.TimeScope">
      <summary>
        <para>The scope of time searched through when querying the leaderboard.</para>
      </summary>
    </member>
    <member name="T:UnityEngine.SocialPlatforms.UserScope">
      <summary>
        <para>The scope of the users searched through when querying the leaderboard.</para>
      </summary>
    </member>
    <member name="T:UnityEngine.SocialPlatforms.UserState">
      <summary>
        <para>User presence state.</para>
      </summary>
    </member>
    <member name="F:UnityEngine.SocialPlatforms.UserState.Offline">
      <summary>
        <para>The user is offline.</para>
      </summary>
    </member>
    <member name="F:UnityEngine.SocialPlatforms.UserState.Online">
      <summary>
        <para>The user is online.</para>
      </summary>
    </member>
    <member name="F:UnityEngine.SocialPlatforms.UserState.OnlineAndAway">
      <summary>
        <para>The user is online but away from their computer.</para>
      </summary>
    </member>
    <member name="F:UnityEngine.SocialPlatforms.UserState.OnlineAndBusy">
      <summary>
        <para>The user is online but set their status to busy.</para>
      </summary>
    </member>
    <member name="F:UnityEngine.SocialPlatforms.UserState.Playing">
      <summary>
        <para>The user is playing a game.</para>
      </summary>
    </member>
  </members>
</doc>