steamworks.setNotificationPosition()

Type Function
Return value Boolean
Revision Current Public Release (2018.3326)
Keywords steam, steamworks, setNotificationPosition
See also steamworks.setAchievementProgress()
steamworks.setAchievementUnlocked()
steamworks.*

Overview

Sets where Steam's notification popups will appear within the application window. Steam notification popups appear when achievements have been unlocked, when friends appear online, etc. It is recommended to position notifications in a corner of the application window that won't cover up vital gameplay content. This position can be changed dynamically during the lifetime of the application, such as after scene changes.

Returns true if the notification position was successfully assigned.

Returns false if given invalid arguments or if the steamworks.isLoggedOn property is false.

Gotchas

Syntax

steamworks.setNotificationPosition( positionName )
positionName (required)

String. Indicates where within the application window notification popups should appear. Must be set to one of the following:

  • "topLeft"
  • "topRight"
  • "bottomLeft"
  • "bottomRight"

Example

local steamworks = require( "plugin.steamworks" )

steamworks.setNotificationPosition( "topRight" )