Steam
Classes | Public Member Functions | Properties | List of all members
LapinerTools.Steam.Data.LeaderboardsUploadedScoreEventArgs Class Reference

This event arguments are used for all score upload related events. More...

Inherits LapinerTools.Steam.Data.EventArgsBase.

Classes

class  SteamNativeData
 The LeaderboardsUploadedScoreEventArgs.SteamNativeData class contains Steam native data such as the SteamLeaderboard handle. You can use this data to make own calls to the Steamworks.NET API. More...
 

Public Member Functions

 LeaderboardsUploadedScoreEventArgs ()
 
 LeaderboardsUploadedScoreEventArgs (EventArgsBase p_errorEventArgs)
 
- Public Member Functions inherited from LapinerTools.Steam.Data.EventArgsBase
 EventArgsBase ()
 
 EventArgsBase (EventArgsBase p_copyFromArgs)
 

Properties

string LeaderboardName [get, set]
 The leaderboard name that was attempted to set. More...
 
int Score [get, set]
 The score that was attempted to set. More...
 
string ScoreString [get, set]
 Score formatted with SteamLeaderboardsMain.ScoreFormatNumeric or SteamLeaderboardsMain.ScoreFormatSeconds or SteamLeaderboardsMain.ScoreFormatMilliSeconds taking LeaderboardsUploadedScoreEventArgs.ScoreType into account. More...
 
ELeaderboardDisplayType ScoreType [get, set]
 The display type of the leaderboard, which was used to upload the score. More...
 
bool IsScoreChanged [get, set]
 True if the score in the leaderboard changed, false if the existing score was better. More...
 
int GlobalRankNew [get, set]
 The new global rank of the user in this leaderboard. More...
 
int GlobalRankPrevious [get, set]
 The previous global rank of the user in this leaderboard; 0 if the user had no existing entry in the leaderboard. More...
 
SteamNativeData SteamNative [get, set]
 Contains Steam native data such as the SteamLeaderboard handle. You can use this data to make own calls to the Steamworks.NET API. More...
 
- Properties inherited from LapinerTools.Steam.Data.EventArgsBase
bool IsError [get, set]
 true, if an error has occured, false otherwise. More...
 
string ErrorMessage [get, set]
 Contains the error message if the EventArgsBase.IsError property is true. More...
 

Detailed Description

This event arguments are used for all score upload related events.

Constructor & Destructor Documentation

◆ LeaderboardsUploadedScoreEventArgs() [1/2]

LapinerTools.Steam.Data.LeaderboardsUploadedScoreEventArgs.LeaderboardsUploadedScoreEventArgs ( )

◆ LeaderboardsUploadedScoreEventArgs() [2/2]

LapinerTools.Steam.Data.LeaderboardsUploadedScoreEventArgs.LeaderboardsUploadedScoreEventArgs ( EventArgsBase  p_errorEventArgs)

Property Documentation

◆ GlobalRankNew

int LapinerTools.Steam.Data.LeaderboardsUploadedScoreEventArgs.GlobalRankNew
getset

The new global rank of the user in this leaderboard.

◆ GlobalRankPrevious

int LapinerTools.Steam.Data.LeaderboardsUploadedScoreEventArgs.GlobalRankPrevious
getset

The previous global rank of the user in this leaderboard; 0 if the user had no existing entry in the leaderboard.

◆ IsScoreChanged

bool LapinerTools.Steam.Data.LeaderboardsUploadedScoreEventArgs.IsScoreChanged
getset

True if the score in the leaderboard changed, false if the existing score was better.

◆ LeaderboardName

string LapinerTools.Steam.Data.LeaderboardsUploadedScoreEventArgs.LeaderboardName
getset

The leaderboard name that was attempted to set.

◆ Score

int LapinerTools.Steam.Data.LeaderboardsUploadedScoreEventArgs.Score
getset

The score that was attempted to set.

◆ ScoreString

string LapinerTools.Steam.Data.LeaderboardsUploadedScoreEventArgs.ScoreString
getset

◆ ScoreType

ELeaderboardDisplayType LapinerTools.Steam.Data.LeaderboardsUploadedScoreEventArgs.ScoreType
getset

The display type of the leaderboard, which was used to upload the score.

◆ SteamNative

SteamNativeData LapinerTools.Steam.Data.LeaderboardsUploadedScoreEventArgs.SteamNative
getset

Contains Steam native data such as the SteamLeaderboard handle. You can use this data to make own calls to the Steamworks.NET API.


The documentation for this class was generated from the following file: