Legacy Documentation: Version 5.1
LanguageEnglish
  • C#
  • JS

Script language

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

Social

class in 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

Switch to Manual

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: GameCenterPlatform.

Static Variables

ActiveThis is the currently active social platform.
localUserThe local user (potentially not logged in).

Static Functions

CreateAchievementCreate an IAchievement instance.
CreateLeaderboardCreate an ILeaderboard instance.
LoadAchievementDescriptionsLoads the achievement descriptions accociated with this application.
LoadAchievementsLoad the achievements the logged in user has already achieved or reported progress on.
LoadScoresLoad a default set of scores from the given leaderboard.
LoadUsersLoad the user profiles accociated with the given array of user IDs.
ReportProgressReports the progress of an achievement.
ReportScoreReport a score to a specific leaderboard.
ShowAchievementsUIShow a default/system view of the games achievements.
ShowLeaderboardUIShow a default/system view of the games leaderboards.