Class ISteamUtils

Namespace

MarymoorStudios.Core.Steamworks

Assembly

MarymoorStudios.Core.Steamworks.dll

public sealed class ISteamUtils : SteamNativeObject

Inheritance

object

SteamNativeObject

ISteamUtils

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 = "SteamUtils010"

Field Value

string

Methods

BOverlayNeedsPresent()

public bool BOverlayNeedsPresent()

Returns

bool

CheckFileSignature(string)

public Promise<CheckFileSignature> CheckFileSignature(string fileName)

Parameters

fileName string

Returns

Promise<CheckFileSignature>

DismissFloatingGamepadTextInput()

public bool DismissFloatingGamepadTextInput()

Returns

bool

DismissGamepadTextInput()

public bool DismissGamepadTextInput()

Returns

bool

FilterText(ETextFilteringContext, CSteamID, string, Span<byte>)

public int FilterText(ETextFilteringContext context, CSteamID sourceSteamID, string inputMessage, Span<byte> outFilteredText)

Parameters

context ETextFilteringContext

sourceSteamID CSteamID

inputMessage string

outFilteredText Span<byte>

Returns

int

GetAPICallFailureReason(SteamAPICall)

public ESteamAPICallFailure GetAPICallFailureReason(SteamAPICall steamAPICall)

Parameters

steamAPICall SteamAPICall

Returns

ESteamAPICallFailure

GetAPICallResult(SteamAPICall, Span<byte>, int, out bool)

public bool GetAPICallResult(SteamAPICall steamAPICall, Span<byte> callback, int callbackExpected, out bool failed)

Parameters

steamAPICall SteamAPICall

callback Span<byte>

callbackExpected int

failed bool

Returns

bool

GetAppID()

public uint GetAppID()

Returns

uint

GetConnectedUniverse()

public EUniverse GetConnectedUniverse()

Returns

EUniverse

GetCurrentBatteryPower()

public byte GetCurrentBatteryPower()

Returns

byte

GetEnteredGamepadTextInput(Span<byte>)

public bool GetEnteredGamepadTextInput(Span<byte> text)

Parameters

text Span<byte>

Returns

bool

GetEnteredGamepadTextLength()

public uint GetEnteredGamepadTextLength()

Returns

uint

GetIPCCallCount()

public uint GetIPCCallCount()

Returns

uint

GetIPCountry()

public string GetIPCountry()

Returns

string

GetIPv6ConnectivityState(ESteamIPv6ConnectivityProtocol)

public ESteamIPv6ConnectivityState GetIPv6ConnectivityState(ESteamIPv6ConnectivityProtocol protocol)

Parameters

protocol ESteamIPv6ConnectivityProtocol

Returns

ESteamIPv6ConnectivityState

GetImageRGBA(int, Span<byte>)

public bool GetImageRGBA(int image, Span<byte> dest)

Parameters

image int

dest Span<byte>

Returns

bool

GetImageSize(int, out uint, out uint)

public bool GetImageSize(int image, out uint width, out uint height)

Parameters

image int

width uint

height uint

Returns

bool

GetSecondsSinceAppActive()

public uint GetSecondsSinceAppActive()

Returns

uint

GetSecondsSinceComputerActive()

public uint GetSecondsSinceComputerActive()

Returns

uint

GetServerRealTime()

public uint GetServerRealTime()

Returns

uint

GetSteamUILanguage()

public string GetSteamUILanguage()

Returns

string

InitFilterText(uint)

public bool InitFilterText(uint filterOptions)

Parameters

filterOptions uint

Returns

bool

IsAPICallCompleted(SteamAPICall, out bool)

public bool IsAPICallCompleted(SteamAPICall steamAPICall, out bool failed)

Parameters

steamAPICall SteamAPICall

failed bool

Returns

bool

IsOverlayEnabled()

public bool IsOverlayEnabled()

Returns

bool

IsSteamChinaLauncher()

public bool IsSteamChinaLauncher()

Returns

bool

IsSteamInBigPictureMode()

public bool IsSteamInBigPictureMode()

Returns

bool

IsSteamRunningInVR()

