Version: 2020.1

Provider

class in UnityEditor.VersionControl

マニュアルに切り替える

説明

This class provides access to the version control API.

Note that the Version Control window is refreshed after every version control operation. This means that looping through multiple assets and doing an individual operation on each (i.e. Checkout) will be slower than passing an AssetList containing all of the assets and performing a version control operation on it once.

using System.Collections.Generic;
using UnityEditor;
using UnityEditor.VersionControl;
using UnityEngine;

public class EditorScript : MonoBehaviour { [MenuItem("VC/Checkout")] public static void TestCheckout() { AssetList assets = new AssetList(); assets.Add(new Asset("Assets/"));

Task t = Provider.Checkout(assets, CheckoutMode.Both); t.Wait(); } }

Also note that Provider operations just execute the VCS commands, and do not automatically refresh the Version Control window. To update this window, use Task.SetCompletionAction.

using System.Collections.Generic;
using UnityEditor;
using UnityEditor.VersionControl;
using UnityEngine;

public class EditorScript : MonoBehaviour { [MenuItem("VC/ChangeSetMove")] static void ChangeSetMove() { AssetList assets = new AssetList(); assets.Add(Provider.GetAssetByPath("Assets/testMaterial.mat")); Task task = Provider.ChangeSetMove(assets, "ChangeSetID"); task.SetCompletionAction(CompletionAction.UpdatePendingWindow); } }

Static 変数

activeTask現在実行中のタスクを取得します。
enabledバージョン管理プロバイダーが有効であり、有効な Unity Pro ライセンスがあった場合、 True を返します。
isActiveバージョン管理プラグインが選択され、正しく構成されている場合、 True を返します。
offlineReasonバージョン管理プロバイダーがオフラインになっている理由を返します (オフラインの場合) 。
onlineStateバージョン管理プロバイダーの OnlineState を返します。
preCheckoutCallbackUser-supplied callback to be called before Version Control check out operation.
preSubmitCallbackUser-supplied callback to be called before Version Control Submit operation.
requiresNetwork現在選択されているバージョン管理プラグインがなにかを実行するためにネットワーク接続が必要な場合、これは True です。

Static 関数

AddAllows you to add files to version control via script.
AddIsValidGiven a list of assets this function returns true if Provider.Add is a valid task to perform on at least one of the assets in the list.
ChangeSetDescriptionチェンジセット ID のみを含むチェンジセットを与えると、チェンジセットの説明をクエリするタスクを開始します。
ChangeSetMoveMove an Asset or a list of Assets from their current changeset to a new changeset.
ChangeSetsGets a list of pending changesets owned by the current user.
ChangeSetStatusRetrieves a list of assets belonging to a changeset.
CheckoutCheckout an asset or a list of assets from the version control system.
CheckoutIsValidGiven an asset or a list of assets this function returns true if Provider.Checkout is a valid task to perform on at least one of the given assets.
ClearCacheすべてのアセットのキャッシュされていたステート情報は無効になります。
DeleteStarts a task to delete an Asset or a list of Assets from the disk and from the version control system.
DeleteChangeSetsStarts a task that will attempt to delete the given changesets.
DeleteChangeSetsIsValidTests if deleting the given changesets is a valid task to perform.
DiffHead指定したアセットとそれらの Head リビジョンとの差分を表示するタスクを開始します。
DiffIsValidReturns true if starting a Diff task is a valid operation for at least one asset in the given AssetList.
GetActiveConfigFields現在のアクティブなバージョン管理プラグインの Configuration フィールドを返します。
GetActivePluginGets the current, user selected verson control Plugin.
GetAssetByGUIDReturns version control information about an asset from a given GUID.
GetAssetByPathReturns the version control information about an asset. Can be used with "AssetList.Add" to add assets to a list for further version control actions.
GetAssetListFromSelectionReturns the version control information about the currently selected Assets.
GetLatestStart a task for getting the latest version of an out of sync asset from the version control server.
GetLatestIsValidThe task tests the given asset list and returns true if Provider.GetLatest is valid operation for one or more assets.
IncomingStarts a task that queries the version control server for incoming changes.
IncomingChangeSetAssetsIncoming チェンジセットを与えると、アセットがチェンジセットの一部であるバージョン管理サーバーの照会を実行するタスクが開始されます。
IsOpenForEditアセットを編集できる場合、 True を返します。
Lock排他的な編集のためにアセットをロックすることを試します。
LockIsValidReturns true if the Provider.Lock task can be executed on one or more assets from the given asset list.
MergeInitiates a merge task to handle the merging of conflicting Assets. This invokes a merge tool, which you can set in the External Tools section of the Preferences window, on the conflicting Assets. When the merge task finishes, the AssetList only contains the Assets that the tool could merge.
Moveバージョン管理プラグインを使用して、アセットをひとつのパスから別のに移動します。
ResolveStarts a task that will resolve the conflicting assets in version control.
ResolveIsValidTests if any of the assets in the list have the conflicted state and can be resolved.
RevertReverts the specified assets by undoing any changes done since the last time you synced.
RevertIsValidReturns true if Provider.Revert is a valid task to perform on at least one of the given assets in the list.
StatusStarts a task that will fetch the most recent status about the asset or assets from the revision control system.
SubmitStarts a task that submits the assets to version control.
SubmitIsValidアセットを送信するのが有効な操作の場合、True を返します。
UnlockIsValidReturns true if unlocking the assets is a valid operation.
UpdateSettingsStarts a task that sends the version control settings to the version control system.

デリゲート

PreCheckoutCallbackDelegate for a user-supplied callback to be called before Version Control Checkout.
PreSubmitCallbackDelegate for a user-supplied callback to be called before Version Control Submit.