Skip to content

Enumerations

This section describes all enumerations used throughout the PloxTools: Steam Integration plugin.

Enumerations define fixed sets of values returned by Steam services or required as input for specific operations. They are used consistently across both Blueprint and C++ workflows.

Each enumeration is documented with its possible values and a clear description of their meaning and usage context.


Friends

ESteamFriendRelationship

Represents the relationship between the local user and another Steam user.

This enumeration describes how the local user is connected to another Steam account in the friends system.

Value Description
None No relationship exists between the users.
Blocked The user is blocked by the local user.
RequestRecipient The user has sent a friend request to the local user.
Friend The user is a confirmed friend of the local user.
RequestInitiator The local user has sent a friend request to this user.
Ignored The user is ignored by the local user.
IgnoredFriend The user is ignored but is still considered a friend.
Suggested The user is suggested as a potential friend by Steam.
Unknown The relationship state is unknown or could not be determined.

Leaderboards

ESteamLeaderboardUploadMethod

Defines how a score is uploaded to a Steam leaderboard.

This enumeration controls whether a submitted score replaces an existing score or only updates it if the new value is better.

Value Description
KeepBest Keeps the best score. Lower scores will not overwrite the existing value.
ForceUpdate Always overwrites the score, even if the new value is lower.

ESteamLeaderboardDataRequest

Defines which leaderboard entries should be downloaded.

This enumeration specifies the scope of leaderboard data to retrieve from Steam.

Value Description
Global Downloads global leaderboard entries.
GlobalAroundUser Downloads leaderboard entries around the current user.
Friends Downloads leaderboard entries of the user's friends.

ESteamLeaderboardSortMethod

Defines how a leaderboard is sorted.

This enumeration determines how scores are ordered within a leaderboard.

Value Description
Ascending Lower scores are ranked higher.
Descending Higher scores are ranked higher.

ESteamLeaderboardDisplayType

Defines how leaderboard scores are displayed.

This enumeration controls how score values are interpreted and presented.

Value Description
Numeric Score is displayed as a numeric value.
TimeSeconds Score represents time in seconds.
TimeMilli Score represents time in milliseconds.

Lobbies

ESteamCreateLobbyResult

Represents the result of attempting to create a Steam lobby.

This enumeration describes possible outcomes returned by the lobby creation process.

Value Description
Success The lobby was successfully created.
Fail A generic failure occurred during lobby creation.
Timeout The operation timed out.
AccessDenied The user does not have permission to create a lobby.
LimitExceeded The lobby creation limit has been exceeded.
NoConnection There is no connection to the Steam backend.
AlreadyInLobby The user is already in a lobby.
UnknownError An unknown or unhandled error occurred.

ESteamLobbyType

Defines lobby visibility and accessibility.

This enumeration controls how a lobby can be discovered and joined by other users.

Value Description
Private Private lobby, joinable only by invitation.
FriendsOnly Lobby visible and joinable only by friends.
Public Publicly visible and joinable lobby.
Invisible Invisible lobby, not listed but joinable by lobby ID.

ESteamLobbyDistanceFilter

Defines geographic distance filtering when searching for lobbies.

This enumeration controls how Steam filters lobbies based on geographic proximity.

Value Description
Close Searches for lobbies in nearby regions only.
Default Uses Steam's default distance filtering.
Far Allows lobbies from far regions.
Worldwide No geographic distance limitations are applied.

ESteamLobbyComparison

Defines comparison operators used for lobby search filters.

This enumeration specifies how lobby metadata values are compared when filtering search results.

Value Description
Equal Value must be equal to the specified filter value.
NotEqual Value must not be equal to the specified filter value.
GreaterThan Value must be greater than the specified filter value.
LessThan Value must be less than the specified filter value.
GreaterOrEqual Value must be greater than or equal to the specified filter value.
LessOrEqual Value must be less than or equal to the specified filter value.

ESteamLobbyJoinResult

Represents the result of attempting to join a Steam lobby.

This enumeration describes possible outcomes returned when joining an existing lobby.

Value Description
Success Successfully joined the lobby.
LobbyDoesNotExist The lobby no longer exists.
LobbyFull The lobby has reached its member limit.
AccessDenied The user does not have access to the lobby.
Banned The user is banned from the lobby.
AlreadyInLobby The user is already in this lobby.
UnknownError An unknown or unhandled error occurred.

Overlay

ESteamOverlayUserDialog

Specifies which dialog should be opened for a specific Steam user.

This enumeration is used to control which user-related dialog is displayed in the Steam Overlay.

Value Description
Chat Opens a chat window with the selected user.
Profile Opens the user's Steam profile page.
Stats Opens the user's game statistics page, if available.
Achievements Opens the user's achievements page for the current game.
AddFriend Opens the dialog to send a friend request to the user.
RemoveFriend Opens the dialog to remove the user from friends.
AcceptFriendRequest Opens the dialog to accept an incoming friend request.
JoinGroup Opens the dialog to join a Steam group the user is in.
JoinTrade Opens the dialog to join a trade with the user.

ESteamOverlaySection

Specifies which main section of the Steam Overlay should be opened.

This enumeration controls navigation to major sections of the Steam Overlay UI.

Value Description
Friends Opens the Friends list section.
Community Opens the Steam Community hub.
Players Opens the Players or recent players section.
Settings Opens Steam settings.
OfficialGameGroup Opens the official game group page.
Stats Opens the game statistics page.
Achievements Opens the game achievements page.

Presence

ESteamPresenceKey

Defines commonly used Steam Rich Presence keys.

This enumeration provides standard keys used when setting or reading Rich Presence values through Steam.

Value Description
Status Text shown in the “View Game Info” section of the Steam Friends list.
Connect Enables the “Join Game” functionality via Steam.
SteamDisplay Localization token used by the Steam UI for Rich Presence display.
SteamPlayerGroup Player group identifier used by the Steam UI.
SteamPlayerGroupSize Size of the player group used by the Steam UI.

Screenshots

ESteamScreenshotResult

Represents the result of submitting a screenshot to Steam.

This enumeration describes possible outcomes returned by the Steam screenshot submission process.

Value Description
OK The screenshot was successfully accepted by Steam.
Fail A generic failure occurred during screenshot submission.
AccessDenied Access to screenshots is denied (for example, screenshots are disabled).
LimitExceeded The screenshot limit has been exceeded.
Unknown An unknown or unmapped result was returned.

User

ESteamPersonaState

Represents the current online status of a Steam user.

This enumeration describes the presence and availability state of a Steam account as reported by Steam.

Value Description
Offline The user is currently offline.
Online The user is currently online.
Away The user is away.
Busy The user is busy.
Snooze The user is snoozing.
LookingToTrade The user is looking to trade.
LookingToPlay The user is looking to play.
Unknown The persona state is unknown or could not be determined.

ESteamAvatarSize

Represents available Steam avatar image sizes.

This enumeration defines the supported avatar image resolutions that can be requested for a Steam user.

Value Description
Small Small avatar image (32×32).
Medium Medium avatar image (64×64).
Large Large avatar image (184×184).