Space Engineers
Classes | Static Public Member Functions | Public Attributes | Properties | List of all members
Sandbox.Engine.Networking.MySteamWorkshop Class Reference

Classes

struct  Category
 
struct  MyWorkshopPathInfo
 
class  PublishItemResult
 
struct  ResultData
 
class  SubscribedItem
 

Static Public Member Functions

static void Init (Category[] modCategories, Category[] worldCategories, Category[] blueprintCategories, Category[] scenarioCategories)
 
static void PublishModAsync (string localModFolder, string publishedTitle, string publishedDescription, ulong publishedFileId, string[] tags, PublishedFileVisibility visibility, Action< bool, Result, ulong > callbackOnFinished=null)
 
static ulong GetWorkshopIdFromLocalMod (string localModFolder)
 
static ulong GetSteamIDOwnerFromLocalMod (string localModFolder)
 
static void PublishWorldAsync (string localWorldFolder, string publishedTitle, string publishedDescription, ulong?publishedFileId, string[] tags, PublishedFileVisibility visibility, Action< bool, Result, ulong > callbackOnFinished=null)
 
static void PublishBlueprintAsync (string localWorldFolder, string publishedTitle, string publishedDescription, ulong?publishedFileId, string[] tags, PublishedFileVisibility visibility, Action< bool, Result, ulong > callbackOnFinished=null)
 
static void PublishScenarioAsync (string localWorldFolder, string publishedTitle, string publishedDescription, ulong?publishedFileId, PublishedFileVisibility visibility, Action< bool, Result, ulong > callbackOnFinished=null)
 
static void PublishIngameScriptAsync (string localWorldFolder, string publishedTitle, string publishedDescription, ulong?publishedFileId, PublishedFileVisibility visibility, Action< bool, Result, ulong > callbackOnFinished=null)
 
static bool GetSubscribedWorldsBlocking (List< SubscribedItem > results)
 Do NOT call this method from update thread. More...
 
static bool GetSubscribedCampaignsBlocking (List< SubscribedItem > results)
 Do NOT call this method from update thread. More...
 
static bool GetSubscribedModsBlocking (List< SubscribedItem > results)
 Do NOT call this method from update thread. More...
 
static bool GetSubscribedScenariosBlocking (List< SubscribedItem > results)
 Do NOT call this method from update thread. More...
 
static bool GetSubscribedBlueprintsBlocking (List< SubscribedItem > results)
 Do NOT call this method from update thread. More...
 
static bool GetSubscribedIngameScriptsBlocking (List< SubscribedItem > results)
 
static bool GetItemsBlocking (List< SubscribedItem > results, IEnumerable< ulong > publishedFileIds)
 
static void DownloadModsAsync (List< MyObjectBuilder_Checkpoint.ModItem > mods, Action< bool, string > onFinishedCallback, Action onCancelledCallback=null)
 
static ResultData DownloadModsBlocking (List< SubscribedItem > mods)
 Do NOT call this method from update thread. More...
 
static bool DownloadBlueprintsBlocking (List< SubscribedItem > mods)
 Do NOT call this method from update thread. More...
 
static bool DownloadScriptBlocking (SubscribedItem item)
 
static bool DownloadBlueprintBlocking (SubscribedItem item, bool check=true)
 
static bool IsBlueprintUpToDate (SubscribedItem item)
 
static bool DownloadModFromURLStream (string url, ulong publishedFileId, Action< bool > callback)
 
static bool DownloadModFromURL (string url, ulong publishedFileId, Action< bool > callback)
 
static ResultData DownloadWorldModsBlocking (List< MyObjectBuilder_Checkpoint.ModItem > mods)
 Do NOT call this method from update thread. More...
 
static bool GenerateModInfo (string modPath, SubscribedItem mod)
 
static bool GenerateModInfo (string modPath, ulong publishedFileId, ulong steamIDOwner)
 
static void CreateWorldInstanceAsync (SubscribedItem world, MyWorkshopPathInfo pathInfo, bool overwrite, Action< bool, string > callbackOnFinished=null)
 
