UnityEngine.GameCenterModule.xml 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509
  1. <?xml version="1.0" encoding="utf-8" standalone="yes"?>
  2. <doc>
  3. <members>
  4. <assembly>
  5. <name>UnityEngine.GameCenterModule</name>
  6. </assembly>
  7. <member name="T:UnityEngine.Social">
  8. <summary>
  9. <para>Generic access to the Social API.</para>
  10. </summary>
  11. </member>
  12. <member name="P:UnityEngine.Social.localUser">
  13. <summary>
  14. <para>The local user (potentially not logged in).</para>
  15. </summary>
  16. </member>
  17. <member name="P:UnityEngine.Social.Active">
  18. <summary>
  19. <para>This is the currently active social platform. </para>
  20. </summary>
  21. </member>
  22. <member name="M:UnityEngine.Social.CreateAchievement">
  23. <summary>
  24. <para>Create an IAchievement instance.</para>
  25. </summary>
  26. </member>
  27. <member name="M:UnityEngine.Social.CreateLeaderboard">
  28. <summary>
  29. <para>Create an ILeaderboard instance.</para>
  30. </summary>
  31. </member>
  32. <member name="M:UnityEngine.Social.LoadAchievementDescriptions(System.Action`1&lt;UnityEngine.SocialPlatforms.IAchievementDescription[]&gt;)">
  33. <summary>
  34. <para>Loads the achievement descriptions associated with this application.</para>
  35. </summary>
  36. <param name="callback"></param>
  37. </member>
  38. <member name="M:UnityEngine.Social.LoadAchievements(System.Action`1&lt;UnityEngine.SocialPlatforms.IAchievement[]&gt;)">
  39. <summary>
  40. <para>Load the achievements the logged in user has already achieved or reported progress on.</para>
  41. </summary>
  42. <param name="callback"></param>
  43. </member>
  44. <member name="M:UnityEngine.Social.LoadScores(System.String,System.Action`1&lt;UnityEngine.SocialPlatforms.IScore[]&gt;)">
  45. <summary>
  46. <para>Load a default set of scores from the given leaderboard.</para>
  47. </summary>
  48. <param name="leaderboardID"></param>
  49. <param name="callback"></param>
  50. </member>
  51. <member name="M:UnityEngine.Social.LoadUsers(System.String[],System.Action`1&lt;UnityEngine.SocialPlatforms.IUserProfile[]&gt;)">
  52. <summary>
  53. <para>Load the user profiles associated with the given array of user IDs.</para>
  54. </summary>
  55. <param name="userIDs"></param>
  56. <param name="callback"></param>
  57. </member>
  58. <member name="M:UnityEngine.Social.ReportProgress(System.String,System.Double,System.Action`1&lt;System.Boolean&gt;)">
  59. <summary>
  60. <para>Reports the progress of an achievement.</para>
  61. </summary>
  62. <param name="achievementID"></param>
  63. <param name="progress"></param>
  64. <param name="callback"></param>
  65. </member>
  66. <member name="M:UnityEngine.Social.ReportScore(System.Int64,System.String,System.Action`1&lt;System.Boolean&gt;)">
  67. <summary>
  68. <para>Report a score to a specific leaderboard.</para>
  69. </summary>
  70. <param name="score"></param>
  71. <param name="board"></param>
  72. <param name="callback"></param>
  73. </member>
  74. <member name="M:UnityEngine.Social.ShowAchievementsUI">
  75. <summary>
  76. <para>Show a default/system view of the games achievements.</para>
  77. </summary>
  78. </member>
  79. <member name="M:UnityEngine.Social.ShowLeaderboardUI">
  80. <summary>
  81. <para>Show a default/system view of the games leaderboards.</para>
  82. </summary>
  83. </member>
  84. <member name="T:UnityEngine.SocialPlatforms.GameCenter.GameCenterPlatform">
  85. <summary>
  86. <para>iOS GameCenter implementation for network services.</para>
  87. </summary>
  88. </member>
  89. <member name="M:UnityEngine.SocialPlatforms.GameCenter.GameCenterPlatform.ResetAllAchievements(System.Action`1&lt;System.Boolean&gt;)">
  90. <summary>
  91. <para>Reset all the achievements for the local user.</para>
  92. </summary>
  93. <param name="callback"></param>
  94. </member>
  95. <member name="M:UnityEngine.SocialPlatforms.GameCenter.GameCenterPlatform.ShowDefaultAchievementCompletionBanner(System.Boolean)">
  96. <summary>
  97. <para>Show the default iOS banner when achievements are completed.</para>
  98. </summary>
  99. <param name="value"></param>
  100. </member>
  101. <member name="M:UnityEngine.SocialPlatforms.GameCenter.GameCenterPlatform.ShowLeaderboardUI(System.String,UnityEngine.SocialPlatforms.TimeScope)">
  102. <summary>
  103. <para>Show the leaderboard UI with a specific leaderboard shown initially with a specific time scope selected.</para>
  104. </summary>
  105. <param name="leaderboardID"></param>
  106. <param name="timeScope"></param>
  107. </member>
  108. <member name="?:UnityEngine.SocialPlatforms.IAchievement">
  109. <summary>
  110. <para>Information for a user's achievement.</para>
  111. </summary>
  112. </member>
  113. <member name="P:UnityEngine.SocialPlatforms.IAchievement.completed">
  114. <summary>
  115. <para>Set to true when percentCompleted is 100.0.</para>
  116. </summary>
  117. </member>
  118. <member name="P:UnityEngine.SocialPlatforms.IAchievement.hidden">
  119. <summary>
  120. <para>This achievement is currently hidden from the user.</para>
  121. </summary>
  122. </member>
  123. <member name="P:UnityEngine.SocialPlatforms.IAchievement.id">
  124. <summary>
  125. <para>The unique identifier of this achievement.</para>
  126. </summary>
  127. </member>
  128. <member name="P:UnityEngine.SocialPlatforms.IAchievement.lastReportedDate">
  129. <summary>
  130. <para>Set by server when percentCompleted is updated.</para>
  131. </summary>
  132. </member>
  133. <member name="P:UnityEngine.SocialPlatforms.IAchievement.percentCompleted">
  134. <summary>
  135. <para>Progress for this achievement.</para>
  136. </summary>
  137. </member>
  138. <member name="M:UnityEngine.SocialPlatforms.IAchievement.ReportProgress(System.Action`1&lt;System.Boolean&gt;)">
  139. <summary>
  140. <para>Send notification about progress on this achievement.</para>
  141. </summary>
  142. <param name="callback"></param>
  143. </member>
  144. <member name="?:UnityEngine.SocialPlatforms.IAchievementDescription">
  145. <summary>
  146. <para>Static data describing an achievement.</para>
  147. </summary>
  148. </member>
  149. <member name="P:UnityEngine.SocialPlatforms.IAchievementDescription.achievedDescription">
  150. <summary>
  151. <para>Description when the achivement is completed.</para>
  152. </summary>
  153. </member>
  154. <member name="P:UnityEngine.SocialPlatforms.IAchievementDescription.hidden">
  155. <summary>
  156. <para>Hidden achievement are not shown in the list until the percentCompleted has been touched (even if it's 0.0).</para>
  157. </summary>
  158. </member>
  159. <member name="P:UnityEngine.SocialPlatforms.IAchievementDescription.id">
  160. <summary>
  161. <para>Unique identifier for this achievement description.</para>
  162. </summary>
  163. </member>
  164. <member name="P:UnityEngine.SocialPlatforms.IAchievementDescription.image">
  165. <summary>
  166. <para>Image representation of the achievement.</para>
  167. </summary>
  168. </member>
  169. <member name="P:UnityEngine.SocialPlatforms.IAchievementDescription.points">
  170. <summary>
  171. <para>Point value of this achievement.</para>
  172. </summary>
  173. </member>
  174. <member name="P:UnityEngine.SocialPlatforms.IAchievementDescription.title">
  175. <summary>
  176. <para>Human readable title.</para>
  177. </summary>
  178. </member>
  179. <member name="P:UnityEngine.SocialPlatforms.IAchievementDescription.unachievedDescription">
  180. <summary>
  181. <para>Description when the achivement has not been completed.</para>
  182. </summary>
  183. </member>
  184. <member name="?:UnityEngine.SocialPlatforms.ILeaderboard">
  185. <summary>
  186. <para>The leaderboard contains the scores of all players for a particular game.</para>
  187. </summary>
  188. </member>
  189. <member name="P:UnityEngine.SocialPlatforms.ILeaderboard.id">
  190. <summary>
  191. <para>Unique identifier for this leaderboard.</para>
  192. </summary>
  193. </member>
  194. <member name="P:UnityEngine.SocialPlatforms.ILeaderboard.loading">
  195. <summary>
  196. <para>The leaderboad is in the process of loading scores.</para>
  197. </summary>
  198. </member>
  199. <member name="P:UnityEngine.SocialPlatforms.ILeaderboard.localUserScore">
  200. <summary>
  201. <para>The leaderboard score of the logged in user.</para>
  202. </summary>
  203. </member>
  204. <member name="P:UnityEngine.SocialPlatforms.ILeaderboard.maxRange">
  205. <summary>
  206. <para>The total amount of scores the leaderboard contains.</para>
  207. </summary>
  208. </member>
  209. <member name="P:UnityEngine.SocialPlatforms.ILeaderboard.range">
  210. <summary>
  211. <para>The rank range this leaderboard returns.</para>
  212. </summary>
  213. </member>
  214. <member name="P:UnityEngine.SocialPlatforms.ILeaderboard.scores">
  215. <summary>
  216. <para>The leaderboard scores returned by a query.</para>
  217. </summary>
  218. </member>
  219. <member name="P:UnityEngine.SocialPlatforms.ILeaderboard.timeScope">
  220. <summary>
  221. <para>The time period/scope searched by this leaderboard.</para>
  222. </summary>
  223. </member>
  224. <member name="P:UnityEngine.SocialPlatforms.ILeaderboard.title">
  225. <summary>
  226. <para>The human readable title of this leaderboard.</para>
  227. </summary>
  228. </member>
  229. <member name="P:UnityEngine.SocialPlatforms.ILeaderboard.userScope">
  230. <summary>
  231. <para>The users scope searched by this leaderboard.</para>
  232. </summary>
  233. </member>
  234. <member name="M:UnityEngine.SocialPlatforms.ILeaderboard.LoadScores(System.Action`1&lt;System.Boolean&gt;)">
  235. <summary>
  236. <para>Load scores according to the filters set on this leaderboard.</para>
  237. </summary>
  238. <param name="callback"></param>
  239. </member>
  240. <member name="M:UnityEngine.SocialPlatforms.ILeaderboard.SetUserFilter(System.String[])">
  241. <summary>
  242. <para>Only search for these user IDs.</para>
  243. </summary>
  244. <param name="userIDs">List of user ids.</param>
  245. </member>
  246. <member name="?:UnityEngine.SocialPlatforms.ILocalUser">
  247. <summary>
  248. <para>Represents the local or currently logged in user.</para>
  249. </summary>
  250. </member>
  251. <member name="P:UnityEngine.SocialPlatforms.ILocalUser.authenticated">
  252. <summary>
  253. <para>Checks if the current user has been authenticated.</para>
  254. </summary>
  255. </member>
  256. <member name="P:UnityEngine.SocialPlatforms.ILocalUser.friends">
  257. <summary>
  258. <para>The users friends list.</para>
  259. </summary>
  260. </member>
  261. <member name="P:UnityEngine.SocialPlatforms.ILocalUser.underage">
  262. <summary>
  263. <para>Is the user underage?</para>
  264. </summary>
  265. </member>
  266. <member name="M:UnityEngine.SocialPlatforms.ILocalUser.Authenticate(System.Action`1&lt;System.Boolean&gt;)">
  267. <summary>
  268. <para>Authenticate the local user to the current active Social API implementation and fetch his profile data.</para>
  269. </summary>
  270. <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>
  271. </member>
  272. <member name="M:UnityEngine.SocialPlatforms.ILocalUser.Authenticate(System.Action`2&lt;System.Boolean,System.String&gt;)">
  273. <summary>
  274. <para>Authenticate the local user to the current active Social API implementation and fetch his profile data.</para>
  275. </summary>
  276. <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>
  277. </member>
  278. <member name="M:UnityEngine.SocialPlatforms.ILocalUser.LoadFriends(System.Action`1&lt;System.Boolean&gt;)">
  279. <summary>
  280. <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>
  281. </summary>
  282. <param name="callback"></param>
  283. </member>
  284. <member name="P:UnityEngine.SocialPlatforms.Impl.UserProfile.legacyId">
  285. <summary>
  286. <para>Returns the ID provided in the Apple GameKit by GKPlayer.playerID (deprecated and marked obsolete in iOS 12.4).</para>
  287. </summary>
  288. </member>
  289. <member name="?:UnityEngine.SocialPlatforms.IScore">
  290. <summary>
  291. <para>A game score.</para>
  292. </summary>
  293. </member>
  294. <member name="P:UnityEngine.SocialPlatforms.IScore.date">
  295. <summary>
  296. <para>The date the score was achieved.</para>
  297. </summary>
  298. </member>
  299. <member name="P:UnityEngine.SocialPlatforms.IScore.formattedValue">
  300. <summary>
  301. <para>The correctly formatted value of the score, like X points or X kills.</para>
  302. </summary>
  303. </member>
  304. <member name="P:UnityEngine.SocialPlatforms.IScore.leaderboardID">
  305. <summary>
  306. <para>The ID of the leaderboard this score belongs to.</para>
  307. </summary>
  308. </member>
  309. <member name="P:UnityEngine.SocialPlatforms.IScore.rank">
  310. <summary>
  311. <para>The rank or position of the score in the leaderboard. </para>
  312. </summary>
  313. </member>
  314. <member name="P:UnityEngine.SocialPlatforms.IScore.userID">
  315. <summary>
  316. <para>The user who owns this score.</para>
  317. </summary>
  318. </member>
  319. <member name="P:UnityEngine.SocialPlatforms.IScore.value">
  320. <summary>
  321. <para>The score value achieved.</para>
  322. </summary>
  323. </member>
  324. <member name="M:UnityEngine.SocialPlatforms.IScore.ReportScore(System.Action`1&lt;System.Boolean&gt;)">
  325. <summary>
  326. <para>Report this score instance.</para>
  327. </summary>
  328. <param name="callback"></param>
  329. </member>
  330. <member name="?:UnityEngine.SocialPlatforms.ISocialPlatform">
  331. <summary>
  332. <para>The generic Social API interface which implementations must inherit.</para>
  333. </summary>
  334. </member>
  335. <member name="P:UnityEngine.SocialPlatforms.ISocialPlatform.localUser">
  336. <summary>
  337. <para>See Social.localUser.</para>
  338. </summary>
  339. </member>
  340. <member name="M:UnityEngine.SocialPlatforms.ISocialPlatform.CreateAchievement">
  341. <summary>
  342. <para>See Social.CreateAchievement..</para>
  343. </summary>
  344. </member>
  345. <member name="M:UnityEngine.SocialPlatforms.ISocialPlatform.CreateLeaderboard">
  346. <summary>
  347. <para>See Social.CreateLeaderboard.</para>
  348. </summary>
  349. </member>
  350. <member name="M:UnityEngine.SocialPlatforms.ISocialPlatform.LoadAchievementDescriptions(System.Action`1&lt;UnityEngine.SocialPlatforms.IAchievementDescription[]&gt;)">
  351. <summary>
  352. <para>See Social.LoadAchievementDescriptions.</para>
  353. </summary>
  354. <param name="callback"></param>
  355. </member>
  356. <member name="M:UnityEngine.SocialPlatforms.ISocialPlatform.LoadAchievements(System.Action`1&lt;UnityEngine.SocialPlatforms.IAchievement[]&gt;)">
  357. <summary>
  358. <para>See Social.LoadAchievements.</para>
  359. </summary>
  360. <param name="callback"></param>
  361. </member>
  362. <member name="M:UnityEngine.SocialPlatforms.ISocialPlatform.LoadScores(System.String,System.Action`1&lt;UnityEngine.SocialPlatforms.IScore[]&gt;)">
  363. <summary>
  364. <para>See Social.LoadScores.</para>
  365. </summary>
  366. <param name="leaderboardID"></param>
  367. <param name="callback"></param>
  368. <param name="board"></param>
  369. </member>
  370. <member name="M:UnityEngine.SocialPlatforms.ISocialPlatform.LoadScores(UnityEngine.SocialPlatforms.ILeaderboard,System.Action`1&lt;System.Boolean&gt;)">
  371. <summary>
  372. <para>See Social.LoadScores.</para>
  373. </summary>
  374. <param name="leaderboardID"></param>
  375. <param name="callback"></param>
  376. <param name="board"></param>
  377. </member>
  378. <member name="M:UnityEngine.SocialPlatforms.ISocialPlatform.LoadUsers(System.String[],System.Action`1&lt;UnityEngine.SocialPlatforms.IUserProfile[]&gt;)">
  379. <summary>
  380. <para>See Social.LoadUsers.</para>
  381. </summary>
  382. <param name="userIDs"></param>
  383. <param name="callback"></param>
  384. </member>
  385. <member name="M:UnityEngine.SocialPlatforms.ISocialPlatform.ReportProgress(System.String,System.Double,System.Action`1&lt;System.Boolean&gt;)">
  386. <summary>
  387. <para>See Social.ReportProgress.</para>
  388. </summary>
  389. <param name="achievementID"></param>
  390. <param name="progress"></param>
  391. <param name="callback"></param>
  392. </member>
  393. <member name="M:UnityEngine.SocialPlatforms.ISocialPlatform.ReportScore(System.Int64,System.String,System.Action`1&lt;System.Boolean&gt;)">
  394. <summary>
  395. <para>See Social.ReportScore.</para>
  396. </summary>
  397. <param name="score"></param>
  398. <param name="board"></param>
  399. <param name="callback"></param>
  400. </member>
  401. <member name="M:UnityEngine.SocialPlatforms.ISocialPlatform.ShowAchievementsUI">
  402. <summary>
  403. <para>See Social.ShowAchievementsUI.</para>
  404. </summary>
  405. </member>
  406. <member name="M:UnityEngine.SocialPlatforms.ISocialPlatform.ShowLeaderboardUI">
  407. <summary>
  408. <para>See Social.ShowLeaderboardUI.</para>
  409. </summary>
  410. </member>
  411. <member name="?:UnityEngine.SocialPlatforms.IUserProfile">
  412. <summary>
  413. <para>Represents generic user instances, like friends of the local user.</para>
  414. </summary>
  415. </member>
  416. <member name="P:UnityEngine.SocialPlatforms.IUserProfile.id">
  417. <summary>
  418. <para>This user's global unique identifier.</para>
  419. </summary>
  420. </member>
  421. <member name="P:UnityEngine.SocialPlatforms.IUserProfile.image">
  422. <summary>
  423. <para>Avatar image of the user.</para>
  424. </summary>
  425. </member>
  426. <member name="P:UnityEngine.SocialPlatforms.IUserProfile.isFriend">
  427. <summary>
  428. <para>Is this user a friend of the current logged in user?</para>
  429. </summary>
  430. </member>
  431. <member name="P:UnityEngine.SocialPlatforms.IUserProfile.state">
  432. <summary>
  433. <para>Presence state of the user.</para>
  434. </summary>
  435. </member>
  436. <member name="P:UnityEngine.SocialPlatforms.IUserProfile.userName">
  437. <summary>
  438. <para>This user's username or alias.</para>
  439. </summary>
  440. </member>
  441. <member name="T:UnityEngine.SocialPlatforms.Range">
  442. <summary>
  443. <para>The score range a leaderboard query should include.</para>
  444. </summary>
  445. </member>
  446. <member name="F:UnityEngine.SocialPlatforms.Range.count">
  447. <summary>
  448. <para>The total amount of scores retreived.</para>
  449. </summary>
  450. </member>
  451. <member name="F:UnityEngine.SocialPlatforms.Range.from">
  452. <summary>
  453. <para>The rank of the first score which is returned.</para>
  454. </summary>
  455. </member>
  456. <member name="M:UnityEngine.SocialPlatforms.Range.#ctor(System.Int32,System.Int32)">
  457. <summary>
  458. <para>Constructor for a score range, the range starts from a specific value and contains a maxium score count.</para>
  459. </summary>
  460. <param name="fromValue">The minimum allowed value.</param>
  461. <param name="valueCount">The number of possible values.</param>
  462. </member>
  463. <member name="T:UnityEngine.SocialPlatforms.TimeScope">
  464. <summary>
  465. <para>The scope of time searched through when querying the leaderboard.</para>
  466. </summary>
  467. </member>
  468. <member name="T:UnityEngine.SocialPlatforms.UserScope">
  469. <summary>
  470. <para>The scope of the users searched through when querying the leaderboard.</para>
  471. </summary>
  472. </member>
  473. <member name="T:UnityEngine.SocialPlatforms.UserState">
  474. <summary>
  475. <para>User presence state.</para>
  476. </summary>
  477. </member>
  478. <member name="F:UnityEngine.SocialPlatforms.UserState.Offline">
  479. <summary>
  480. <para>The user is offline.</para>
  481. </summary>
  482. </member>
  483. <member name="F:UnityEngine.SocialPlatforms.UserState.Online">
  484. <summary>
  485. <para>The user is online.</para>
  486. </summary>
  487. </member>
  488. <member name="F:UnityEngine.SocialPlatforms.UserState.OnlineAndAway">
  489. <summary>
  490. <para>The user is online but away from their computer.</para>
  491. </summary>
  492. </member>
  493. <member name="F:UnityEngine.SocialPlatforms.UserState.OnlineAndBusy">
  494. <summary>
  495. <para>The user is online but set their status to busy.</para>
  496. </summary>
  497. </member>
  498. <member name="F:UnityEngine.SocialPlatforms.UserState.Playing">
  499. <summary>
  500. <para>The user is playing a game.</para>
  501. </summary>
  502. </member>
  503. <member name="A:UnityEngine.GameCenterModule">
  504. <summary>
  505. <para>The GameCenter module provides APIs to use Apple's GameCenter service.</para>
  506. </summary>
  507. </member>
  508. </members>
  509. </doc>