Added Unity project files
This commit is contained in:
@ -0,0 +1,120 @@
|
||||
using System.Threading;
|
||||
using System.Threading.Tasks;
|
||||
using JetBrains.Annotations;
|
||||
using UnityEngine;
|
||||
using VRC.SDKBase.Editor;
|
||||
using VRC.SDKBase.Editor.Api;
|
||||
|
||||
namespace VRC.SDK3.Editor
|
||||
{
|
||||
/// <summary>
|
||||
/// This is the public interface you can use to interact with the Worlds SDK Builder
|
||||
/// </summary>
|
||||
public interface IVRCSdkWorldBuilderApi : IVRCSdkBuilderApi
|
||||
{
|
||||
/// <summary>
|
||||
/// Builds the currently open scene and returns a path to the built world bundle.
|
||||
/// Make sure the world has a valid SceneDescriptor and PipelineManager components present.
|
||||
/// </summary>
|
||||
/// <returns>Path to the bundle</returns>
|
||||
/// <exception cref="BuilderException">Build process has encountered an error</exception>
|
||||
/// <exception cref="BuildBlockedException">Build was blocked by the SDK Callback</exception>
|
||||
/// <exception cref="ValidationException">Content has validation errors</exception>
|
||||
[PublicAPI]
|
||||
Task<string> Build();
|
||||
|
||||
/// <summary>
|
||||
/// Builds the currently open scene and returns a path + signature of the newly built bundle.
|
||||
/// Make sure the world has a valid SceneDescriptor and PipelineManager components present.
|
||||
/// </summary>
|
||||
/// <returns>Tuple containing the path to the bundle and its signature</returns>
|
||||
/// <exception cref="BuilderException">Build process has encountered an error</exception>
|
||||
/// <exception cref="BuildBlockedException">Build was blocked by the SDK Callback</exception>
|
||||
/// <exception cref="ValidationException">Content has validation errors</exception>
|
||||
[PublicAPI]
|
||||
Task<(string path, string signature)> BuildWithSignature();
|
||||
|
||||
/// <summary>
|
||||
/// Builds and uploads the currently open scene for the VRCWorld specified.
|
||||
/// Make sure the world has a valid SceneDescriptor and PipelineManager components present
|
||||
/// </summary>
|
||||
/// <param name="world">VRCWorld object with world info. Must have a Name for world creation</param>
|
||||
/// <param name="thumbnailPath">Path to the thumbnail image on disk. Must be specified for world creation</param>
|
||||
/// <param name="cancellationToken"></param>
|
||||
/// <exception cref="BuilderException">Build process has encountered an error</exception>
|
||||
/// <exception cref="BuildBlockedException">Build was blocked by the SDK Callback</exception>
|
||||
/// <exception cref="ValidationException">Content has validation errors</exception>
|
||||
/// <exception cref="OwnershipException">Current User does not own the target content</exception>
|
||||
/// <exception cref="UploadException">Content failed to upload</exception>
|
||||
/// <exception cref="BundleExistsException">This exact bundle was already uploaded</exception>
|
||||
[PublicAPI]
|
||||
Task BuildAndUpload(VRCWorld world, string thumbnailPath = null, CancellationToken cancellationToken = default);
|
||||
|
||||
/// <summary>
|
||||
/// Builds and uploads the currently open scene for the VRCWorld specified.
|
||||
/// Make sure the world has a valid SceneDescriptor and PipelineManager components present
|
||||
/// </summary>
|
||||
/// <param name="world">VRCWorld object with world info. Must have a Name for world creation</param>
|
||||
/// <param name="signature">Bundle signature provided by the SDK</param>
|
||||
/// <param name="thumbnailPath">Path to the thumbnail image on disk. Must be specified for world creation</param>
|
||||
/// <param name="cancellationToken"></param>
|
||||
/// <exception cref="BuilderException">Build process has encountered an error</exception>
|
||||
/// <exception cref="BuildBlockedException">Build was blocked by the SDK Callback</exception>
|
||||
/// <exception cref="ValidationException">Content has validation errors</exception>
|
||||
/// <exception cref="OwnershipException">Current User does not own the target content</exception>
|
||||
/// <exception cref="UploadException">Content failed to upload</exception>
|
||||
/// /// <exception cref="BundleExistsException">This exact bundle was already uploaded</exception>
|
||||
[PublicAPI]
|
||||
Task BuildAndUpload(VRCWorld world, string signature, string thumbnailPath = null,
|
||||
CancellationToken cancellationToken = default);
|
||||
|
||||
/// <summary>
|
||||
/// Starts a multi-platform build chain for the currently open scene
|
||||
/// This will automatically switch the editor to each of the supported platforms and perform a build+upload
|
||||
/// If any of the platforms encounter an error, the build chain will be stopped and the error will be thrown similar to BuildAndUpload
|
||||
/// </summary>
|
||||
/// <param name="world">VRCWorld object with world info. Must have a Name for world creation</param>
|
||||
/// <param name="thumbnailPath">Path to the thumbnail image on disk. Must be specified for world creation</param>
|
||||
/// <param name="cancellationToken"></param>
|
||||
/// <exception cref="BuilderException">Build process has encountered an error</exception>
|
||||
/// <exception cref="BuildBlockedException">Build was blocked by the SDK Callback</exception>
|
||||
/// <exception cref="ValidationException">Content has validation errors</exception>
|
||||
/// <exception cref="OwnershipException">Current User does not own the target content</exception>
|
||||
/// <exception cref="UploadException">Content failed to upload</exception>
|
||||
/// <exception cref="BundleExistsException">This exact bundle was already uploaded</exception>
|
||||
[PublicAPI]
|
||||
Task BuildAndUploadMultiPlatform(VRCWorld world, string thumbnailPath = null,
|
||||
CancellationToken cancellationToken = default);
|
||||
|
||||
/// <summary>
|
||||
/// Builds the currently open scene and launches / reloads a test client
|
||||
/// </summary>
|
||||
/// <exception cref="BuilderException">Build process has encountered an error</exception>
|
||||
/// <exception cref="BuildBlockedException">Build was blocked by the SDK Callback</exception>
|
||||
/// <exception cref="ValidationException">Content has validation errors</exception>
|
||||
[PublicAPI]
|
||||
Task BuildAndTest();
|
||||
|
||||
/// <summary>
|
||||
/// Reopens / reloads the test clients with the last built world
|
||||
/// </summary>
|
||||
/// <exception cref="BuilderException">Build process has encountered an error</exception>
|
||||
/// <exception cref="BuildBlockedException">Build was blocked by the SDK Callback</exception>
|
||||
/// <exception cref="ValidationException">Content has validation errors</exception>
|
||||
[PublicAPI]
|
||||
Task TestLastBuild();
|
||||
|
||||
/// <summary>
|
||||
/// Uploads the last built world for the VRCWorld specified
|
||||
/// </summary>
|
||||
/// <param name="world">VRCWorld object with world info. Must have a Name for world creation</param>
|
||||
/// <param name="thumbnailPath">Path to the thumbnail image on disk. Must be specified for world creation</param>
|
||||
/// <param name="cancellationToken"></param>
|
||||
/// <exception cref="OwnershipException">Current User does not own the target content</exception>
|
||||
/// <exception cref="UploadException">Content failed to upload</exception>
|
||||
/// <exception cref="BundleExistsException">This exact bundle was already uploaded</exception>
|
||||
[PublicAPI]
|
||||
Task UploadLastBuild(VRCWorld world, string thumbnailPath = null,
|
||||
CancellationToken cancellationToken = default);
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,3 @@
|
||||
fileFormatVersion: 2
|
||||
guid: dd8923a5088f4aa89bcd97d8cdab1dbe
|
||||
timeCreated: 1687987621
|
||||
Reference in New Issue
Block a user