====== コンソール ======
[[vci/top|VCI]]スクリプトの動作を確認する**コンソール**の説明です。\\
主にVCI制作におけるデバッグやVCIの動作状況の確認に使用します。\\
コンソールの表示方法から各種説明まで記載します。

===== 表示方法 =====
表示方法は**VR空間内から設定する**方法と**タイトル画面から設定する**方法があります。
==== 方法1：VR空間内から設定する ====
VR空間内に移動し、メニューから順に開きます。
  * **スタジオ**　：　''システム > VCIデバッグ''
  * **ルーム**　　：　''システム > 開発者向け > VCIデバッグ''


==== 方法2：タイトル画面から設定する[Steam版のみ] ====
タイトル画面から設定を開いて **[ VCI ] ** のタブを選択し、\\
**[ VR空間内にデバッグ情報を表示する ]** を有効にします。

{{ :vci:script:vci_settings.png?direct&600 }}


===== 機能 =====
コンソールには **SystemConsole**(システムコンソール) と **ItemConsole**(アイテムコンソール)、\\
また2つのコンソールに付随する形で **[[virtualcast/room/ringmenu/system/traffic_limit|VCINetworkPanel]]** があります。

==== 全コンソール共通の機能 ====
  * バーチャルキャスト内にデバッグコンソールが生成される
  * コンソール画面は自分にだけ表示され、ほかの人からは見えない
  * 通常のアイテムと同様に、つかんで動かしたり両手で持って拡縮することは可能

<WRAP group>
==== SystemConsole(システムコンソール) ====
<WRAP half column>

  * 主にVCIスクリプトのSystemメッセージが表示される  
  * スレッドが停止したり、応答が無い場合など
  * [[https://developer.virtualcast.jp/vci-docs/api/classes/ExportShared/index.html|グローバル同期変数]]を使用した場合に、内容がjsonで表示される(( 1.9.2d以降、SharedVariableConsoleと統合されました。 ))
  * 現在のフレームレート、メモリ使用量が表示される
</WRAP>

<WRAP half column>
{{ :vci:script:system_console.png?direct }}
</WRAP>
</WRAP>


<WRAP group>
==== ItemConsole(アイテムコンソール) ====
<WRAP half column>

  * アイテム個別のコンソール
  * アイテムの出現時に生成され、アイテムを消すと一緒に消える
  * 何度かつかむことで、以下の表示内容に切り替えるができる
    * **Console**
    * **SubItem一覧**
    * **Material一覧**
    * **Animation一覧**
    * **Audio一覧**
    * **Statistics(統計情報)**


</WRAP>

<WRAP half column>
{{ :vci:script:item_console.jpg?direct }}
</WRAP>
</WRAP>
=== Statisticsの表示項目 ===

^ 名前 ^ 説明 ^ VCバージョン ^
| ActionCountPerSec | 1秒あたりの、SetPosition等の操作回数 | 1.9.2d |
| ActionCountPerSec (ALL) | 1秒あたりの、SetPosition等の操作回数(_All_系関数) | 1.9.2d |
| LuaProcessingTimePerFrame (ms)| 1フレームあたりのluaコード処理時間(ミリ秒) | 1.9.2d |

Statisticsで表示される項目は、値が低いほど動作が軽くなるので、VCIの動作が重い場合は、こちらの情報を参考に最適化してください。

=== コンソールに文字列を表示する ===

  * VCIスクリプト内で以下のようなコード（print文）を記述するとコンソールに文字列が表示されます。
<file lua main.lua>
print("文字列")
</file>

==== その他のデバッグ機能(上級者向け) ====
VCIの設定画面で、[VCIスクリプトのロガーをホストするTCPポート番号]、[VCIスクリプトのデバッガーのTCPポート番号]に0より大きい値のポート番号を指定し、スタジオ内に入室した状態でWebブラウザから[localhost:ポート番号]にアクセスすることで、VCIアイテムのデバッグ情報を見ることができます。

<wrap notice right>⇒ [[https://developer.virtualcast.jp/vci-docs/manual/scripting/web_console.html|Webコンソール]]</wrap>\\

<wrap notice right>⇒ [[tips/faq/use_port]]</wrap>\\

===== スクリプトを確認する例 =====
以下サンプルスクリプトを使用して、バーチャルキャスト内でコンソールを確認してみましょう。

<WRAP center round box 95%>

**1. 下記サンプルをVCIフォルダ内の[main.lua]にコピー＆ペーストして保存してください。**

<file lua main.lua>
GrabCount = 0
function onGrab(target)
    GrabCount = GrabCount + 1
    print("Grab : "..GrabCount)
    print(target)
end
</file>

</WRAP>

<WRAP center round box 95%>
**2. バーチャルキャストの中でつかんだ時に、コンソールに、つかんだ回数が表示されたら成功です。**
{{ vci:vci_sampledebug.png?direct&400 }}
</WRAP>



※VCIスクリプトの詳細は [[https://developer.virtualcast.jp/vci-docs/api/index.html|VCIスクリプトリファレンス]] を参考にしてください。