はじめに
Vket Cloudでは、「HeliScript」という独自のスクリプトを使用してコーディングを行うことで、ワールド内に高度なギミックを導入することが出来ます。
本記事では、HeliScriptの作成方法、HeliScriptでHello World!をコンソール上に出力する方法を解説します。
Hello World!とは
プログラム言語について学習する際、初めに取り扱う、文字列の出力です。
単純な文字列の出力を通し、基本的なプログラムの書き方やプログラムの動かし方について学習することが出来ます。
慣例的に「Hello World!」やそれに準ずる文字列を出力することが多いです。
これから学習する新しい言語に、まずは「こんにちは！」と伝えてみましょう。
コンソールとは
プログラムで文字を表示する命令を行ったり、プログラムでエラーが発生した時にその内容を表示する場所です。
本記事の後半では、Vket Cloudでのコンソールの場所とコンソールの表示方法について紹介しています。
動画
解説
ここから先、Unity上の操作説明に「ビュー」という言葉が出てきます。
Sceneビュー、Hierarchyビュー、Projectビュー、Inspectorビューについての解説は、用語集 - ビューをご覧ください。
HeliScriptの作成
HeliScriptを作成するためには、VketCloudSDKが導入されたプロジェクトでUnityのProjectビューにある「+」ボタン、あるいはProjectビュー内で右クリックした際に表示されるCreateからHeliScriptを選択することで作成することが出来ます。
新しくファイルが作成され、名称入力を行う画面になります。
今回は、「HeliScriptExample」という名前に設定します。
【注意！】 この際のファイル名が1行目のcomponent名称定義、3行目のコンストラクタ名称に適用されます。
一度名称を確定した後に名称を変更する場合、名称変更前のcomponentが定義された状態となっているため、HeliScriptのファイル名とcomponent名称が異なる状態となります。
この状態でも正常に動かすことは可能ですが、初めのうちはHeliScriptは最初にファイル名を決めたら変更しない、ファイル名を間違えて作成したら一度HeliScriptファイルを削除して作り直すを心掛けると良いでしょう。
これで、HeliScriptを新しく作成することが出来ました。
HeliScriptは .hs という拡張子になります。
前章にてVSCodeの導入を行った場合、ここでHeliScriptをVSCodeで開くようにする作業を行います。
作業手順はこちらを参照してください。
Hello World!を出力するHeliScriptを作成
コンソールに文字を出力するときは、hsSystemWriteLine("(出力したい文字)");とプログラム上に書きます。
hsSystemWriteLine()は、カッコ()の中に記載した、ダブルクォーテーション"で挟んだ文字をコンソールに表示する、HeliScriptの関数(動作を起こす、機能の塊のようなもの)です。
カッコ()はShiftキーを押しながら8キー、9キーを押すことで、
ダブルクォーテーション"はShiftキーを押しながら2キーを押すことで入力することが出来ます。
セミコロン;は一般的なキーボードだとLキーの右にあります。
先程作成したHeliScriptExampleをダブルクリックすることで、エディタによるスクリプト編集画面が立ち上がるので、そちらを使いHeliScriptExampleの中身を
component HeliScriptExample
{
public HeliScriptExample()
{
hsSystemWriteLine("Hello World!"); // Hello World!をコンソールに出力
}
public void Update()
{
}
}
とします。
変更点は5行目にhsSystemWriteLineを追加したことです。
これで、Hello World!を出力するHeliScriptの準備が整いました。
HeliScriptをシーンに組み込む
HeliScriptをシーンに組み込むには、VKC Attribute Script Unityコンポーネントを使用します。
VKC Attribute Script Unityコンポーネントは、VKC Itemから始まるUnityコンポーネントを持ったオブジェクトに付けて使用することを推奨します。
今回は、VKC Item Field Unityコンポーネントを持つWorldオブジェクトに付けて使用します。
HierarchyビューでWorldオブジェクトを選択し、Inspectorビューの下部にある「Add Component」というボタンを選択します。
表示された検索欄に「vkca」などと入力すると、一覧にVKC Attribute Scriptが表示されるため、そちらを選択します。
選択後の画面は下記のようになります。
初期状態だと、コンポーネントのリストが空の状態になっているため、「+」ボタンを選択、
その後「選択」ボタンを押しHeliScript一覧からHeliScriptExampleを選択します。
すると、コンポーネント欄にもHeliScriptExampleが入力されます。
この状態になったら、シーン内にHeliScriptが組み込まれた状態になります。
Unityコンポーネントとコンポーネントは全くの別物です。
詳しくは用語集をご確認ください。
HeliScriptExample.hsを作る際、HeliScriptを作成した後にファイル名を変更した場合、コンポーネント欄に自動で入力される内容が異なる場合があります。
その場合、前章内にあるHeliScriptExampleのコード全文をコピーし、上書きして使用してください。
コンソールを閲覧できるようにする
このままビルドしても、コンソールをワールドの画面から閲覧することは出来ません。
ワールド画面にコンソールを表示するためには、BasicSettingsが持つVKC Setting Baseにて、「デバッグモード」にチェックを入れる必要があります。
この状態でビルドを行うことにより、画面上部にステータスとコンソールが表示されるようになります。
コンソールは画面上部に表示されている文字列の最下部になります。
※下記画像の場合、「Version：」から始まる行まではコンソールではありません。
Hello World!の表示が確認出来たら、HeliScriptのシーンへの組み込みの出来上がりです。
次 : ③ HeliScriptをシーンに組み込む / シーンから取り外す
前 : ① HeliScriptを作成する環境を作る