スタジオ内の情報を取得するのに必要な関数です。
主にアイテムの状態に関する情報を取得したり、VCIスクリプトでアイテムを操作するのに使用します。
バーチャルキャストのアイテムについてはアイテムについてから確認してください。

バーチャルキャストのプリセットアイテムごとにHas関数とGet関数が存在します。

• Has関数 : スタジオ内にアイテムが存在するか確認する関数
• Get関数 : アイテムのインスタンスを取得する関数

スタジオにアイテムが存在しないのにGetしてしまうとnullになるので、Has関数の結果がtrueの時のみGetするようにします。
また、2019/08/29 時点では凸者も取り出し可能なアイテムに関しては取得する事ができません。

ExportStudioでインスタンス化したオブジェクトを操作します。

※1
SetPosition, SetRotation, SetLocalPosition, SetLocalRotation は部屋主が出したVCIからのみ実行可能です。

ExportStudioでインスタンス化したカメラを操作します。
基本的にSystemItemと同じですが、カメラ固有の関数(GetFieldOfView等)が存在します。

※1
SetPosition, SetRotation, SetLocalPosition, SetLocalRotation, SetFieldOfView は部屋主が出したVCIからのみ実行可能です。

※2
FOV設定可能なカメラは下図の通りです。GetMinFieldOfView、GetMaxFieldOfViewで取得可能な最小値、最大値を超えた値は設定できません。

また、これらの関数で扱う値は垂直視野角で、単位は度です。

カメラのプレビューに表示される焦点距離はFOVから算出されています。カメラを任意の焦点距離に設定したい場合は、次の計算によって対応するFOVを導出してください。

$$ FOV = \frac{360}{\pi} \times \arctan{\left(\frac{D}{x \times 2 \sqrt{a^{2}+1}}\right)} \\ \text{x: 35mm判換算焦点距離[mm]} \\ \text{a: カメラのアスペクト比 (基本的に16/9)} \\ \text{D: 35mmフルサイズセンサーの対角長 (≒43.27[mm])} \\ $$

CameraPositionResetというSubItemをgrabした時に、ハンディカメラの位置を(0,1,0)の位置にリセットするサンプルです。

スタジオの中にハンディカメラが存在しない状態で vci.studio.GetHandiCamera() を実行してしまうと、エラーになります。
なので vci.studio.HasHandiCamera() == false でハンディカメラが存在しない場合は return をして処理を終了します。

vci.studio.HasHandiCamera() == true の場合は return が実行されずに camera.SetPosition(position) の行までいくので、カメラがリセットされます。
なので、アイテムが存在するか確認するHas関数の後に、アイテムをインスタンス化するGet関数を実行する必要があります。

main.lua

function onUse(use)
    -- PositionResetをUseした時
    if use == "CameraPositionReset" then
        -- カメラの位置をリセットする
        CameraPositionReset()
    end
end
 
function CameraPositionReset()
    -- ハンディカメラが存在しない場合終了する
    if vci.studio.HasHandiCamera() == false then
        print("ハンディカメラが存在しないので終了")
        return
    end
 
    -- リセットする座標
    local position = Vector3.__new(0, 1, 0)
    -- カメラのインスタンス
    local camera = vci.studio.GetHandiCamera()
    -- カメラの位置を変更
    camera.SetPosition(position)
    print("カメラの位置　："..tostring(camera.GetPosition()))
end

カメラの位置 : (0,1,0)
(カメラの座標がワールド座標で(0,1,0)の位置に移動します)

ケースバイケースではありますが Has関数がfalseの場合にreturnする という書き方を推奨します。
trueの場合に実行する でも問題ないのですが、変数のスコープがif文の中になってしまうこと、さらにif文がネストする可能性が大きいです。
Has関数がfalseの場合に処理をしない という事は確実に言える事なので、先頭にその処理を持ってくる事で分かりやすくします。
このようなプログラム書き方をガード節といいます。