Struct steamworks::UGC

pub struct UGC<Manager> { /* fields omitted */ }

Implementations

impl<Manager> UGC<Manager>

pub fn suspend_downloads(&self, suspend: bool)

Suspends or resumes all workshop downloads

pub fn create_item<F>(&self, app_id: AppId, file_type: FileType, cb: F) where
    F: FnOnce(Result<(PublishedFileId, bool), SteamError>) + 'static + Send, 

Creates a workshop item

pub fn start_item_update(
    &self,
    app_id: AppId,
    file_id: PublishedFileId
) -> UpdateHandle<Manager>

Starts an item update process

pub fn subscribe_item<F>(&self, published_file_id: PublishedFileId, cb: F) where
    F: FnOnce(Result<(), SteamError>) + 'static + Send, 

Subscribes to a workshop item

pub fn unsubscribe_item<F>(&self, published_file_id: PublishedFileId, cb: F) where
    F: FnOnce(Result<(), SteamError>) + 'static + Send, 

pub fn subscribed_items(&self) -> Vec<PublishedFileId>

Gets the publisher file IDs of all currently subscribed items.

pub fn item_state(&self, item: PublishedFileId) -> ItemState

pub fn item_download_info(&self, item: PublishedFileId) -> Option<(u64, u64)>

pub fn item_install_info(&self, item: PublishedFileId) -> Option<InstallInfo>

pub fn download_item(&self, item: PublishedFileId, high_priority: bool) -> bool

pub fn query_user(
    &self,
    account: AccountId,
    list_type: UserList,
    item_type: UGCType,
    sort_order: UserListOrder,
    appids: AppIDs,
    page: u32
) -> Result<UserListQuery<Manager>, CreateQueryError>

Queries a list of workshop itmes, related to a user in some way (Ex. user’s subscriptions, favorites, upvoted, …)

pub fn query_items(
    &self,
    items: Vec<PublishedFileId>
) -> Result<ItemListDetailsQuery<Manager>, CreateQueryError>

pub fn query_item(
    &self,
    item: PublishedFileId
) -> Result<ItemDetailsQuery<Manager>, CreateQueryError>

pub fn delete_item<F>(&self, published_file_id: PublishedFileId, cb: F) where
    F: FnOnce(Result<(), SteamError>) + 'static + Send, 

DELETES the item from the Steam Workshop.

impl UGC<ServerManager>

pub fn init_for_game_server(
    &self,
    workshop_depot: DepotId_t,
    folder: &str
) -> bool

Initialize this UGC interface for a Steam game server.

You should pass in the Workshop depot, you can find this on SteamDB. It’s usually just the app ID.

The folder is a path to the directory where you wish for this game server to store UGC content.

true upon success; otherwise, false if the calling user is not a game server or if the workshop is currently updating its content.