Home / Edit Listing Workshop Items

Log in to edit

Listing Workshop Items

<cat>code.workshop</cat>
<title>Listing Workshop Items</title>

At some point you'll probably want to grab a list of workshop items to show to your players. This could be anything from addons, maps, screenshots, saved games, demo files etc. Valve don't specify what they upload - you do.


# Queries

I've tried to make things easy and hopefully as a c# user it'll seem familar.

The following queries screenshots that have been created by your friends.

```
var q = Ugc.Query.Screenshots.CreatedByFriends();
```

This is the same except they're sorted by creation date

```
var q = Ugc.Query.Screenshots
			.CreatedByFriends()
			.SortByCreationDate();
```

This is the same except tagged "funny"

```
var q = Ugc.Query.Screenshots
			.CreatedByFriends()
			.WithTag( "funny" )
			.SortByCreationDate();
```


# Item Types

The types correspond to the enum [EUGCMatchingUGCType](https://partner.steamgames.com/doc/api/ISteamUGC#EUGCMatchingUGCType). Valve does a good job of explaining the categories there.

So you can search all items with ak47 in the title/description like:

```
var q = Ugc.Query.Items
			.WhereSearchText( "ak47" )
			.RankedByTextSearch();
```


# Conditional

The query doesn't have to be created on one line

```
var q = Ugc.Query.Items
			.WithTag( "funny" );

if ( order )
	q = q.SortByCreationDate();
else 
	q = q.SortByCreationDateAsc()
```


# Pages

Results are returned in pages. And the page number starts at 1.

```
var page = await q.GetPageAsync( 1 );

if ( items?.ResultCount == 0 )
{
	Log( $"This page has {page.Value.ResultCount}" );

	foreach ( Ugc.Item entry in page.Value.Entries )
	{
		Log( $"Entry: {entry.Title}" );
	}
}
```

Facepunch.Steamworks Wiki

Facepunch.Steamworks

Getting Started 3

Installing 1

Installing For Unity

Dedicated Servers 1

Server Library

Api Documentation

Interfaces 23

Classes & Structs 58

Achievement
- Description
- GlobalUnlocked
- Identifier
- Name
- State
- UnlockTime
- Clear
- GetIcon
- GetIconAsync
- Trigger
Amount
- Item
- Quantity
AnalogState
- EMode
- X
- Y
- Active
AppId
- Value
AuthTicket
- Data
- Handle
- Cancel
- Dispose
Color
- a
- b
- g
- r
Connection
- ConnectionName
- Id
- UserData
- Accept
- Close
- DetailedStatus
- Flush
- SendMessage
ConnectionInfo
- Address
- EndReason
- Identity
- State
ConnectionManager
Controller
DepotId
- Value
DigitalState
- Active
- Pressed
Dispatch
- OnDebugCallback
- OnException
DlcInformation
- AppId
- Available
- Name
DownloadProgress
DurationControl
- Appid
- Applicable
FileDetails
- Flags
- Sha1
- SizeInBytes
Friend
FriendGameInfo
GameId
- Value
IConnectionManager
Image
- Data
- Height
- Width
- GetPixel
Ingredient
InventoryDef
InventoryDefId
- Value
InventoryItem
- Acquired
- Def
- DefId
- Id
- IsConsumed
- IsNoTrade
- IsRemoved
- Origin
- Properties
- Quantity
- AddAsync
- ConsumeAsync
- SplitStackAsync
InventoryItemId
- Value
InventoryPurchaseResult
- OrderID
- Result
- TransID
InventoryRecipe
InventoryResult
- Expired
- ItemCount
- BelongsTo
- Dispose
- GetItems
- Serialize
ISocketManager
Leaderboard
LeaderboardEntry
- Details
- GlobalRank
- Score
- User
LeaderboardUpdate
Lobby
- Data
- Id
- MaxMembers
- MemberCount
- Members
- Owner
- DeleteData
- GetData
- GetGameServer
- GetMemberData
- InviteFriend
- IsOwnedBy
- Join
- Leave
- Refresh
- SendChatString
- SetData
- SetFriendsOnly
- SetGameServer
- SetInvisible
- SetJoinable
- SetMemberData
- SetPrivate
- SetPublic
LobbyQuery
NetAddress
- Cleared
- AnyIp
- From
- LocalHost
- Address
- IsIPv4
- IsIPv6AllZeros
- IsLocalHost
- Port
NetIdentity
- LocalHost
- Address
- IsIpAddress
- IsLocalHost
- IsSteamId
- SteamId
NetPingLocation
- TryParseFromString
- EstimatePingTo
OutgoingPacket
- Address
- Data
- Port
- Size
P2Packet
- Data
- SteamId
PartyBeacon
PublishedFileId
- Value
RemotePlaySession
- ClientName
- FormFactor
- Id
- IsValid
- SteamId
Screenshot
ServerInfo
- Address
- AddressRaw
- AppId
- BotPlayers
- ConnectionPort
- Description
- GameDir
- LastTimePlayed
- Map
- MaxPlayers
- Name
- Passworded
- Ping
- Players
- QueryPort
- Secure
- SteamId
- Tags
- TagString
- Version
- AddToFavourites
- AddToHistory
- QueryRulesAsync
- RemoveFromFavourites
- RemoveFromHistory
ServerList
- Base
- Favourites
- Friends
- History
- Internet
- IpList
  - Ips
  - OnChanges
  - OnResponsiveServer
  - Responsive
  - Unresponsive
  - AppId
  - AddFilter
  - Cancel
  - Dispose
  - RunQueryAsync
  - UpdateResponsive
- LocalNetwork
Socket
- Manager
- Close
SocketManager
- Connected
- Connecting
- Interface
- Socket
- Close
- OnConnected
- OnConnecting
- OnConnectionChanged
- OnDisconnected
- OnMessage
- Receive
Stat
- Name
- UserId
- Add
- GetFloat
- GetGlobalFloat
- GetGlobalFloatDays
- GetGlobalInt
- GetGlobalIntDaysAsync
- GetInt
- Set
- Store
- UpdateAverageRate
SteamId
- Value
- AccountId
- IsValid
SteamServerInit
Ugc
Utility
SteamClass
SteamClientClass
SteamServerClass
SteamSharedClass

Enums 30

Code Snippets

General 4

Friends 1

Grouping Friends

Inventory 1

Item Store Cart

Servers 1

Get Server List

Workshop 3

Stats & Achievements 4

Networking 2

Unity Specific 1

Getting A Client's Avatar