ISteamUser - adambiser/agk-steam-plugin GitHub Wiki

IsBehindNAT

IsBehindNAT() as integer

Checks if the current users looks like they are behind a NAT device.

Returns: 1 if the current user is behind a NAT, otherwise 0.

Reference:
ISteamUser#BIsBehindNAT

IsPhoneIdentifying

IsPhoneIdentifying() as integer

Checks whether the user's phone number is used to uniquely identify them.

Returns: 1 f the current user's phone uniquely verifies their identity; otherwise, 0.

Reference:
ISteamUser#BIsPhoneIdentifying

IsPhoneRequiringVerification

IsPhoneRequiringVerification() as integer

Checks whether the current user's phone number is awaiting (re)verification.

Returns: 1 if the it is requiring verification; otherwise, 0.

Reference:
ISteamUser#BIsPhoneRequiringVerification

IsPhoneVerified

IsPhoneVerified() as integer

Checks whether the current user has verified their phone number.

Returns: 1 if the current user has phone verification enabled; otherwise, 0.

Reference:
ISteamUser#BIsTwoFactorEnabled

IsTwoFactorEnabled

IsTwoFactorEnabled() as integer

Checks whether the current user has Steam Guard two factor authentication enabled on their account.

Returns: 1 if the current user has two factor authentication enabled; otherwise, 0.

Reference:
ISteamUser#IsPhoneVerified

LoggedOn

LoggedOn() as integer

Checks to see whether the user is logged on to Steam.

Returns: 1 when the user is logged on; otherwise 0.

Reference:
ISteamUser#BLoggedOn

GetDurationControl

GetDurationControl() as integer

Retrieves anti indulgence / duration control for current user / game combination.

Returns: A call result handle on success; otherwise 0.

Associated Methods:
GetDurationControlAppID
GetDurationControlApplicable
GetDurationControlSecondsInLastFiveHours
GetDurationControlProgress
GetDurationControlNotification

Reference:
ISteamUser#GetDurationControl

HasDurationControlResponse

HasDurationControlResponse() as integer

Sent for games with enabled anti indulgence / duration control, for enabled users. Lets the game know whether persistent rewards or XP should be granted at normal rate, half rate, or zero rate.

This callback is fired asynchronously in response to timers triggering. It is also fired in response to calls to GetDurationControl().

Returns: 1 when the callback has more responses to process; otherwise 0.

Associated Methods:
GetDurationControlResult
GetDurationControlAppID
GetDurationControlApplicable
GetDurationControlSecondsInLastFiveHours
GetDurationControlProgress
GetDurationControlNotification

Reference:
ISteamUser#DurationControl_t

GetDurationControlResult

GetDurationControlResult() as integer

Returns the result of the current DurationControl_t callback response.

This method should only be used when HasDurationControlResponse has returned 1.

Returns: An EResult value.

Reference:
ISteamUser#DurationControl_t
steam_api#EResult

GetDurationControlAppID

GetDurationControlAppID() as integer

Returns the appid generating playtime of the current DurationControl_t callback response.

This method should only be used when the call result returned by GetDurationControl, HasDurationControlResponse or GetMarketEligibility has reported a GetCallResultCode of 1.

Returns: An app ID.

Reference:
ISteamUser#DurationControl_t
ISteamUser#GetDurationControl
ISteamUser#MarketEligibilityResponse_t

GetDurationControlAppID

GetDurationControlAppID(hCallResult as integer) as integer

  • hCallResult - An GetDurationControl call result handle.

Returns the appid generating playtime for the given call result.

Returns: An app ID.

Reference:
ISteamUser#DurationControl_t

GetDurationControlApplicable

GetDurationControlApplicable() as integer

Returns whether the duration control is applicable to user + game combination for the current DurationControl_t callback response.

This method should only be used when the call result returned by GetDurationControl, HasDurationControlResponse or GetMarketEligibility has reported a GetCallResultCode of 1.

Returns: 1 when the duration control is applicable to user + game combination; otherwise 0.

Reference:
ISteamUser#DurationControl_t
ISteamUser#GetDurationControl
ISteamUser#MarketEligibilityResponse_t

GetDurationControlApplicable

GetDurationControlApplicable(hCallResult as integer) as integer

  • hCallResult - An GetDurationControl call result handle.

Returns whether the duration control is applicable to user + game combination for the given call result.

Returns: 1 when the duration control is applicable to user + game combination; otherwise 0.

Reference:
ISteamUser#DurationControl_t

GetDurationControlSecondsInLastFiveHours

GetDurationControlSecondsInLastFiveHours() as integer

Returns playtime in trailing 5 hour window plus current session, in seconds, for the current DurationControl_t callback response.

This method should only be used when the call result returned by GetDurationControl, HasDurationControlResponse or GetMarketEligibility has reported a GetCallResultCode of 1.

Returns: An integer.

Reference:
ISteamUser#DurationControl_t
ISteamUser#GetDurationControl
ISteamUser#MarketEligibilityResponse_t

GetDurationControlSecondsInLastFiveHours

GetDurationControlSecondsInLastFiveHours(hCallResult as integer) as integer

  • hCallResult - An GetDurationControl call result handle.

Returns playtime in trailing 5 hour window plus current session, in seconds, for the given call result.

Returns: An integer.

Reference:
ISteamUser#DurationControl_t

GetDurationControlProgress

GetDurationControlProgress() as integer

Returns the recommended progress for the current DurationControl_t callback response.

This method should only be used when the call result returned by GetDurationControl, HasDurationControlResponse or GetMarketEligibility has reported a GetCallResultCode of 1.

Returns: An EDurationControlProgress value.

