Enumerations
This section describes the public enumerations used throughout PloxTools: Steam Integration.
Enumerations define fixed sets of values returned by the plugin or required as input for specific operations. They are shared by Blueprint and C++ APIs, including runtime Steam features and the Steam Publishing Tool.
Steam Publishing Tool
EPloxToolsSteamPublishingBuildMode
Defines how the Steam Publishing Tool obtains the build that will be uploaded to Steam.
| Value | Description |
|---|---|
| PackageProjectAndUpload | Packages the Unreal Engine project first, then uploads the generated build. |
| UploadExistingBuildFolder | Uploads an existing packaged build folder without packaging the project first. |
EPloxToolsSteamPublishingBuildConfiguration
Defines the Unreal Engine build configuration used when the Steam Publishing Tool packages the project.
| Value | Description |
|---|---|
| Shipping | Packages the project using the Shipping configuration. |
| Development | Packages the project using the Development configuration. |
| DebugGame | Packages the project using the DebugGame configuration. |
| Debug | Packages the project using the Debug configuration. |
Friends
ESteamFriendRelationship
Represents the relationship between the local user and another Steam user.
| Value | Description |
|---|---|
| None | No relationship. |
| Blocked | The user is blocked. |
| RequestRecipient | The user has sent a friend request to the local user. |
| Friend | The user is a friend. |
| RequestInitiator | The local user has sent a friend request. |
| Ignored | The user is ignored. |
| IgnoredFriend | The user is ignored but still a friend. |
| Suggested | The user is suggested as a friend. |
| Unknown | Unknown relationship. |
Leaderboards
ESteamLeaderboardUploadMethod
Defines how a submitted score is applied to an existing Steam leaderboard entry.
| Value | Description |
|---|---|
| KeepBest | Keeps the best score. A worse submitted score does not replace the existing value. |
| ForceUpdate | Always replaces the existing score with the submitted value. |
ESteamLeaderboardDataRequest
Defines which group of leaderboard entries should be downloaded.
| Value | Description |
|---|---|
| Global | Downloads global leaderboard entries. |
| GlobalAroundUser | Downloads leaderboard entries around the current user. |
| Friends | Downloads leaderboard entries for the current user and friends. |
ESteamLeaderboardSortMethod
Defines how scores are ranked within a Steam leaderboard.
| Value | Description |
|---|---|
| Ascending | Lower scores are ranked higher. |
| Descending | Higher scores are ranked higher. |
ESteamLeaderboardDisplayType
Defines how leaderboard score values are presented by Steam.
| Value | Description |
|---|---|
| Numeric | Displays the score as a numeric value. |
| TimeSeconds | Interprets the score as a time value in seconds. |
| TimeMilli | Interprets the score as a time value in milliseconds. |
Lobbies
ESteamCreateLobbyResult
Represents the result of attempting to create a Steam lobby.
| Value | Description |
|---|---|
| Success | Lobby successfully created. |
| Fail | Generic failure. |
| Timeout | Operation timed out. |
| AccessDenied | User has no permission to create lobby. |
| LimitExceeded | Lobby creation limit exceeded. |
| NoConnection | No connection to Steam backend. |
| AlreadyInLobby | User is already in a lobby. |
| UnknownError | Unknown or unhandled error. |
ESteamLobbyType
Defines lobby visibility and accessibility.
| Value | Description |
|---|---|
| Private | Private lobby, joinable only by invitation. |
| FriendsOnly | Visible only to friends. |
| Public | Publicly visible and joinable. |
| Invisible | Invisible lobby, not listed but joinable by ID. |
ESteamLobbyDistanceFilter
Defines the geographic distance range used when searching for Steam lobbies.
| Value | Description |
|---|---|
| Close | Nearby region only. |
| Default | Steam default distance. |
| Far | Far regions allowed. |
| Worldwide | No distance limitation. |
ESteamLobbyComparison
Defines the comparison operation used by a lobby search filter.
| Value | Description |
|---|---|
| Equal | The lobby value must equal the filter value. |
| NotEqual | The lobby value must not equal the filter value. |
| GreaterThan | The lobby value must be greater than the filter value. |
| LessThan | The lobby value must be less than the filter value. |
| GreaterOrEqual | The lobby value must be greater than or equal to the filter value. |
| LessOrEqual | The lobby value must be less than or equal to the filter value. |
ESteamLobbySearchFilterType
Defines whether a lobby search filter compares a string or numeric value.
| Value | Description |
|---|---|
| String | Compares lobby data as text. |
| Numeric | Compares lobby data as a 32-bit integer. |
ESteamLobbyJoinResult
Represents the result of attempting to join a Steam lobby.
| Value | Description |
|---|---|
| Success | Successfully joined lobby. |
| LobbyDoesNotExist | Lobby does not exist anymore. |
| LobbyFull | Lobby member limit reached. |
| AccessDenied | User has no access to lobby. |
| Banned | User is banned from lobby. |
| AlreadyInLobby | User already inside this lobby. |
| UnknownError | Unknown or unhandled error. |
Multiplayer
ESteamMultiplayerState
Represents the current state of the managed Steam Multiplayer system.
| Value | Description |
|---|---|
| Idle | The managed Multiplayer system is in the Idle state. |
| Hosting | The managed Multiplayer system is in the Hosting state. |
| Searching | The managed Multiplayer system is in the Searching state. |
| Joining | The managed Multiplayer system is in the Joining state. |
| Connected | The managed Multiplayer system is in the Connected state. |
| Traveling | The managed Multiplayer system is in the Traveling state. |
| Leaving | The managed Multiplayer system is in the Leaving state. |
ESteamMultiplayerRole
Represents the local player role in the current managed Steam game.
| Value | Description |
|---|---|
| None | The local managed Multiplayer role is None. |
| Host | The local managed Multiplayer role is Host. |
| Client | The local managed Multiplayer role is Client. |
ESteamMultiplayerError
Represents the result or failure reason returned by managed Steam Multiplayer operations.
| Value | Description |
|---|---|
| Success | The Multiplayer operation returned Success. |
| SteamNotInitialized | The Multiplayer operation returned Steam Not Initialized. |
| InvalidParameters | The Multiplayer operation returned Invalid Parameters. |
| AlreadyInGame | The Multiplayer operation returned Already In Game. |
| NotInGame | The Multiplayer operation returned Not In Game. |
| NotHost | The Multiplayer operation returned Not Host. |
| LobbyCreationFailed | The Multiplayer operation returned Lobby Creation Failed. |
| LobbyNotFound | The Multiplayer operation returned Lobby Not Found. |
| LobbyFull | The Multiplayer operation returned Lobby Full. |
| LobbyNotJoinable | The Multiplayer operation returned Lobby Not Joinable. |
| VersionMismatch | The Multiplayer operation returned Version Mismatch. |
| ConnectionFailed | The Multiplayer operation returned Connection Failed. |
| ConnectionTimedOut | The Multiplayer operation returned Connection Timed Out. |
| HostDisconnected | The Multiplayer operation returned Host Disconnected. |
| TravelFailed | The Multiplayer operation returned Travel Failed. |
| UserCanceled | The Multiplayer operation returned User Canceled. |
| Unknown | The Multiplayer operation returned Unknown. |
Overlay
ESteamOverlayUserDialog
Specifies which Steam Overlay dialog should be opened for a specific user.
| 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 Steam Overlay section should be opened.
| Value | Description |
|---|---|
| Friends | Opens the Friends list section. |
| Community | Opens the Steam Community hub. |
| Players | Opens the Players / 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.
| Value | Description |
|---|---|
| Status | Text shown in "View Game Info" in Steam Friends list. |
| Connect | Enables Join Game functionality via Steam. |
| SteamDisplay | Localization token used by Steam UI (rich presence localization). |
| SteamPlayerGroup | Player group identifier used by Steam UI. |
| SteamPlayerGroupSize | Size of the player group used by Steam UI. |
Screenshots
ESteamScreenshotResult
Represents the result of submitting a screenshot to Steam.
| Value | Description |
|---|---|
| OK | Screenshot was successfully accepted by Steam. |
| Fail | Generic failure. |
| AccessDenied | Access denied (for example, screenshots disabled). |
| LimitExceeded | Screenshot limit exceeded. |
| Unknown | Unknown or unmapped result. |
Steam Input
ESteamInputDeviceType
Represents the controller model reported by Steam Input.
| Value | Description |
|---|---|
| Unknown | Represents a Unknown controller. |
| SteamController | Represents a Steam Controller controller. |
| Xbox360 | Represents a Xbox 360 controller. |
| XboxOne | Represents a Xbox One / Series controller. |
| GenericGamepad | Represents a Generic Gamepad controller. |
| PlayStation4 | Represents a PlayStation 4 controller. |
| AppleMFi | Represents a Apple MFi controller. |
| Android | Represents a Android controller. |
| SwitchJoyConPair | Represents a Switch Joy-Con Pair controller. |
| SwitchJoyConSingle | Represents a Switch Joy-Con Single controller. |
| SwitchPro | Represents a Switch Pro Controller controller. |
| MobileTouch | Represents a Mobile Touch controller. |
| PlayStation3 | Represents a PlayStation 3 controller. |
| PlayStation5 | Represents a PlayStation 5 controller. |
| SteamDeck | Represents a Steam Deck controller. |
| SteamOSHandheld | Represents a SteamOS Handheld controller. |
| Switch2Pro | Represents a Switch 2 Pro Controller controller. |
| SteamController2026 | Represents a Steam Controller 2026 controller. |
| SteamFrameControllerPair | Represents a Steam Frame Controller Pair controller. |
| Other | Represents a Other controller. |
ESteamInputActionType
Defines whether a Steam Input action is digital or analog.
| Value | Description |
|---|---|
| Digital | Represents a digital Steam Input action. |
| Analog | Represents a analog Steam Input action. |
ESteamInputAnalogMode
Represents the source mode reported for a Steam Input analog action.
| Value | Description |
|---|---|
| None | Represents the None analog source mode. |
| DPad | Represents the D-Pad analog source mode. |
| Buttons | Represents the Buttons analog source mode. |
| FourButtons | Represents the Four Buttons analog source mode. |
| AbsoluteMouse | Represents the Absolute Mouse analog source mode. |
| RelativeMouse | Represents the Relative Mouse analog source mode. |
| JoystickMove | Represents the Joystick Move analog source mode. |
| JoystickMouse | Represents the Joystick Mouse analog source mode. |
| JoystickCamera | Represents the Joystick Camera analog source mode. |
| ScrollWheel | Represents the Scroll Wheel analog source mode. |
| Trigger | Represents the Trigger analog source mode. |
| TouchMenu | Represents the Touch Menu analog source mode. |
| MouseJoystick | Represents the Mouse Joystick analog source mode. |
| MouseRegion | Represents the Mouse Region analog source mode. |
| RadialMenu | Represents the Radial Menu analog source mode. |
| SingleButton | Represents the Single Button analog source mode. |
| Switches | Represents the Switches analog source mode. |
| Unknown | Represents the Unknown analog source mode. |
ESteamInputGlyphResolution
Defines the requested resolution of a Steam Input action glyph.
| Value | Description |
|---|---|
| Small | Requests the Small (32x32) glyph resolution. |
| Medium | Requests the Medium (128x128) glyph resolution. |
| Large | Requests the Large (256x256) glyph resolution. |
ESteamInputHapticPad
Specifies which controller pad receives a legacy haptic pulse.
| Value | Description |
|---|---|
| Left | Targets the left haptic pad. |
| Right | Targets the right haptic pad. |
| Both | Targets the both haptic pad. |
ESteamInputHapticLocation
Specifies which controller location receives a haptic vibration.
| Value | Description |
|---|---|
| Left | Targets the left haptic location. |
| Right | Targets the right haptic location. |
| Both | Targets the both haptic location. |
ESteamGamepadTextInputMode
Defines the input mode used by the Steam gamepad text input dialog.
| Value | Description |
|---|---|
| Normal | Uses normal gamepad text input. |
| Password | Uses password gamepad text input. |
ESteamGamepadTextInputLineMode
Defines whether the Steam gamepad text input dialog accepts one or multiple lines.
| Value | Description |
|---|---|
| SingleLine | Uses single line text input. |
| MultipleLines | Uses multiple lines text input. |
ESteamFloatingGamepadTextInputMode
Defines the input mode used by the floating Steam gamepad keyboard.
| Value | Description |
|---|---|
| SingleLine | Uses single line floating gamepad text input. |
| MultipleLines | Uses multiple lines floating gamepad text input. |
| Uses email floating gamepad text input. | |
| Numeric | Uses numeric floating gamepad text input. |
User
ESteamPersonaState
Represents the current online status of a Steam user.
| Value | Description |
|---|---|
| Offline | User is offline. |
| Online | User is online. |
| Away | User is away. |
| Busy | User is busy. |
| Snooze | User is snoozing. |
| LookingToTrade | User is looking to trade. |
| LookingToPlay | User is looking to play. |
| Unknown | Persona state is unknown. |
ESteamAvatarSize
Defines the Steam avatar image size to request.
| Value | Description |
|---|---|
| Small | Small avatar size (32x32). |
| Medium | Medium avatar size (64x64). |
| Large | Large avatar size (184x184). |
Voice Chat
ESteamVoiceInputMode
Defines when the local microphone is transmitted by Steam Voice Chat.
| Value | Description |
|---|---|
| PushToTalk | Transmits the local microphone only while Push To Talk is active. |
| VoiceActivation | Transmits the local microphone automatically when voice activity exceeds the configured threshold. |
| AlwaysOn | Keeps the local microphone active continuously while Steam Voice Chat is enabled. |
ESteamVoiceChatMode
Defines how remote Steam voice audio is played in the game.
| Value | Description |
|---|---|
| Global | Plays remote voice globally without distance-based attenuation. |
| Proximity | Plays remote voice based on the distance to the assigned Voice Actor. |