Class ISteamUser

Namespace

MarymoorStudios.Core.Steamworks

Assembly

MarymoorStudios.Core.Steamworks.dll

public sealed class ISteamUser : SteamNativeObject

Inheritance

object

SteamNativeObject

ISteamUser

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Fields

INTERFACE_VERSION

public const string INTERFACE_VERSION = "SteamUser023"

Field Value

string

Methods

AdvertiseGame(CSteamID, uint, ushort)

public void AdvertiseGame(CSteamID steamIDGameServer, uint ipServer, ushort portServer)

Parameters

steamIDGameServer CSteamID

ipServer uint

portServer ushort

BIsBehindNAT()

public bool BIsBehindNAT()

Returns

bool

BIsPhoneIdentifying()

public bool BIsPhoneIdentifying()

Returns

bool

BIsPhoneRequiringVerification()

public bool BIsPhoneRequiringVerification()

Returns

bool

BIsPhoneVerified()

public bool BIsPhoneVerified()

Returns

bool

BIsTwoFactorEnabled()

public bool BIsTwoFactorEnabled()

Returns

bool

BLoggedOn()

public bool BLoggedOn()

Returns

bool

BSetDurationControlOnlineState(EDurationControlOnlineState)

public bool BSetDurationControlOnlineState(EDurationControlOnlineState newState)

Parameters

newState EDurationControlOnlineState

Returns

bool

BeginAuthSession(ReadOnlySpan<byte>, CSteamID)

public EBeginAuthSessionResult BeginAuthSession(ReadOnlySpan<byte> authTicket, CSteamID steamID)

Parameters

authTicket ReadOnlySpan<byte>

steamID CSteamID

Returns

EBeginAuthSessionResult

CancelAuthTicket(HAuthTicket)

public void CancelAuthTicket(HAuthTicket authTicket)

Parameters

authTicket HAuthTicket

DecompressVoice(ReadOnlySpan<byte>, Span<byte>, out uint, uint)

public EVoiceResult DecompressVoice(ReadOnlySpan<byte> compressed, Span<byte> destBuffer, out uint bytesWritten, uint desiredSampleRate)

Parameters

compressed ReadOnlySpan<byte>

destBuffer Span<byte>

bytesWritten uint

desiredSampleRate uint

Returns

EVoiceResult

EndAuthSession(CSteamID)

public void EndAuthSession(CSteamID steamID)

Parameters

steamID CSteamID

GetAuthSessionTicket(Span<byte>, out uint, in SteamNetworkingIdentity)

public HAuthTicket GetAuthSessionTicket(Span<byte> ticket, out uint ticketCount, in SteamNetworkingIdentity steamNetworkingIdentity)

Parameters

ticket Span<byte>

ticketCount uint

steamNetworkingIdentity SteamNetworkingIdentity

Returns

HAuthTicket

GetAuthTicketForWebApi(string)

public HAuthTicket GetAuthTicketForWebApi(string identity)

Parameters

identity string

Returns

HAuthTicket

GetAvailableVoice(out uint, out uint, uint)

public EVoiceResult GetAvailableVoice(out uint compressedCount, out uint uncompressed_DeprecatedCount, uint uncompressedVoiceDesiredSampleRate_Deprecated)

Parameters

compressedCount uint

uncompressed_DeprecatedCount uint

uncompressedVoiceDesiredSampleRate_Deprecated uint

Returns

EVoiceResult

GetDurationControl()

public Promise<DurationControl> GetDurationControl()

Returns

Promise<DurationControl>

GetEncryptedAppTicket(Span<byte>, out uint)

public bool GetEncryptedAppTicket(Span<byte> ticket, out uint ticketCount)

Parameters

ticket Span<byte>

ticketCount uint

Returns

bool

GetGameBadgeLevel(int, bool)

public int GetGameBadgeLevel(int series, bool foil)

Parameters

series int

foil bool

Returns

int

GetHSteamUser()

public HSteamUser GetHSteamUser()

Returns

HSteamUser

GetMarketEligibility()

public Promise<MarketEligibilityResponse> GetMarketEligibility()

Returns

Promise<MarketEligibilityResponse>

GetPlayerSteamLevel()

public int GetPlayerSteamLevel()

Returns

int

GetSteamID()

public CSteamID GetSteamID()

Returns

CSteamID

GetUserDataFolder(Span<byte>)

public bool GetUserDataFolder(Span<byte> buffer)

Parameters

buffer Span<byte>

Returns

bool

GetVoice(bool, Span<byte>, out uint, bool, Span<byte>, out uint, uint)

public EVoiceResult GetVoice(bool wantCompressed, Span<byte> destBuffer, out uint bytesWritten, bool wantUncompressed_Deprecated, Span<byte> uncompressedDestBuffer_Deprecated, out uint uncompressBytesWritten_Deprecated, uint uncompressedVoiceDesiredSampleRate_Deprecated)

Parameters

wantCompressed bool

destBuffer Span<byte>

bytesWritten uint

wantUncompressed_Deprecated bool

uncompressedDestBuffer_Deprecated Span<byte>

uncompressBytesWritten_Deprecated uint