Reference:
ISteamUser#DurationControl_t
ISteamUser#EDurationControlProgress
ISteamUser#GetDurationControl
ISteamUser#MarketEligibilityResponse_t

GetDurationControlProgress

GetDurationControlProgress(hCallResult as integer) as integer

  • hCallResult - An GetDurationControl call result handle.

Returns the recommended progress for the given call result.

Returns: An EDurationControlProgress value.

Reference:
ISteamUser#DurationControl_t
ISteamUser#EDurationControlProgress

GetDurationControlNotification

GetDurationControlNotification() as integer

Returns the notification to show, if any (always k_EDurationControlNotification_None for API calls), for the current DurationControl_t callback response.

This method should only be used when the call result returned by GetDurationControl, HasDurationControlResponse or GetMarketEligibility has reported a GetCallResultCode of 1.

Returns: An EDurationControlProgress value.

Reference:
ISteamUser#DurationControl_t
ISteamUser#EDurationControlNotification
ISteamUser#GetDurationControl
ISteamUser#MarketEligibilityResponse_t

GetDurationControlNotification

GetDurationControlNotification(hCallResult as integer) as integer

  • hCallResult - An GetDurationControl call result handle.

Returns the notification to show, if any (always k_EDurationControlNotification_None for API calls), for the given call result.

Returns: An EDurationControlProgress value.

Reference:
ISteamUser#DurationControl_t
ISteamUser#EDurationControlNotification

GetGameBadgeLevel

GetGameBadgeLevel(series as integer, foil as integer) as integer

  • series - If you only have one set of cards, the series will be 1.
  • foil - Check if they have received the foil badge.

Gets the level of the users Steam badge for your game. The user can have two different badges for a series; the regular badge (max level 5) and the foil badge (max level 1).

Returns: The user's badge level.

Reference:
ISteamUser#GetGameBadgeLevel

GetMarketEligibility

GetMarketEligibility() as integer

Checks whether or not an account is allowed to use the market.

Returns: A call result handle on success; otherwise 0.

Associated Methods:
GetDurationControlAppID
GetDurationControlApplicable
GetDurationControlSecondsInLastFiveHours
GetDurationControlProgress
GetDurationControlNotification

Reference:
ISteamUser#MarketEligibilityResponse_t

GetMarketEligibilityIsAllowed

GetMarketEligibilityIsAllowed(hCallResult as integer) as integer

  • hCallResult - An GetMarketEligibility call result handle.

Returns whether or not the user can use the market.

Returns: 1 if the user can use the market; otherwise 0.

Reference:
ISteamUser#MarketEligibilityResponse_t

GetMarketEligibilityNotAllowedReason

GetMarketEligibilityNotAllowedReason(hCallResult as integer) as integer

  • hCallResult - An GetMarketEligibility call result handle.

Returns the reasons a user may not use the Community Market.

Returns: A EMarketNotAllowedReasonFlags value.

Reference:
ISteamUser#MarketEligibilityResponse_t

GetMarketEligibilityAllowedAtTime

GetMarketEligibilityAllowedAtTime(hCallResult as integer) as integer

  • hCallResult - An GetMarketEligibility call result handle.

Returns when the user is allowed to use the market again.

Returns: A Unix time.

Reference:
ISteamUser#MarketEligibilityResponse_t

GetMarketEligibilitySteamGuardRequiredDays

GetMarketEligibilitySteamGuardRequiredDays(hCallResult as integer) as integer

  • hCallResult - An GetMarketEligibility call result handle.

Returns the number of days any user is required to have had Steam Guard before they can use the market

Returns: An integer.

Reference:
ISteamUser#MarketEligibilityResponse_t

GetMarketEligibilityNewDeviceCooldown

GetMarketEligibilityNewDeviceCooldown(hCallResult as integer) as integer

  • hCallResult - An GetMarketEligibility call result handle.

Returns the number of days after initial device authorization a user must wait before using the market on that device

Returns: An integer

Reference:
ISteamUser#MarketEligibilityResponse_t

GetPlayerSteamLevel

GetPlayerSteamLevel() as integer

Gets the Steam level of the user, as shown on their Steam community profile.

Returns: The level of the current user.

Reference:
ISteamUser#GetPlayerSteamLevel

GetSteamID

GetSteamID() as integer

Gets a handle to the Steam ID of the account currently logged into the Steam client.

Returns: A SteamID handle

Reference:
ISteamUser#GetSteamID

IsSteamIDValid

IsSteamIDValid(hSteamID as integer) as integer

  • hSteamID - The Steam ID handle to check.

Checks to see if a Steam ID handle is valid.

Returns: 1 when the Steam ID handle is valid; otherwise 0.

GetAccountID

GetAccountID(hSteamIDUser as integer) as integer

  • hSteamIDUser - A user Steam ID handle.

Gets the the account ID (profile number) for the given Steam ID handle.

Returns: The account ID.

GetSteamID3

GetSteamID3(hSteamIDUser as integer) as string

  • hSteamIDUser - A user Steam ID handle.

Gets the the SteamID3 for the given Steam ID handle.

Returns: A string containing the SteamID3.

Reference:
SteamID#Types_of_Steam_Accounts

GetSteamID64

GetSteamID64(hSteamIDUser as integer) as string

  • hSteamIDUser - A user Steam ID handle.

Gets the the SteamID64 (profile number) for the given Steam ID handle.

Returns: A string containing the 64-bit SteamID64 in base 10.

GetHandleFromSteamID64

GetHandleFromSteamID64(steamID64 as string) as integer

  • steamID64 - A SteamID64 string.

Returns the handle for the given SteamID64 string.

Returns: A Steam ID handle or 0.