Garry's Mod Wiki

Revision Difference

resource.AddWorkshop#512931

<function name="AddWorkshop" parent="resource" type="libraryfunc"> <description> Adds a workshop addon for the client to download before entering the server. Having the raw files from a workshop item does not count as having already downloaded it.&amp;lt;br&amp;gt; So players who previously downloaded a map through Fast Download will have to re-download it if you use the workshop. You should try to only add addons that have custom content ( models, sounds, etc ). Gamemodes that are [workshop enabled](/gmod/Gamemode_Creation#Gamemode_Text_File) are automatically added to this list - so there's no need to add them. The server's current map is also automatically added, if it is loaded from a workshop addon. <warning>This will not "install" the addon on your server, see <page>Workshop for Dedicated Servers</page> for installing Steam Workshop addons onto your servers</warning> </description> <realm>Server</realm> <file_name>src/garrysmod/Library/gl_resource.cpp</file_name> <file_line>107</file_line> <args> <arg name="workshopid" type="string">The workshop id of the file. This cannot be a collection.</arg> </args> </function> <example> <description> Adds the Achievement Viewer addon (workshop id 104606562). Any clients that join will download this addon if they haven't previously downloaded it from the workshop or from the server (via the workshop). You get the ID from the URL of the workshop addon. For example, here's the URL of the Achievement Viewer addon's page: http://steamcommunity.com/sharedfiles/filedetails/?id=104606562 The ID is 104606562. </description> <code>resource.AddWorkshop( "104606562" )</code> <output>Players joining the server will now be forced to download the Achievement Viewer addon.</output> </example>