Video Tutorials
Interface
Essentials
Advanced
Полезные советы
UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Lighting
Landscape Tool
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Программирование
Fundamentals
Setting Up Development Environment
Usage Examples
UnigineScript
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine Tools
GUI
Double Precision Coordinates
API
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
IG Plugin
CIGIConnector Plugin
Rendering-Related Classes
Работа с контентом
Content Optimization
Materials
Art Samples
Tutorials

Unigine::Plugins::SteamLeaderboard Class

Header: #include <plugins/UnigineSteam.h>

SteamLeaderboard Class

Members


int getID ( ) #

Returns the leaderboard ID.

Return value

Leaderboard ID.

const char * getName ( ) #

Returns the leaderboard name.

Return value

Leaderboard name.

bool isFound ( ) #

Returns the value stating if the leaderboard was found.

Return value

true if the leaderboard is found, otherwise false.

bool find ( ) #

Returns the value stating if the leaderboard was created.

Return value

true if a leaderboard is created, otherwise false.

bool findOrCreate ( SteamLeaderboardInterface::SORT_METHOD sort_method, SteamLeaderboardInterface::DISPLAY_TYPE display_type ) #

Checks if a leaderboard is created, it will create it if it's not yet created.

Arguments

  • SteamLeaderboardInterface::SORT_METHOD sort_method - The sort order of the new leaderboard if it's created.
  • SteamLeaderboardInterface::DISPLAY_TYPE display_type - The display type (used by the Steam Community web site) of the new leaderboard if it's created.

Return value

true if a leaderboard is created, otherwise false.

bool uploadScore ( int score, bool forced = false ) #

Uploads the user score to the current leaderboard.

Arguments

  • int score - The value to store in the current leaderboard.
  • bool forced - If set to true, the leaderboard will always replace score with specified; if set to false, the leaderboard will keep user's best score.

Return value

true if , otherwise false.

bool downloadScores ( SteamLeaderboardInterface::DATA_REQUEST request, int num_before, int num_after ) #

Downloads a set of entries from the current leaderboard.

Arguments

  • SteamLeaderboardInterface::DATA_REQUEST request - Type of requested data, one of the DATA_REQUEST values.
  • int num_before - Number of entries before the current user.
  • int num_after - Number of entries after the current user.

Return value

false if a leaderboard has not been selected yet, otherwise true.

bool isUploading ( ) #

Checks the leaderboard uploading status.

Return value

true if the leaderboard is uploading, otherwise false.

bool isDownloading ( ) #

Checks the leaderboard downloading status.

Return value

true if the leaderboard is downloading, otherwise false.

bool isLastUploadFailed ( ) #

Return value

true if , otherwise false.

bool isLastDownloadFailed ( ) #

Return value

SteamLeaderboardInterface::DATA_REQUEST getLastDataRequest ( ) #

Return value

int getEntryCount ( ) #

Return value

SteamLeaderboardInterface::SORT_METHOD getSortMethod ( ) #

Returns the order for the leaderboard sorting.

Return value

Order for the leaderboard sorting, one of the values.

SteamLeaderboardInterface::DISPLAY_TYPE getDisplayType ( ) #

Returns the type of data to be displayed with the leaderboard.

Return value

Type of data to be displayed with the leaderboard, one of the values.

int getNumEntries ( ) #

Returns the existing number of entries.

Return value

Number of entries.

unsigned long long getEntryUserID ( int num ) #

Arguments

  • int num -

Return value

int getEntryRank ( int num ) #

Arguments

  • int num -

Return value

int getEntryScore ( int num ) #

Arguments

  • int num -

Return value

Last update: 06.08.2020