static bool TryCreateWorldInstanceBlocking (SubscribedItem world, MyWorkshopPathInfo pathInfo, out string sessionPath, bool overwrite)
 Do NOT call this method from update thread. More...
 
static bool TryCreateBattleWorldInstanceBlocking (SubscribedItem world, string workshopBattleWorldsPath, out string sessionPath)
 Do NOT call this method from update thread. More...
 
static bool CheckLocalModsAllowed (List< MyObjectBuilder_Checkpoint.ModItem > mods, bool allowLocalMods)
 
static bool CanRunOffline (List< MyObjectBuilder_Checkpoint.ModItem > mods)
 

Public Attributes

const string WORKSHOP_DEVELOPMENT_TAG = "development"
 Do NOT change this value, as it would break worlds published to workshop!!! Tag for workshop items which contain world data. More...
 
const string WORKSHOP_WORLD_TAG = "world"
 
const string WORKSHOP_CAMPAIGN_TAG = "campaign"
 
const string WORKSHOP_MOD_TAG = "mod"
 
const string WORKSHOP_BLUEPRINT_TAG = "blueprint"
 
const string WORKSHOP_SCENARIO_TAG = "scenario"
 

Properties

static Category[] ModCategories [get]
 
static Category[] WorldCategories [get]
 
static Category[] BlueprintCategories [get]
 
static Category[] ScenarioCategories [get]
 

Detailed Description

Definition at line 30 of file MySteamWorkshop.cs.

Member Function Documentation

static bool Sandbox.Engine.Networking.MySteamWorkshop.CanRunOffline ( List< MyObjectBuilder_Checkpoint.ModItem >  mods)
inlinestatic

Definition at line 1864 of file MySteamWorkshop.cs.

static bool Sandbox.Engine.Networking.MySteamWorkshop.CheckLocalModsAllowed ( List< MyObjectBuilder_Checkpoint.ModItem >  mods,
bool  allowLocalMods 
)
inlinestatic

Definition at line 1852 of file MySteamWorkshop.cs.

static void Sandbox.Engine.Networking.MySteamWorkshop.CreateWorldInstanceAsync ( SubscribedItem  world,
MyWorkshopPathInfo  pathInfo,
bool  overwrite,
Action< bool, string >  callbackOnFinished = null 
)
inlinestatic

Definition at line 1692 of file MySteamWorkshop.cs.

static bool Sandbox.Engine.Networking.MySteamWorkshop.DownloadBlueprintBlocking ( SubscribedItem  item,
bool  check = true 
)
inlinestatic

Definition at line 1182 of file MySteamWorkshop.cs.

static bool Sandbox.Engine.Networking.MySteamWorkshop.DownloadBlueprintsBlocking ( List< SubscribedItem >  mods)
inlinestatic

Do NOT call this method from update thread.

Definition at line 1131 of file MySteamWorkshop.cs.

static bool Sandbox.Engine.Networking.MySteamWorkshop.DownloadModFromURL ( string  url,
ulong  publishedFileId,
Action< bool >  callback 
)
inlinestatic

Definition at line 1271 of file MySteamWorkshop.cs.

static bool Sandbox.Engine.Networking.MySteamWorkshop.DownloadModFromURLStream ( string  url,
ulong  publishedFileId,
Action< bool >  callback 
)
inlinestatic

Definition at line 1216 of file MySteamWorkshop.cs.

static void Sandbox.Engine.Networking.MySteamWorkshop.DownloadModsAsync ( List< MyObjectBuilder_Checkpoint.ModItem >  mods,
Action< bool, string >  onFinishedCallback,
Action  onCancelledCallback = null 
)
inlinestatic

Definition at line 953 of file MySteamWorkshop.cs.

static ResultData Sandbox.Engine.Networking.MySteamWorkshop.DownloadModsBlocking ( List< SubscribedItem >  mods)
inlinestatic

Do NOT call this method from update thread.

Definition at line 1031 of file MySteamWorkshop.cs.

static bool Sandbox.Engine.Networking.MySteamWorkshop.DownloadScriptBlocking ( SubscribedItem  item)
inlinestatic

Definition at line 1158 of file MySteamWorkshop.cs.

