UnityEngine.GameCenterModule.xml 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480
  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 accociated 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 accociated 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="?:UnityEngine.SocialPlatforms.IAchievement">
  85. <summary>
  86. <para>Information for a user's achievement.</para>
  87. </summary>
  88. </member>
  89. <member name="P:UnityEngine.SocialPlatforms.IAchievement.completed">
  90. <summary>
  91. <para>Set to true when percentCompleted is 100.0.</para>
  92. </summary>
  93. </member>
  94. <member name="P:UnityEngine.SocialPlatforms.IAchievement.hidden">
  95. <summary>
  96. <para>This achievement is currently hidden from the user.</para>
  97. </summary>
  98. </member>
  99. <member name="P:UnityEngine.SocialPlatforms.IAchievement.id">
  100. <summary>
  101. <para>The unique identifier of this achievement.</para>
  102. </summary>
  103. </member>
  104. <member name="P:UnityEngine.SocialPlatforms.IAchievement.lastReportedDate">
  105. <summary>
  106. <para>Set by server when percentCompleted is updated.</para>
  107. </summary>
  108. </member>
  109. <member name="P:UnityEngine.SocialPlatforms.IAchievement.percentCompleted">
  110. <summary>
  111. <para>Progress for this achievement.</para>
  112. </summary>
  113. </member>
  114. <member name="M:UnityEngine.SocialPlatforms.IAchievement.ReportProgress(System.Action`1&lt;System.Boolean&gt;)">
  115. <summary>
  116. <para>Send notification about progress on this achievement.</para>
  117. </summary>
  118. <param name="callback"></param>
  119. </member>
  120. <member name="?:UnityEngine.SocialPlatforms.IAchievementDescription">
  121. <summary>
  122. <para>Static data describing an achievement.</para>
  123. </summary>
  124. </member>
  125. <member name="P:UnityEngine.SocialPlatforms.IAchievementDescription.achievedDescription">
  126. <summary>
  127. <para>Description when the achivement is completed.</para>
  128. </summary>
  129. </member>
  130. <member name="P:UnityEngine.SocialPlatforms.IAchievementDescription.hidden">
  131. <summary>
  132. <para>Hidden achievement are not shown in the list until the percentCompleted has been touched (even if it's 0.0).</para>
  133. </summary>
  134. </member>
  135. <member name="P:UnityEngine.SocialPlatforms.IAchievementDescription.id">
  136. <summary>
  137. <para>Unique identifier for this achievement description.</para>
  138. </summary>
  139. </member>
  140. <member name="P:UnityEngine.SocialPlatforms.IAchievementDescription.image">
  141. <summary>
  142. <para>Image representation of the achievement.</para>
  143. </summary>
  144. </member>
  145. <member name="P:UnityEngine.SocialPlatforms.IAchievementDescription.points">
  146. <summary>
  147. <para>Point value of this achievement.</para>
  148. </summary>
  149. </member>
  150. <member name="P:UnityEngine.SocialPlatforms.IAchievementDescription.title">
  151. <summary>
  152. <para>Human readable title.</para>
  153. </summary>
  154. </member>
  155. <member name="P:UnityEngine.SocialPlatforms.IAchievementDescription.unachievedDescription">
  156. <summary>
  157. <para>Description when the achivement has not been completed.</para>
  158. </summary>
  159. </member>
  160. <member name="?:UnityEngine.SocialPlatforms.ILeaderboard">
  161. <summary>
  162. <para>The leaderboard contains the scores of all players for a particular game.</para>
  163. </summary>
  164. </member>
  165. <member name="P:UnityEngine.SocialPlatforms.ILeaderboard.id">
  166. <summary>
  167. <para>Unique identifier for this leaderboard.</para>
  168. </summary>
  169. </member>
  170. <member name="P:UnityEngine.SocialPlatforms.ILeaderboard.loading">
  171. <summary>
  172. <para>The leaderboad is in the process of loading scores.</para>
  173. </summary>
  174. </member>
  175. <member name="P:UnityEngine.SocialPlatforms.ILeaderboard.localUserScore">
  176. <summary>
  177. <para>The leaderboard score of the logged in user.</para>
  178. </summary>
  179. </member>
  180. <member name="P:UnityEngine.SocialPlatforms.ILeaderboard.maxRange">
  181. <summary>
  182. <para>The total amount of scores the leaderboard contains.</para>
  183. </summary>
  184. </member>
  185. <member name="P:UnityEngine.SocialPlatforms.ILeaderboard.range">
  186. <summary>
  187. <para>The rank range this leaderboard returns.</para>
  188. </summary>
  189. </member>
  190. <member name="P:UnityEngine.SocialPlatforms.ILeaderboard.scores">
  191. <summary>
  192. <para>The leaderboard scores returned by a query.</para>
  193. </summary>
  194. </member>
  195. <member name="P:UnityEngine.SocialPlatforms.ILeaderboard.timeScope">
  196. <summary>
  197. <para>The time period/scope searched by this leaderboard.</para>
  198. </summary>
  199. </member>
  200. <member name="P:UnityEngine.SocialPlatforms.ILeaderboard.title">
  201. <summary>
  202. <para>The human readable title of this leaderboard.</para>
  203. </summary>
  204. </member>
  205. <member name="P:UnityEngine.SocialPlatforms.ILeaderboard.userScope">
  206. <summary>
  207. <para>The users scope searched by this leaderboard.</para>
  208. </summary>
  209. </member>
  210. <member name="M:UnityEngine.SocialPlatforms.ILeaderboard.LoadScores(System.Action`1&lt;System.Boolean&gt;)">
  211. <summary>
  212. <para>Load scores according to the filters set on this leaderboard.</para>
  213. </summary>
  214. <param name="callback"></param>
  215. </member>
  216. <member name="M:UnityEngine.SocialPlatforms.ILeaderboard.SetUserFilter(System.String[])">
  217. <summary>
  218. <para>Only search for these user IDs.</para>
  219. </summary>
  220. <param name="userIDs">List of user ids.</param>
  221. </member>
  222. <member name="?:UnityEngine.SocialPlatforms.ILocalUser">
  223. <summary>
  224. <para>Represents the local or currently logged in user.</para>
  225. </summary>
  226. </member>
  227. <member name="P:UnityEngine.SocialPlatforms.ILocalUser.authenticated">
  228. <summary>
  229. <para>Checks if the current user has been authenticated.</para>
  230. </summary>
  231. </member>
  232. <member name="P:UnityEngine.SocialPlatforms.ILocalUser.friends">
  233. <summary>
  234. <para>The users friends list.</para>
  235. </summary>
  236. </member>
  237. <member name="P:UnityEngine.SocialPlatforms.ILocalUser.underage">
  238. <summary>
  239. <para>Is the user underage?</para>
  240. </summary>
  241. </member>
  242. <member name="M:UnityEngine.SocialPlatforms.ILocalUser.Authenticate(System.Action`1&lt;System.Boolean&gt;)">
  243. <summary>
  244. <para>Authenticate the local user to the current active Social API implementation and fetch his profile data.</para>
  245. </summary>
  246. <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>
  247. </member>
  248. <member name="M:UnityEngine.SocialPlatforms.ILocalUser.Authenticate(System.Action`2&lt;System.Boolean,System.String&gt;)">
  249. <summary>
  250. <para>Authenticate the local user to the current active Social API implementation and fetch his profile data.</para>
  251. </summary>
  252. <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>
  253. </member>
  254. <member name="M:UnityEngine.SocialPlatforms.ILocalUser.LoadFriends(System.Action`1&lt;System.Boolean&gt;)">
  255. <summary>
  256. <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>
  257. </summary>
  258. <param name="callback"></param>
  259. </member>
  260. <member name="?:UnityEngine.SocialPlatforms.IScore">
  261. <summary>
  262. <para>A game score.</para>
  263. </summary>
  264. </member>
  265. <member name="P:UnityEngine.SocialPlatforms.IScore.date">
  266. <summary>
  267. <para>The date the score was achieved.</para>
  268. </summary>
  269. </member>
  270. <member name="P:UnityEngine.SocialPlatforms.IScore.formattedValue">
  271. <summary>
  272. <para>The correctly formatted value of the score, like X points or X kills.</para>
  273. </summary>
  274. </member>
  275. <member name="P:UnityEngine.SocialPlatforms.IScore.leaderboardID">
  276. <summary>
  277. <para>The ID of the leaderboard this score belongs to.</para>
  278. </summary>
  279. </member>
  280. <member name="P:UnityEngine.SocialPlatforms.IScore.rank">
  281. <summary>
  282. <para>The rank or position of the score in the leaderboard. </para>
  283. </summary>
  284. </member>
  285. <member name="P:UnityEngine.SocialPlatforms.IScore.userID">
  286. <summary>
  287. <para>The user who owns this score.</para>
  288. </summary>
  289. </member>
  290. <member name="P:UnityEngine.SocialPlatforms.IScore.value">
  291. <summary>
  292. <para>The score value achieved.</para>
  293. </summary>
  294. </member>
  295. <member name="M:UnityEngine.SocialPlatforms.IScore.ReportScore(System.Action`1&lt;System.Boolean&gt;)">
  296. <summary>
  297. <para>Report this score instance.</para>
  298. </summary>
  299. <param name="callback"></param>
  300. </member>
  301. <member name="?:UnityEngine.SocialPlatforms.ISocialPlatform">
  302. <summary>
  303. <para>The generic Social API interface which implementations must inherit.</para>
  304. </summary>
  305. </member>
  306. <member name="P:UnityEngine.SocialPlatforms.ISocialPlatform.localUser">
  307. <summary>
  308. <para>See Social.localUser.</para>
  309. </summary>
  310. </member>
  311. <member name="M:UnityEngine.SocialPlatforms.ISocialPlatform.CreateAchievement">
  312. <summary>
  313. <para>See Social.CreateAchievement..</para>
  314. </summary>
  315. </member>
  316. <member name="M:UnityEngine.SocialPlatforms.ISocialPlatform.CreateLeaderboard">
  317. <summary>
  318. <para>See Social.CreateLeaderboard.</para>
  319. </summary>
  320. </member>
  321. <member name="M:UnityEngine.SocialPlatforms.ISocialPlatform.LoadAchievementDescriptions(System.Action`1&lt;UnityEngine.SocialPlatforms.IAchievementDescription[]&gt;)">
  322. <summary>
  323. <para>See Social.LoadAchievementDescriptions.</para>
  324. </summary>
  325. <param name="callback"></param>
  326. </member>
  327. <member name="M:UnityEngine.SocialPlatforms.ISocialPlatform.LoadAchievements(System.Action`1&lt;UnityEngine.SocialPlatforms.IAchievement[]&gt;)">
  328. <summary>
  329. <para>See Social.LoadAchievements.</para>
  330. </summary>
  331. <param name="callback"></param>
  332. </member>
  333. <member name="M:UnityEngine.SocialPlatforms.ISocialPlatform.LoadScores(System.String,System.Action`1&lt;UnityEngine.SocialPlatforms.IScore[]&gt;)">
  334. <summary>
  335. <para>See Social.LoadScores.</para>
  336. </summary>
  337. <param name="leaderboardID"></param>
  338. <param name="callback"></param>
  339. <param name="board"></param>
  340. </member>
  341. <member name="M:UnityEngine.SocialPlatforms.ISocialPlatform.LoadScores(UnityEngine.SocialPlatforms.ILeaderboard,System.Action`1&lt;System.Boolean&gt;)">
  342. <summary>
  343. <para>See Social.LoadScores.</para>
  344. </summary>
  345. <param name="leaderboardID"></param>
  346. <param name="callback"></param>
  347. <param name="board"></param>
  348. </member>
  349. <member name="M:UnityEngine.SocialPlatforms.ISocialPlatform.LoadUsers(System.String[],System.Action`1&lt;UnityEngine.SocialPlatforms.IUserProfile[]&gt;)">
  350. <summary>
  351. <para>See Social.LoadUsers.</para>
  352. </summary>
  353. <param name="userIDs"></param>
  354. <param name="callback"></param>
  355. </member>
  356. <member name="M:UnityEngine.SocialPlatforms.ISocialPlatform.ReportProgress(System.String,System.Double,System.Action`1&lt;System.Boolean&gt;)">
  357. <summary>
  358. <para>See Social.ReportProgress.</para>
  359. </summary>
  360. <param name="achievementID"></param>
  361. <param name="progress"></param>
  362. <param name="callback"></param>
  363. </member>
  364. <member name="M:UnityEngine.SocialPlatforms.ISocialPlatform.ReportScore(System.Int64,System.String,System.Action`1&lt;System.Boolean&gt;)">
  365. <summary>
  366. <para>See Social.ReportScore.</para>
  367. </summary>
  368. <param name="score"></param>
  369. <param name="board"></param>
  370. <param name="callback"></param>
  371. </member>
  372. <member name="M:UnityEngine.SocialPlatforms.ISocialPlatform.ShowAchievementsUI">
  373. <summary>
  374. <para>See Social.ShowAchievementsUI.</para>
  375. </summary>
  376. </member>
  377. <member name="M:UnityEngine.SocialPlatforms.ISocialPlatform.ShowLeaderboardUI">
  378. <summary>
  379. <para>See Social.ShowLeaderboardUI.</para>
  380. </summary>
  381. </member>
  382. <member name="?:UnityEngine.SocialPlatforms.IUserProfile">
  383. <summary>
  384. <para>Represents generic user instances, like friends of the local user.</para>
  385. </summary>
  386. </member>
  387. <member name="P:UnityEngine.SocialPlatforms.IUserProfile.id">
  388. <summary>
  389. <para>This users unique identifier.</para>
  390. </summary>
  391. </member>
  392. <member name="P:UnityEngine.SocialPlatforms.IUserProfile.image">
  393. <summary>
  394. <para>Avatar image of the user.</para>
  395. </summary>
  396. </member>
  397. <member name="P:UnityEngine.SocialPlatforms.IUserProfile.isFriend">
  398. <summary>
  399. <para>Is this user a friend of the current logged in user?</para>
  400. </summary>
  401. </member>
  402. <member name="P:UnityEngine.SocialPlatforms.IUserProfile.state">
  403. <summary>
  404. <para>Presence state of the user.</para>
  405. </summary>
  406. </member>
  407. <member name="P:UnityEngine.SocialPlatforms.IUserProfile.userName">
  408. <summary>
  409. <para>This user's username or alias.</para>
  410. </summary>
  411. </member>
  412. <member name="T:UnityEngine.SocialPlatforms.Range">
  413. <summary>
  414. <para>The score range a leaderboard query should include.</para>
  415. </summary>
  416. </member>
  417. <member name="F:UnityEngine.SocialPlatforms.Range.count">
  418. <summary>
  419. <para>The total amount of scores retreived.</para>
  420. </summary>
  421. </member>
  422. <member name="F:UnityEngine.SocialPlatforms.Range.from">
  423. <summary>
  424. <para>The rank of the first score which is returned.</para>
  425. </summary>
  426. </member>
  427. <member name="M:UnityEngine.SocialPlatforms.Range.#ctor(System.Int32,System.Int32)">
  428. <summary>
  429. <para>Constructor for a score range, the range starts from a specific value and contains a maxium score count.</para>
  430. </summary>
  431. <param name="fromValue">The minimum allowed value.</param>
  432. <param name="valueCount">The number of possible values.</param>
  433. </member>
  434. <member name="T:UnityEngine.SocialPlatforms.TimeScope">
  435. <summary>
  436. <para>The scope of time searched through when querying the leaderboard.</para>
  437. </summary>
  438. </member>
  439. <member name="T:UnityEngine.SocialPlatforms.UserScope">
  440. <summary>
  441. <para>The scope of the users searched through when querying the leaderboard.</para>
  442. </summary>
  443. </member>
  444. <member name="T:UnityEngine.SocialPlatforms.UserState">
  445. <summary>
  446. <para>User presence state.</para>
  447. </summary>
  448. </member>
  449. <member name="F:UnityEngine.SocialPlatforms.UserState.Offline">
  450. <summary>
  451. <para>The user is offline.</para>
  452. </summary>
  453. </member>
  454. <member name="F:UnityEngine.SocialPlatforms.UserState.Online">
  455. <summary>
  456. <para>The user is online.</para>
  457. </summary>
  458. </member>
  459. <member name="F:UnityEngine.SocialPlatforms.UserState.OnlineAndAway">
  460. <summary>
  461. <para>The user is online but away from their computer.</para>
  462. </summary>
  463. </member>
  464. <member name="F:UnityEngine.SocialPlatforms.UserState.OnlineAndBusy">
  465. <summary>
  466. <para>The user is online but set their status to busy.</para>
  467. </summary>
  468. </member>
  469. <member name="F:UnityEngine.SocialPlatforms.UserState.Playing">
  470. <summary>
  471. <para>The user is playing a game.</para>
  472. </summary>
  473. </member>
  474. <member name="A:UnityEngine.GameCenterModule">
  475. <summary>
  476. <para>The GameCenter module provides APIs to use Apple's GameCenter service.</para>
  477. </summary>
  478. </member>
  479. </members>
  480. </doc>