Skip to content

Commit

Permalink
Add docs for isDlcInstalled
Browse files Browse the repository at this point in the history
  • Loading branch information
yancouto committed Jan 14, 2024
1 parent 3d0736c commit f2da841
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/apps.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ List of Functions
-----------------

* :func:`apps.getCurrentGameLanguage`
* :func:`apps.isDlcInstalled`


Function Reference
Expand All @@ -25,3 +26,18 @@ Function Reference

print("The games current language is " .. Steam.apps.getCurrentGameLanguage())


.. function:: apps.isDlcInstalled(appID)

:param number appID: The App ID of the DLC to check.
:returns: (`boolean`) true if the user owns the DLC and it's currently installed, otherwise false.
:SteamWorks: `GetCurrentGameLanguage <https://partner.steamgames.com/doc/api/ISteamApps#BIsDlcInstalled>`_

Checks if the user owns a specific DLC and if the DLC is installed.


**Example**::

if Steam.apps.isDlcInstalled(12345) then
-- Unlock game content
end

0 comments on commit f2da841

Please sign in to comment.