uncompressedVoiceDesiredSampleRate_Deprecated uint

Returns

EVoiceResult

GetVoiceOptimalSampleRate()

public uint GetVoiceOptimalSampleRate()

Returns

uint

InitiateGameConnection(Span<byte>, CSteamID, uint, ushort, bool)

[Obsolete]
public int InitiateGameConnection(Span<byte> authBlob, CSteamID steamIDGameServer, uint ipServer, ushort portServer, bool secure)

Parameters

authBlob Span<byte>

steamIDGameServer CSteamID

ipServer uint

portServer ushort

secure bool

Returns

int

OnClientGameServerDeny(CallbackAction<ClientGameServerDeny>)

public IDisposable OnClientGameServerDeny(CallbackAction<ClientGameServerDeny> func)

Parameters

func CallbackAction<ClientGameServerDeny>

Returns

IDisposable

OnGSPolicyResponse(CallbackAction<GSPolicyResponse>)

public IDisposable OnGSPolicyResponse(CallbackAction<GSPolicyResponse> func)

Parameters

func CallbackAction<GSPolicyResponse>

Returns

IDisposable

OnGameWebCallback(CallbackAction<GameWebCallback>)

public IDisposable OnGameWebCallback(CallbackAction<GameWebCallback> func)

Parameters

func CallbackAction<GameWebCallback>

Returns

IDisposable

OnGetAuthSessionTicketResponse(CallbackAction<GetAuthSessionTicketResponse>)

public IDisposable OnGetAuthSessionTicketResponse(CallbackAction<GetAuthSessionTicketResponse> func)

Parameters

func CallbackAction<GetAuthSessionTicketResponse>

Returns

IDisposable

OnGetTicketForWebApiResponse(CallbackAction<GetTicketForWebApiResponse>)

public IDisposable OnGetTicketForWebApiResponse(CallbackAction<GetTicketForWebApiResponse> func)

Parameters

func CallbackAction<GetTicketForWebApiResponse>

Returns

IDisposable

OnIPCFailure(CallbackAction<IPCFailure>)

public IDisposable OnIPCFailure(CallbackAction<IPCFailure> func)

Parameters

func CallbackAction<IPCFailure>

Returns

IDisposable

OnLicensesUpdated(CallbackAction<LicensesUpdated>)

public IDisposable OnLicensesUpdated(CallbackAction<LicensesUpdated> func)

Parameters

func CallbackAction<LicensesUpdated>

Returns

IDisposable

OnMicroTxnAuthorizationResponse(CallbackAction<MicroTxnAuthorizationResponse>)

public IDisposable OnMicroTxnAuthorizationResponse(CallbackAction<MicroTxnAuthorizationResponse> func)

Parameters

func CallbackAction<MicroTxnAuthorizationResponse>

Returns

IDisposable

OnSteamServerConnectFailure(CallbackAction<SteamServerConnectFailure>)

public IDisposable OnSteamServerConnectFailure(CallbackAction<SteamServerConnectFailure> func)

Parameters

func CallbackAction<SteamServerConnectFailure>

Returns

IDisposable

OnSteamServersConnected(CallbackAction<SteamServersConnected>)

public IDisposable OnSteamServersConnected(CallbackAction<SteamServersConnected> func)

Parameters

func CallbackAction<SteamServersConnected>

Returns

IDisposable

OnSteamServersDisconnected(CallbackAction<SteamServersDisconnected>)

public IDisposable OnSteamServersDisconnected(CallbackAction<SteamServersDisconnected> func)

Parameters

func CallbackAction<SteamServersDisconnected>

Returns

IDisposable

OnValidateAuthTicketResponse(CallbackAction<ValidateAuthTicketResponse>)

public IDisposable OnValidateAuthTicketResponse(CallbackAction<ValidateAuthTicketResponse> func)

Parameters

func CallbackAction<ValidateAuthTicketResponse>

Returns

IDisposable

RequestEncryptedAppTicket(Span<byte>)

public Promise<EncryptedAppTicketResponse> RequestEncryptedAppTicket(Span<byte> dataToInclude)

Parameters

dataToInclude Span<byte>

Returns

Promise<EncryptedAppTicketResponse>

RequestStoreAuthURL(string)

public Promise<StoreAuthURLResponse> RequestStoreAuthURL(string redirectURL)

Parameters

redirectURL string

Returns

Promise<StoreAuthURLResponse>

StartVoiceRecording()

public void StartVoiceRecording()

StopVoiceRecording()

public void StopVoiceRecording()

TerminateGameConnection(uint, ushort)

[Obsolete]
public void TerminateGameConnection(uint ipServer, ushort portServer)

Parameters

ipServer uint

portServer ushort

TrackAppUsageEvent(CGameID, int, string)

public void TrackAppUsageEvent(CGameID gameID, int appUsageEvent, string extraInfo)

Parameters

gameID CGameID

appUsageEvent int

extraInfo string

UserHasLicenseForApp(CSteamID, AppId)

public EUserHasLicenseForAppResult UserHasLicenseForApp(CSteamID steamID, AppId appId)

Parameters

steamID CSteamID

appId AppId

Returns

EUserHasLicenseForAppResult