dreamworkAPI
Ctrl K
GitHub
classDocs / SteamError

SteamError

classsharedmenusource
Object → Error → SteamError

An error raised when a Steam API call fails.

result is the Steam EResult code of the failure, nil when Steam didn't report one.

lua
SteamError( 16 ) -- "Steam EResult 16: Operation timed out"
SteamError( 16, "player info request timed out" ) -- "player info request timed out (EResult 16: Operation timed out)"
SteamError( nil, "steam is not available" ) -- "steam is not available"
SteamError.Messages[ 15 ] -- "Access is denied"

Constructor

SteamError(result: ( integer | nil ), message: ( string | nil )): SteamError

Fields

NameTypeDescription
messagestring | nilThe reason of the failure.
resultinteger | nilThe Steam EResult code, nil if Steam didn't report one.
Messagestable<integer, string>The EResult description lookup table.

Inherited methods

From Error 5
Generated from the dreamwork meta branch.