Facepunch.Steamworks Wiki

Revision Difference

SteamUGC.DownloadAsync#524745

<member category="interface" type="method" namespace="Steamworks" parent="SteamUGC" name="DownloadAsync" async="true" static="true"> <args> <arg name="fileId" type="Data.PublishedFileId"></arg>⤶ <arg name="progress" type="Action<float>" default=""></arg>⤶ <arg name="milisecondsUpdateDelay" type="int" default="60"></arg>⤶ <arg name="ct" type="System.Threading.CancellationToken" default=""></arg>⤶ <arg name="fileId" type="Data.PublishedFileId">The ID of the file you want to download</arg>⤶ <arg name="progress" type="Action<float>" default="">An optional callback</arg>⤶ <arg name="milisecondsUpdateDelay" type="int" default="60">How often to call the progress function</arg>⤶ <arg name="ct" type="System.Threading.CancellationToken" default="">Allows you to send a message to cancel the download anywhere during the process</arg>⤶ </args> <return type="Task<bool>">true if downloaded and installed correctly</return> <summary>Will attempt to download this item asyncronously - allowing you to instantly react to its installation</summary> </member>