ProjectPublisherclass

public System.Threading.Tasks.Task AddCodePackageReference(string package)PUBLIC

If the code is referencing a package - we can add it to the manifest using this.

public static bool CanPublishFile(Editor.Asset a)PUBLICSTATIC

Return true if we're not opposed to publishing this asset

public static Sandbox.Bitmap CropToSquare(Sandbox.Bitmap image)PUBLICSTATIC

The middle of this image, cut square - Steam shows workshop items' main thumbnails square. A new bitmap.

public static System.Threading.Tasks.Task`1<Editor.ProjectPublisher> FromAsset(Editor.Asset asset)PUBLICSTATIC

public static System.Threading.Tasks.Task`1<Editor.ProjectPublisher> FromProject(Sandbox.Project project)PUBLICSTATIC

public System.Collections.Generic.List`1<Sandbox.DataModel.GameSetting> GetGameSettings(Sandbox.CompilerOutput[] assemblies)PUBLIC

Fetch a list of game settings to be added to the project's metadata

public static System.Threading.Tasks.Task`1<Editor.ProjectPublisher.PublishedWorkshopItem[]> GetPublishedWorkshopItemsAsync(string type)PUBLICSTATIC

The workshop items we've published of this type (e.g. "map"), newest first. Empty if Steam couldn't be asked.

public static System.Threading.Tasks.Task`1<ulong> GetWorkshopItemIdAsync(Sandbox.Project project)PUBLICSTATIC

The workshop item a publish of this project goes to unless it's told otherwise - 0 if it isn't a map, or it'll make a new item

public static System.Threading.Tasks.Task`1<Editor.ProjectPublisher.WorkshopItemInfo> GetWorkshopItemInfoAsync(ulong id)PUBLICSTATIC

Ask Steam about a workshop item - not from its cache, it might have just been published

public System.Threading.Tasks.Task PrePublish(System.Threading.CancellationToken cancellationToken = null)PUBLIC

Check the intended manifest, ask the backend which files need to be uploaded.

public System.Threading.Tasks.Task Publish(Editor.IProgress progress = null, System.Threading.CancellationToken cancel = null)PUBLIC

Publish a new revision

public static bool PublishesToWorkshop(Sandbox.Project project)PUBLICSTATIC

Would publishing this project put its files in a Steam Workshop item?

public void SetChangeDetails(string change, string detail)PUBLIC

Allows to set information on the revision - for future reference

public void SetMeta(string key, object obj)PUBLIC

public System.Threading.Tasks.Task SetThumbnail(byte[] image)PUBLIC

Use this image as the package's thumb instead of the one rendered from its asset - the middle of it, cut square (`Editor.ProjectPublisher.CropToSquare(Sandbox.Bitmap)`). Any image a `Sandbox.Bitmap` can read - it goes up as a png. Before `Editor.ProjectPublisher.PrePublish(System.Threading.CancellationToken)`, so it's uploaded.

public void SetWorkshopItem(ulong id)PUBLIC

Put the files in this workshop item, or a new one with 0, rather than the one the package says. Before `Editor.ProjectPublisher.PrePublish(System.Threading.CancellationToken)`.

public System.Threading.Tasks.Task UploadFiles()PUBLIC

public System.Collections.Generic.IEnumerable`1<Editor.ProjectPublisher.ProjectFile> Editor.ProjectPublisher.Files { get; set; }PUBLICGETSET

Get access to the files within the manifest

public bool Editor.ProjectPublisher.HasWorkshopUpload { get; set; }PUBLICGETSET

Does this publish put its files in a Steam Workshop item?

public bool Editor.ProjectPublisher.IsWorkshopUploaded { get; set; }PUBLICGETSET

Have the files gone up to the workshop? A retried publish doesn't upload them again.

public Editor.ProjectPublisher.PackageManifest Editor.ProjectPublisher.Manifest { get; set; }PUBLICGETSET

public int Editor.ProjectPublisher.MissingFileCount { get; set; }PUBLICGETSET

public long Editor.ProjectPublisher.MissingFileSize { get; set; }PUBLICGETSET

public System.Action Editor.ProjectPublisher.OnProgressChanged { get; set; }PUBLICGETSET

public string Editor.ProjectPublisher.TargetPackageIdent { get; set; }PUBLICGETSET

public int Editor.ProjectPublisher.TotalFileCount { get; set; }PUBLICGETSET

public long Editor.ProjectPublisher.WorkshopBytesDone { get; set; }PUBLICGETSET

How far through the current stage of the workshop upload we are, in bytes

public long Editor.ProjectPublisher.WorkshopBytesTotal { get; set; }PUBLICGETSET

The size of the current stage of the workshop upload, in bytes. Steam doesn't know until it's started.

public int Editor.ProjectPublisher.WorkshopFileCount { get; set; }PUBLICGETSET

How many files go in the workshop item

public ulong Editor.ProjectPublisher.WorkshopTargetItemId { get; set; }PUBLICGETSET

The workshop item this publishes to, or 0 if it'll create a new one

public long Editor.ProjectPublisher.WorkshopUploadSize { get; set; }PUBLICGETSET

The size of the files that go in the workshop item, in bytes

public string Editor.ProjectPublisher.WorkshopUploadStatus { get; set; }PUBLICGETSET

What the workshop upload is doing right now, or null if it hasn't started

public string Editor.ProjectPublisher.WorkshopUrl { get; set; }PUBLICGETSET

The workshop item's page on Steam, once there is one

public string Editor.ProjectPublisher.WorkshopWarning { get; set; }PUBLICGETSET

Something whoever's publishing should know about the workshop item first, like that it isn't theirs. Null if there's nothing to say.