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

Unigine::Plugins::Steam Class

Header: #include <plugins/UnigineSteam.h>

Steam Class

Members


int getAppID ( ) #

Returns Steam AppID.

Return value

Steam AppID.

bool isSubscribed ( ) #

Checks if the user is allowed to run the current app.

Return value

true if the user is allowed to run the current app; otherwise false.

bool isLowViolence ( ) #

Checks if the license owned by the user provides low violence depots.

Return value

true if the license owned by the user provides low violence depots; otherwise false.

bool isCybercafe ( ) #

Returns the value specifying if the current app is for Cyber Cafes.

Return value

true if the current app is for Cyber Cafes; otherwise false.

bool isVACBanned ( ) #

Checks if the user has a VAC ban on their account.

Return value

true if the user has a VAC ban on their account; otherwise, false.

const char * getCurrentGameLanguage ( ) #

Returns the current language that the user has set.

Return value

Language set by the user.

const char * getAvailableGameLanguages ( ) #

Returns a comma-separated list of languages.

Return value

Comma-separated list of languages.

const char * getUserDataFolder ( ) #

Returns the name of the user data folder.

Return value

Name of the user data folder.

void showOverlay ( const char * dialog ) #

Opens the Steam overlay to the specified dialog.

Arguments

  • const char * dialog - The dialog to open. Valid options are: "friends", "community", "players", "settings", "officialgamegroup", "stats", "achievements".

void showOverlayToWebPage ( const char * url ) #

Activates Steam Overlay web browser directly to the specified URL.

Arguments

  • const char * url - The webpage to open (a fully qualified address with the protocol is required).

void showOverlayToUser ( const char * dialog, unsigned long long steam_id ) #

Opens the Steam overlay to the specified dialog.

Arguments

  • const char * dialog - The dialog to open. Valid options are: "steamid", "chat", "jointrade", "stats", "achievements", "friendadd", "friendremove", "friendrequestaccept", "friendrequestignore".
  • unsigned long long steam_id - The Steam ID of the context to open this dialog to.

void showOverlayToStore ( int app_id, SteamInterface::OVERLAY_TO_STORE store_flag ) #

Activates the Steam Overlay to the Steam store page for the provided app.

Arguments

  • int app_id - The app ID to show the store page of.
  • SteamInterface::OVERLAY_TO_STORE store_flag - Flag to modify the behavior when the page opens, one of the OVERLAY_TO_STORE_* values.

void showOverlayInviteDialog ( unsigned long long steam_id_lobby ) #

Activates the Steam Overlay to open the invite dialog. Invitations sent from this dialog will be for the provided lobby.

Arguments

  • unsigned long long steam_id_lobby - The Steam ID of the lobby that selected users will be invited to.

void setOverlayNotificationPosition ( SteamInterface::OVERLAY_POSITION position ) #

Sets which corner the Steam overlay notification popup should display itself in.

Arguments

  • SteamInterface::OVERLAY_POSITION position - The overlay notification popup position, one of the OVERLAY_POSITION_* values.

bool isOverlayShown ( ) #

Checks if the Steam Overlay is running and the user can access it.

Return value

true if the overlay is running and the user can access it; otherwise false.

unsigned long long getMyUserID ( ) #

Gets the current user's ID.

Return value

The current user's ID.

const char * getMyName ( ) #

Gets the current user's persona (display) name. This is the same name that is displayed on the user's community profile page.

Return value

The current user's persona (display) name.

SteamInterface::PERSONA_STATE getMyState ( ) #

Returns the friend status of the current user.

Return value

The friend state of the current user, one of the PERSONA_STATE_* values.

const char * getUserName ( unsigned long long steam_id_friend ) #

Returns the specified user's persona (display) name.

Arguments

  • unsigned long long steam_id_friend - The Steam ID of the user.

Return value

The current users persona name in UTF-8 format. Guaranteed to not be NULL. Returns an empty string (""), or "[unknown]" if the Steam ID is invalid or not known to the caller.

int getNumFriends ( int friend_flags ) #

Returns the number of users the client knows about who meet a specified criteria (friends, blocked, users on the same server, etc.).

Arguments

  • int friend_flags - A combined union (binary "or") of one or more FRIEND_FLAG_* values.

Return value

The number of users that meet the specified criteria. Returns -1 if the current user is not logged on.

unsigned long long getFriendByIndex ( int ifriend, int ifriend_flags ) #

Arguments

  • int ifriend - An index between 0 and GetFriendCountFromSource.
  • int ifriend_flags - .

Return value

.

SteamInterface::FRIEND_RELATIONSHIP getUserRelationship ( unsigned long long steam_id_friend ) #

Returns a relationship to a specified user.

Arguments

  • unsigned long long steam_id_friend - The Steam ID of the other user.

Return value

Relationship to a specified user, one of the FRIEND_RELATIONSHIP_* values.

SteamInterface::PERSONA_STATE getUserPersonaState ( unsigned long long steam_id_friend ) #

Returns the status of the friend.

Arguments

  • unsigned long long steam_id_friend - Steam ID of the user.

Return value

Status of the friend, one of the PERSONA_STATE_* values.

Variable getUserAvatarSmall ( unsigned long long id ) #

Returns a handle to the small avatar for the specified user.

Arguments

  • unsigned long long id - Steam ID of the user.

Return value

A Steam handle to the small (32*32 px) image. Returns 0 if no avatar is set for the user.

Variable getUserAvatarMedium ( unsigned long long id ) #

Returns a handle to the medium avatar for the specified user.

Arguments

  • unsigned long long id - Steam ID of the user.

Return value

A Steam handle to the small (64x64 px) image. Returns 0 if no avatar is set for the user.

Variable getUserAvatarLarge ( unsigned long long id ) #

Returns a handle to the large avatar for the specified user.

Arguments

  • unsigned long long id - Steam ID of the user.

Return value

A Steam handle to the large (128*128 px) image. Returns 0 if no avatar is set for the user.

SteamLeaderboardInterface * createLeaderboard ( const char * name ) #

Returns the leaderboard interface.

Arguments

  • const char * name - Name of the leaderboard to be created.

Return value

Leaderboard interface.

SteamLeaderboardInterface * getLeaderboard ( int id ) #

Returns the leaderboard interface.

Arguments

  • int id - ID of the leaderboard to view.

Return value

Leaderboard interface.

void deleteLeaderboard ( SteamLeaderboardInterface * leaderboard ) #

Deletes the leaderboard.

Arguments

  • SteamLeaderboardInterface * leaderboard - Leaderboard interface.
Last update: 06.08.2020