EAUploader.Editor.API
EAUploaderの全体、言語、アップロードに関わる公開APIです。
Editor/Public EAUploader API/EAUploader.Editor.API.csで定義されています。
using EAUploader.Editor.API;| Class | Description |
|---|---|
| CoreAPI | EAUploaderの全体に関わる公開APIを提供するクラス |
| LanguageAPI | 言語関連の公開APIを提供するクラス |
| UploadAPI | アップロード関連の公開APIを提供するクラス |
CoreAPI
| Method | Type | Description |
|---|---|---|
| SelectedPrefabPath | String | 現在選択されているプレファブのパスを取得または設定 |
| SelectedPrefabPathChanged | Event | 選択されているプレファブのパスが変更されたときに発生するイベント |
| HasVRM | Bool | EAUploaderでVRMが利用可能か示す値を取得 |
| HasAvatarOptimizer | Bool | Avatar Optimizer パッケージが利用可能か示す値を取得 |
| GetVersion | String | EAUploaderの現在のバージョンを取得します |
| Reload | Void | EAUploaderを再読み込み(Initialize)します |
public static string SelectedPrefabPath { get; set; }public static event Action<string> SelectedPrefabPathChanged;public static bool HasVRM { get; }public static bool HasAvatarOptimizer { get; }public static string GetVersion(bool noText = false);public static void Reload();SelectedPrefabPathは、アバターが選択されていない場合nullです。値を設定すると、SelectedPrefabPathChangedが発生します。GetVersionは、noTextがtrueの場合はバージョン番号のみ(例:1.4.6)、falseの場合は「バージョン: 1.4.6」のように説明テキストを含めた文字列を返します。Reloadは、メニューの「EAUploader」→「Reload」と同じ処理を行います。選択中のプレハブは解除されます。
LanguageAPI
| Method | Type | Description |
|---|---|---|
| GetCurrentLanguage | String | 現在の言語コードを取得 |
| Localize | Void | 指定したVisualElementとその子要素のテキストをローカライズ |
| LocalizeFromJsonFile | Void | 指定したJSONファイルを使用して、指定したVisualElementとその子要素のテキストをローカライズ |
| GetLocalizedTextFromJsonFile | String | 指定したキーに対応するローカライズされたテキストを、指定したJSONファイルから取得 |
| ChangeLanguage | Void | アプリケーションの言語を変更 |
| GetAvailableLanguages | List | 利用可能な言語のリストを取得 |
public static string GetCurrentLanguage();public static void Localize(VisualElement root);public static void LocalizeFromJsonFile(VisualElement root, string localizationFolderPath);public static string GetLocalizedTextFromJsonFile(string key, string localizationFolderPath);public static void ChangeLanguage(string language);public static List<LanguageInfo> GetAvailableLanguages();- 言語コードは
en、ja、koです。 Localizeは、EAUploader本体の翻訳ファイルを使用してローカライズします。拡張機能独自の文字列をローカライズする場合はLocalizeFromJsonFileを使用してください。LocalizeFromJsonFile、GetLocalizedTextFromJsonFileで使用するJSONファイルの形式は「クイックスタートガイダンス」をご覧ください。GetLocalizedTextFromJsonFileは、対応するテキストが見つからない場合はキーをそのまま返します。ChangeLanguageは設定ファイルの言語を変更します。表示を切り替えるには、EAUploaderの再起動が必要です。LanguageInfoはname(言語コード)とdisplay(表示名)を持ちます。
UploadAPI
| Method | Type | Description |
|---|---|---|
| OnUploadComplete | Event | アップロードが完了したときに発生するイベント |
| UploadProgressChanged | Event | アップロードの進行状況が変更されたときに発生するイベント |
| BuildAndTestAsync | Task | 指定したプレハブをビルドしてテストする非同期タスクを実行 |
| GetVRCAvatar | Task | 指定したプレハブのVRCAvatar情報を取得 |
| UploadAvatarAsync | Task | 指定したプレハブをアバターとしてアップロードする非同期タスクを実行 |
| UpdateVRCAvatar | Task | 指定したプレハブのVRCAvatar情報を更新する非同期タスクを実行 |
public static event EventHandler OnUploadComplete;public static event EventHandler<AvatarUploader.ProgressEventArgs> UploadProgressChanged;public static Task BuildAndTestAsync(string prefabPath);public static Task<VRCAvatar?> GetVRCAvatar(string prefabPath);public static Task UploadAvatarAsync(string prefabPath, string contentName, string contentDescription, string releaseStatus, List<string> tags, string thumbnailPath);public static Task UpdateVRCAvatar(string prefabPath, string contentName, string contentDescription, string releaseStatus, List<string> tags, string thumbnailPath);| 引数 | 内容 |
|---|---|
prefabPath | プレハブのパス |
contentName | アバター名 |
contentDescription | アバターの説明 |
releaseStatus | 公開ステータス(private / public) |
tags | タグ(content_sex、content_adult、content_violence、content_gore、content_horrorなど) |
thumbnailPath | サムネイル画像のパス |
UploadProgressChangedのProgressEventArgsは、Status(進行状況の説明)とPercentage(0~1の進捗)を持ちます。GetVRCAvatarは、VRChatにログインしていない場合、プレハブにPipelineManager又はBlueprint IDが無い場合、VRChat上にアバターが見つからない場合はnullを返します。UploadAvatarAsyncは、VRChat上にアバターが無い場合は新規にアップロードし、ある場合はアバターを更新します。UpdateVRCAvatarは、アバターを再ビルドせずに、名前や説明などの情報とサムネイルを更新します。- これらのメソッドを使用するには、VRChat SDKにログインしている必要があります。