static ResultData Sandbox.Engine.Networking.MySteamWorkshop.DownloadWorldModsBlocking ( List< MyObjectBuilder_Checkpoint.ModItem >  mods)
inlinestatic

Do NOT call this method from update thread.

Definition at line 1326 of file MySteamWorkshop.cs.

static bool Sandbox.Engine.Networking.MySteamWorkshop.GenerateModInfo ( string  modPath,
SubscribedItem  mod 
)
inlinestatic

Definition at line 1670 of file MySteamWorkshop.cs.

static bool Sandbox.Engine.Networking.MySteamWorkshop.GenerateModInfo ( string  modPath,
ulong  publishedFileId,
ulong  steamIDOwner 
)
inlinestatic

Definition at line 1675 of file MySteamWorkshop.cs.

static bool Sandbox.Engine.Networking.MySteamWorkshop.GetItemsBlocking ( List< SubscribedItem >  results,
IEnumerable< ulong >  publishedFileIds 
)
inlinestatic

Definition at line 620 of file MySteamWorkshop.cs.

static ulong Sandbox.Engine.Networking.MySteamWorkshop.GetSteamIDOwnerFromLocalMod ( string  localModFolder)
inlinestatic

Definition at line 170 of file MySteamWorkshop.cs.

static bool Sandbox.Engine.Networking.MySteamWorkshop.GetSubscribedBlueprintsBlocking ( List< SubscribedItem >  results)
inlinestatic

Do NOT call this method from update thread.

Definition at line 595 of file MySteamWorkshop.cs.

static bool Sandbox.Engine.Networking.MySteamWorkshop.GetSubscribedCampaignsBlocking ( List< SubscribedItem >  results)
inlinestatic

Do NOT call this method from update thread.

Definition at line 546 of file MySteamWorkshop.cs.

static bool Sandbox.Engine.Networking.MySteamWorkshop.GetSubscribedIngameScriptsBlocking ( List< SubscribedItem >  results)
inlinestatic

Definition at line 608 of file MySteamWorkshop.cs.

static bool Sandbox.Engine.Networking.MySteamWorkshop.GetSubscribedModsBlocking ( List< SubscribedItem >  results)
inlinestatic

Do NOT call this method from update thread.

Definition at line 562 of file MySteamWorkshop.cs.

static bool Sandbox.Engine.Networking.MySteamWorkshop.GetSubscribedScenariosBlocking ( List< SubscribedItem >  results)
inlinestatic

Do NOT call this method from update thread.

Definition at line 579 of file MySteamWorkshop.cs.

static bool Sandbox.Engine.Networking.MySteamWorkshop.GetSubscribedWorldsBlocking ( List< SubscribedItem >  results)
inlinestatic

Do NOT call this method from update thread.

Definition at line 530 of file MySteamWorkshop.cs.

static ulong Sandbox.Engine.Networking.MySteamWorkshop.GetWorkshopIdFromLocalMod ( string  localModFolder)
inlinestatic

Definition at line 161 of file MySteamWorkshop.cs.

static void Sandbox.Engine.Networking.MySteamWorkshop.Init ( Category[]  modCategories,
Category[]  worldCategories,
Category[]  blueprintCategories,
Category[]  scenarioCategories 
)
inlinestatic

Definition at line 125 of file MySteamWorkshop.cs.

static bool Sandbox.Engine.Networking.MySteamWorkshop.IsBlueprintUpToDate ( SubscribedItem  item)
inlinestatic

Definition at line 1203 of file MySteamWorkshop.cs.

static void Sandbox.Engine.Networking.MySteamWorkshop.PublishBlueprintAsync ( string  localWorldFolder,
string  publishedTitle,
string  publishedDescription,
ulong?  publishedFileId,
string[]  tags,
PublishedFileVisibility  visibility,
Action< bool, Result, ulong >  callbackOnFinished = null 
)
inlinestatic

Definition at line 200 of file MySteamWorkshop.cs.

static void Sandbox.Engine.Networking.MySteamWorkshop.PublishIngameScriptAsync ( string  localWorldFolder,
string  publishedTitle,
string  publishedDescription,
ulong?  publishedFileId,
PublishedFileVisibility  visibility,
Action< bool, Result, ulong >  callbackOnFinished = null 
)
inlinestatic

