steamworks/GetList

From Garry's Mod
(Difference between revisions)
Jump to: navigation, search
 
Line 8: Line 8:
 
|name=type
 
|name=type
 
|desc=The type of items to retrieve. Possible values include:
 
|desc=The type of items to retrieve. Possible values include:
* popular
+
* popular (All invalid options will equal to this)
 
* trending
 
* trending
 
* latest
 
* latest
Line 45: Line 45:
 
{{Example
 
{{Example
 
|Description=Retrieves top 10 of Steam Workshop addons.
 
|Description=Retrieves top 10 of Steam Workshop addons.
|Code=steamworks.GetList( "", nil, 0, 10, 7, 0, function( data ) PrintTable( data ) end )
+
|Code=steamworks.GetList( "popular", nil, 0, 10, 7, 0, function( data ) PrintTable( data ) end )
 
|OutputFixedWidth=Fixed width
 
|OutputFixedWidth=Fixed width
 
|Output=totalresults = 1748
 
|Output=totalresults = 1748

Latest revision as of 18:01, 29 November 2019

 steamworks.GetList( )

Contents

Description

Retrieves a customized list of Steam Workshop addons.

Arguments

string type

The type of items to retrieve. Possible values include:

  • popular (All invalid options will equal to this)
  • trending
  • latest
  • friends

Arguments

table tags

A table of tags to match.

Arguments

number offset

How much of results to skip from first one. Mainly used for pages.

Arguments

number numRetrieve

How much items to retrieve, up to 50 at a time.

Arguments

number days

When getting Most Popular content from Steam, this determines a time period. ( 7 = most popular addons in last 7 days, 1 = most popular addons today, etc )

Arguments

string userID

"0" to retrieve all addons, "1" to retrieve addons only published by you, or a valid SteamID64 of a user to get workshop items of.

Arguments

function resultCallback

The function to process retrieved data. The first and only argument is a table, containing all the info, or nil in case of error

Examples

Example

Retrieves top 10 of Steam Workshop addons.

steamworks.GetList( "popular", nil, 0, 10, 7, 0, function( data ) PrintTable( data ) end )

Output:

totalresults = 1748
 numresults = 10
 results:
 1 = 21197
 2 = 72122655
 3 = 68207248
 4 = 71921341
 5 = 79927494
 6 = 12692
 7 = 21174
 8 = 72145362
 9 = 16221
 10 = 22104
Personal tools
Navigation