Version: 2023.2
言語: 日本語

VersionControlObject

class in UnityEditor.VersionControl

/

継承:ScriptableObject

マニュアルに切り替える

説明

The abstract base class for representing a version control system.

You can add support for a custom VCS by creating a new class derived from VersionControlObject and applying the VersionControlAttribute.

using UnityEditor.VersionControl;
using UnityEngine;

[VersionControl("Custom")] public class CustomVersionControlObject : VersionControlObject { public override void OnActivate() { Debug.Log("Custom VCS activated."); }

public override void OnDeactivate() { Debug.Log("Custom VCS deactivated."); } }

Using the example above, a new VCS option called Custom will show up in Version Control settings window. You should only perform VCS operations when a VersionControlObject is activated. OnActivate and OnDeactivate methods are called on your class to notify your code about the change.

Any persistent settings that must survive between Unity sessions (for example, the username or password) must be handled either by the underlying VCS, by using EditorUserSettings, or stored in a file. This is because the VersionControlObject is not serialized to disk and a new instance is created every time Unity starts up or when the VCS is activated.

The VersionControlObject is derived from ScriptableObject. This makes domain reloading handling simpler. You can add OnEnable method to restore the state if needed.

You can use AssetModificationProcessor and AssetPostprocessor.OnPostprocessAllAssets to get notifications from Unity when it wants to edit, add or remove assets.

Additional resources: VersionControlAttribute, VersionControlManager, EditorUserSettings, ScriptableObject, AssetModificationProcessor, AssetPostprocessor.

変数

isConnectedTests whether the VersionControlObject is connected to an underlying version control system.

Public 関数

GetExtensionGets optional extension object.
OnActivateCalled when your version control system is activated.
OnDeactivateCalled when your version control system is deactivated.
RefreshCalled when the cached state should be discarded and the new state should be retrieved from the underlying VCS.

継承メンバー

変数

hideFlagsShould the object be hidden, saved with the Scene or modifiable by the user?
nameオブジェクト名

Public 関数

GetInstanceIDGets the instance ID of the object.
ToStringReturns the name of the object.

Static 関数

DestroyRemoves a GameObject, component or asset.
DestroyImmediateDestroys the object obj immediately. You are strongly recommended to use Destroy instead.
DontDestroyOnLoadDo not destroy the target Object when loading a new Scene.
FindAnyObjectByTypeRetrieves any active loaded object of Type type.
FindFirstObjectByTypeRetrieves the first active loaded object of Type type.
FindObjectsByTypeRetrieves a list of all loaded objects of Type type.
Instantiateoriginal のオブジェクトをクローンします
CreateInstanceScriptableObject のインスタンスを作成します。

Operator

boolオブジェクトが存在するかどうか
operator !=二つのオブジェクトが異なるオブジェクトを参照しているか比較します
operator ==2つのオブジェクト参照が同じオブジェクトを参照しているか比較します。

メッセージ

Awake ScriptableObject スクリプトを開始するとき、この関数は呼び出されます。
OnDestroyScriptableObject が破棄されるとき、この関数は呼び出されます。
OnDisableScriptableObject クラスのオブジェクトがスコープを外れるとき、この関数は呼び出されます。
OnEnableオブジェクトがロードされたとき、この関数は呼び出されます。
OnValidateEditor-only function that Unity calls when the script is loaded or a value changes in the Inspector.
Resetデフォルト値にリセットします