Definition at line 242 of file MySteamWorkshop.cs.

static void Sandbox.Engine.Networking.MySteamWorkshop.PublishModAsync ( string  localModFolder,
string  publishedTitle,
string  publishedDescription,
ulong  publishedFileId,
string[]  tags,
PublishedFileVisibility  visibility,
Action< bool, Result, ulong >  callbackOnFinished = null 
)
inlinestatic

Definition at line 140 of file MySteamWorkshop.cs.

static void Sandbox.Engine.Networking.MySteamWorkshop.PublishScenarioAsync ( string  localWorldFolder,
string  publishedTitle,
string  publishedDescription,
ulong?  publishedFileId,
PublishedFileVisibility  visibility,
Action< bool, Result, ulong >  callbackOnFinished = null 
)
inlinestatic

Definition at line 221 of file MySteamWorkshop.cs.

static void Sandbox.Engine.Networking.MySteamWorkshop.PublishWorldAsync ( string  localWorldFolder,
string  publishedTitle,
string  publishedDescription,
ulong?  publishedFileId,
string[]  tags,
PublishedFileVisibility  visibility,
Action< bool, Result, ulong >  callbackOnFinished = null 
)
inlinestatic

Definition at line 179 of file MySteamWorkshop.cs.

static bool Sandbox.Engine.Networking.MySteamWorkshop.TryCreateBattleWorldInstanceBlocking ( SubscribedItem  world,
string  workshopBattleWorldsPath,
out string  sessionPath 
)
inlinestatic

Do NOT call this method from update thread.

Definition at line 1764 of file MySteamWorkshop.cs.

static bool Sandbox.Engine.Networking.MySteamWorkshop.TryCreateWorldInstanceBlocking ( SubscribedItem  world,
MyWorkshopPathInfo  pathInfo,
out string  sessionPath,
bool  overwrite 
)
inlinestatic

Do NOT call this method from update thread.

Definition at line 1715 of file MySteamWorkshop.cs.

Member Data Documentation

const string Sandbox.Engine.Networking.MySteamWorkshop.WORKSHOP_BLUEPRINT_TAG = "blueprint"

Definition at line 119 of file MySteamWorkshop.cs.

const string Sandbox.Engine.Networking.MySteamWorkshop.WORKSHOP_CAMPAIGN_TAG = "campaign"

Definition at line 117 of file MySteamWorkshop.cs.

const string Sandbox.Engine.Networking.MySteamWorkshop.WORKSHOP_DEVELOPMENT_TAG = "development"

Do NOT change this value, as it would break worlds published to workshop!!! Tag for workshop items which contain world data.

Definition at line 115 of file MySteamWorkshop.cs.

const string Sandbox.Engine.Networking.MySteamWorkshop.WORKSHOP_MOD_TAG = "mod"

Definition at line 118 of file MySteamWorkshop.cs.

const string Sandbox.Engine.Networking.MySteamWorkshop.WORKSHOP_SCENARIO_TAG = "scenario"

Definition at line 120 of file MySteamWorkshop.cs.

const string Sandbox.Engine.Networking.MySteamWorkshop.WORKSHOP_WORLD_TAG = "world"

Definition at line 116 of file MySteamWorkshop.cs.

Property Documentation

Category [] Sandbox.Engine.Networking.MySteamWorkshop.BlueprintCategories
staticget

Definition at line 108 of file MySteamWorkshop.cs.

Category [] Sandbox.Engine.Networking.MySteamWorkshop.ModCategories
staticget

Definition at line 106 of file MySteamWorkshop.cs.

Category [] Sandbox.Engine.Networking.MySteamWorkshop.ScenarioCategories
staticget

Definition at line 109 of file MySteamWorkshop.cs.

Category [] Sandbox.Engine.Networking.MySteamWorkshop.WorldCategories
staticget

Definition at line 107 of file MySteamWorkshop.cs.

The documentation for this class was generated from the following file:
Generated on Mon Jan 23 2017 01:17:22 for Space Engineers by   doxygen 1.8.8