Legacy Documentation: Version 4.6(go to latest)
Language: English
  • C#
  • JS
  • Boo

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Social

Namespace: UnityEngine

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

Generic access to the Social API.

Social.Active can be used to target a specific social platform implementation, but by default GameCenter is used on iOS. All other platforms default to the Local implementation which can be used for testing. See Social API Reference Manual for an overview.

The Social class should always be used as an entry point. It contains helper functions for accessing the current active implementation and always uses the interfaces of the other Social API classes. This way it is easier to use versions of the interfaces which have been extended beoynd the generic API by the implementation. There are varoius classes accociated with the Social API and all of these reside in the UnityEngine.SocialPlatforms namespace. You need to import/use this namespace in order to use these classes. See Also: SocialPlatforms.GameCenter.GameCenterPlatform.

Static Variables

Active This is the currently active social platform.
localUser The local user (potentially not logged in).

Static Functions

CreateAchievement Create an IAchievement instance.
CreateLeaderboard Create an ILeaderboard instance.
LoadAchievementDescriptions Loads the achievement descriptions accociated with this application.
LoadAchievements Load the achievements the logged in user has already achieved or reported progress on.
LoadScores Load a default set of scores from the given leaderboard.
LoadUsers Load the user profiles accociated with the given array of user IDs.
ReportProgress Reports the progress of an achievement.
ReportScore Report a score to a specific leaderboard.
ShowAchievementsUI Show a default/system view of the games achievements.
ShowLeaderboardUI Show a default/system view of the games leaderboards.