public bool IsSteamRunningInVR()

Returns

bool

IsSteamRunningOnSteamDeck()

public bool IsSteamRunningOnSteamDeck()

Returns

bool

IsVRHeadsetStreamingEnabled()

public bool IsVRHeadsetStreamingEnabled()

Returns

bool

OnAppResumingFromSuspend(CallbackAction<AppResumingFromSuspend>)

public IDisposable OnAppResumingFromSuspend(CallbackAction<AppResumingFromSuspend> func)

Parameters

func CallbackAction<AppResumingFromSuspend>

Returns

IDisposable

OnFilterTextDictionaryChanged(CallbackAction<FilterTextDictionaryChanged>)

public IDisposable OnFilterTextDictionaryChanged(CallbackAction<FilterTextDictionaryChanged> func)

Parameters

func CallbackAction<FilterTextDictionaryChanged>

Returns

IDisposable

OnFloatingGamepadTextInputDismissed(CallbackAction<FloatingGamepadTextInputDismissed>)

public IDisposable OnFloatingGamepadTextInputDismissed(CallbackAction<FloatingGamepadTextInputDismissed> func)

Parameters

func CallbackAction<FloatingGamepadTextInputDismissed>

Returns

IDisposable

OnGamepadTextInputDismissed(CallbackAction<GamepadTextInputDismissed>)

public IDisposable OnGamepadTextInputDismissed(CallbackAction<GamepadTextInputDismissed> func)

Parameters

func CallbackAction<GamepadTextInputDismissed>

Returns

IDisposable

OnIPCountry(CallbackAction<IPCountry>)

public IDisposable OnIPCountry(CallbackAction<IPCountry> func)

Parameters

func CallbackAction<IPCountry>

Returns

IDisposable

OnLowBatteryPower(CallbackAction<LowBatteryPower>)

public IDisposable OnLowBatteryPower(CallbackAction<LowBatteryPower> func)

Parameters

func CallbackAction<LowBatteryPower>

Returns

IDisposable

OnSteamAPICallCompleted(CallbackAction<SteamAPICallCompleted>)

public IDisposable OnSteamAPICallCompleted(CallbackAction<SteamAPICallCompleted> func)

Parameters

func CallbackAction<SteamAPICallCompleted>

Returns

IDisposable

OnSteamShutdown(CallbackAction<SteamShutdown>)

public IDisposable OnSteamShutdown(CallbackAction<SteamShutdown> func)

Parameters

func CallbackAction<SteamShutdown>

Returns

IDisposable

SetGameLauncherMode(bool)

public void SetGameLauncherMode(bool launcherMode)

Parameters

launcherMode bool

SetOverlayNotificationInset(int, int)

public void SetOverlayNotificationInset(int horizontalInset, int verticalInset)

Parameters

horizontalInset int

verticalInset int

SetOverlayNotificationPosition(ENotificationPosition)

public void SetOverlayNotificationPosition(ENotificationPosition notificationPosition)

Parameters

notificationPosition ENotificationPosition

SetVRHeadsetStreamingEnabled(bool)

public void SetVRHeadsetStreamingEnabled(bool enabled)

Parameters

enabled bool

ShowFloatingGamepadTextInput(EFloatingGamepadTextInputMode, int, int, int, int)

public bool ShowFloatingGamepadTextInput(EFloatingGamepadTextInputMode keyboardMode, int textFieldXPosition, int textFieldYPosition, int textFieldWidth, int textFieldHeight)

Parameters

keyboardMode EFloatingGamepadTextInputMode

textFieldXPosition int

textFieldYPosition int

textFieldWidth int

textFieldHeight int

Returns

bool

ShowGamepadTextInput(EGamepadTextInputMode, EGamepadTextInputLineMode, string, uint, string)

public bool ShowGamepadTextInput(EGamepadTextInputMode inputMode, EGamepadTextInputLineMode lineInputMode, string description, uint charMax, string existingText)

Parameters

inputMode EGamepadTextInputMode

lineInputMode EGamepadTextInputLineMode

description string

charMax uint

existingText string

Returns

bool

StartVRDashboard()

public void StartVRDashboard()