s&box docs
API ReferenceEditor

ProjectPublisherclass

object→ProjectPublisher
Namespace
Editor
Assembly
Sandbox.Tools
Declaration
public class Editor.ProjectPublisher

Methods12

Showing 12 methods

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.

ParameterTypeDescription
packagestring—
Returns:Task—

public static bool CanPublishFile(Editor.Asset a)PUBLICSTATIC

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

ParameterTypeDescription
aAsset—
Returns:bool—

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

ParameterTypeDescription
assembliesCompilerOutput[]—
Returns:List<GameSetting>—

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.

ParameterTypeDescription
cancellationToken = nullCancellationToken—
Returns:Task—

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

Publish a new revision

ParameterTypeDescription
progress = nullIProgress—
cancel = nullCancellationToken—
Returns:Task—

public void SetChangeDetails(string change, string detail)PUBLIC

Allows to set information on the revision - for future reference

ParameterTypeDescription
changestring—
detailstring—
Returns:void—

public void SetMeta(string key, object obj)PUBLIC

ParameterTypeDescription
keystring—
objobject—
Returns:void—

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

Returns:Task—

Properties7

Showing 7 properties

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

Returns:int—

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

Returns:long—

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

Returns:Action—

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

Returns:string—

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

Returns:int—

TryAddFromFile()

Previous Page

Files

Next Page

On this page

Methodspublic System.Threading.Tasks.Task AddCodePackageReference(System.String package)public System.Threading.Tasks.Task AddFile(System.Byte[] contents, System.String relativePath)public System.Threading.Tasks.Task AddFile(System.String contents, System.String relativePath)public static System.Boolean CanPublishFile(Editor.Asset a)public static System.Threading.Tasks.Task`1<Editor.ProjectPublisher> FromAsset(Editor.Asset asset)public static System.Threading.Tasks.Task`1<Editor.ProjectPublisher> FromProject(Sandbox.Project project)public System.Collections.Generic.List`1<Sandbox.DataModel.GameSetting> GetGameSettings(Sandbox.CompilerOutput[] assemblies)public System.Threading.Tasks.Task PrePublish(System.Threading.CancellationToken cancellationToken = null)public System.Threading.Tasks.Task Publish(Editor.IProgress progress = null, System.Threading.CancellationToken cancel = null)public System.Void SetChangeDetails(System.String change, System.String detail)public System.Void SetMeta(System.String key, System.Object obj)public System.Threading.Tasks.Task UploadFiles()Propertiespublic System.Collections.Generic.IEnumerable`1<Editor.ProjectPublisher.ProjectFile> Editor.ProjectPublisher.Files { get; set; }public Editor.ProjectPublisher.PackageManifest Editor.ProjectPublisher.Manifest { get; set; }public System.Int32 Editor.ProjectPublisher.MissingFileCount { get; set; }public System.Int64 Editor.ProjectPublisher.MissingFileSize { get; set; }public System.Action Editor.ProjectPublisher.OnProgressChanged { get; set; }public System.String Editor.ProjectPublisher.TargetPackageIdent { get; set; }public System.Int32 Editor.ProjectPublisher.TotalFileCount { get; set; }Metadata