ユーザ用ツール

サイト用ツール


en:vci:script:reference:exportstudio

差分

この文書の現在のバージョンと選択したバージョンの差分を表示します。

この比較画面にリンクする

両方とも前のリビジョン 前のリビジョン
en:vci:script:reference:exportstudio [2019/10/10 16:48]
h-eguchi 以前のリビジョンを復元 (2019/08/29 18:15)
en:vci:script:reference:exportstudio [2019/11/08 11:02] (現在)
h-eguchi 以前のリビジョンを復元 (2019/10/10 16:26)
ライン 1: ライン 1:
-====== vci.studio(ExportStudio)&​(ExportSystemItem) ======+====== vci.studio(ExportStudio)&​(Scripts for preset items) ======
 \\ \\
 A function required to get pieces of information in the studio.\\ A function required to get pieces of information in the studio.\\
ライン 14: ライン 14:
  
 Has functions and Get functions exist for each of the preset items in VirtualCast.\\ Has functions and Get functions exist for each of the preset items in VirtualCast.\\
-Has function is a function to check if the item exists ​in the studio and Get function is a function to acquire the instance of an item.\\+Has function is a function to check if the item exist in the studio and Get function is a function to acquire the instance of an item.\\
 Using Get on items that don't exist in the studio will give you null, so only use Get when the result of the Has function is true.\\ Using Get on items that don't exist in the studio will give you null, so only use Get when the result of the Has function is true.\\
 Note that, as of 29th August 2019, items that can also be spawned by guests cannot be acquired.\\ Note that, as of 29th August 2019, items that can also be spawned by guests cannot be acquired.\\
ライン 22: ライン 22:
 | GetMic fun(): ExportSystemItem | Instantiate a [[en:​virtualcast:​item:​microphone|microphone]] | | GetMic fun(): ExportSystemItem | Instantiate a [[en:​virtualcast:​item:​microphone|microphone]] |
 | HasMic fun(): bool | True when a [[en:​virtualcast:​item:​microphone|microphone]] exists in the studio | | HasMic fun(): bool | True when a [[en:​virtualcast:​item:​microphone|microphone]] exists in the studio |
-| GetLightSource fun(): ExportSystemItem | Instantiate a [[en:virtualcast:​item:​lightsource|lightsource]] |+| GetLightSource fun(): ExportSystemItem | Instantiate a [[virtualcast:​item:​lightsource|lightsource]] |
 | HasLightSource fun(): bool | True when a [[en:​virtualcast:​item:​lightsource|lightsource]] exists in the studio | | HasLightSource fun(): bool | True when a [[en:​virtualcast:​item:​lightsource|lightsource]] exists in the studio |
 | GetMirror fun(): ExportSystemItem | Instantiate a [[en:​virtualcast:​item:​mirror|mirror]] | | GetMirror fun(): ExportSystemItem | Instantiate a [[en:​virtualcast:​item:​mirror|mirror]] |
ライン 57: ライン 57:
 | GetForward fun(): Vector3 | The vector of the forward direction (+Z) of an item | | GetForward fun(): Vector3 | The vector of the forward direction (+Z) of an item |
 | GetLocalToWorldMatrix fun(): Matrix4x4 | Matrix when converting from the local coordinate to the world coordinate of an item | | GetLocalToWorldMatrix fun(): Matrix4x4 | Matrix when converting from the local coordinate to the world coordinate of an item |
-| SetPosition fun(position:​ Vector3): number | Change the position of an item\\ (World coordinate) ​1 | +| SetPosition fun(position:​ Vector3): number | Change the position of an item\\ (World coordinate) ​** *1** 
-| SetRotation fun(rotation:​ Quaternion):​ number | Change the rotation of an item\\ (World coordinate) ​1 | +| SetRotation fun(rotation:​ Quaternion):​ number | Change the rotation of an item\\ (World coordinate) ​** *1** 
-| SetLocalPosition fun(localPosition:​ Vector3): number | Change the position of an item\\ (Local coordinate) ​1 | +| SetLocalPosition fun(localPosition:​ Vector3): number | Change the position of an item\\ (Local coordinate) ​** *1** 
-| SetLocalRotation fun(localRotation:​ Quaternion):​ number | Change the rotation of an item\\ (Local coordinate) ​1 |+| SetLocalRotation fun(localRotation:​ Quaternion):​ number | Change the rotation of an item\\ (Local coordinate) ​** *1** |
 | IsGrabbed fun(): bool | True when grabbed | | IsGrabbed fun(): bool | True when grabbed |
 | GetHashCode fun(): number | Generate a hash value | | GetHashCode fun(): number | Generate a hash value |
 | ToString fun(): string | Convert a SystemItem into a string| | ToString fun(): string | Convert a SystemItem into a string|
  
-1\\ +** *1**\\ 
-''​SetPosition''​ ''​SetRotation''​ ''​SetLocalPosition''​ ''​SetLocalRotation''​ are only valid on the VCIs spawned by the studio ​owner.\\+''​SetPosition''​ ''​SetRotation''​ ''​SetLocalPosition''​ ''​SetLocalRotation''​ are **only executable from VCIs spawned by the room owner themself.\\ **\\
  
 ---- ----
ライン 78: ライン 78:
 | _new fun(interactableItemController:​ usertype, controller: usertype): ExportSystemItem |  | | _new fun(interactableItemController:​ usertype, controller: usertype): ExportSystemItem |  |
 | GetFieldOfView fun(): number | Get the field of view (FOV) of the camera | | GetFieldOfView fun(): number | Get the field of view (FOV) of the camera |
 +| SetFieldOfView fun(fov: number): number | Change the field of view (FOV) of the camera ** *1** ** *2** |
 +| GetMinFieldOfView fun(): number | Get the minimum field of view (FOV) of the camera |
 +| GetMaxFieldOfView fun(): number | Get the maximum field of view (FOV) of the camera |
 | GetName fun(): string | Get the name of an item. | GetName fun(): string | Get the name of an item.
 | GetLocalPosition fun(): Vector3 | Get the position of an item\\ (The origin point is the local coordinate at the time of spawn ) | | GetLocalPosition fun(): Vector3 | Get the position of an item\\ (The origin point is the local coordinate at the time of spawn ) |
ライン 88: ライン 91:
 | GetForward fun(): Vector3 | The vector of the forward direction (+Z) of an item | | GetForward fun(): Vector3 | The vector of the forward direction (+Z) of an item |
 | GetLocalToWorldMatrix fun(): Matrix4x4 | Matrix when converting from the local coordinate to the world coordinate of an item | | GetLocalToWorldMatrix fun(): Matrix4x4 | Matrix when converting from the local coordinate to the world coordinate of an item |
-| SetPosition fun(position:​ Vector3): number | Change the position of an item\\ (World coordinate) ​1 | +| SetPosition fun(position:​ Vector3): number | Change the position of an item\\ (World coordinate) ​** *1** 
-| SetRotation fun(rotation:​ Quaternion):​ number | Change the rotation of an item\\ (World coordinate) ​1 | +| SetRotation fun(rotation:​ Quaternion):​ number | Change the rotation of an item\\ (World coordinate) ​** *1** 
-| SetLocalPosition fun(localPosition:​ Vector3): number | Change the position of an item\\ (Local coordinate) ​1 | +| SetLocalPosition fun(localPosition:​ Vector3): number | Change the position of an item\\ (Local coordinate) ​** *1** 
-| SetLocalRotation fun(localRotation:​ Quaternion):​ number | Change the rotation of an item\\ (Local coordinate) ​1 |+| SetLocalRotation fun(localRotation:​ Quaternion):​ number | Change the rotation of an item\\ (Local coordinate) ​** *1** |
 | IsGrabbed fun(): bool | True when grabbed | | IsGrabbed fun(): bool | True when grabbed |
 | GetHashCode fun(): number | Generate a hash value | | GetHashCode fun(): number | Generate a hash value |
 | ToString fun(): string | Convert a SystemItem into a string| | ToString fun(): string | Convert a SystemItem into a string|
  
-1\\ +** *1**\\ 
-''​SetPosition''​ ''​SetRotation''​ ''​SetLocalPosition''​ ''​SetLocalRotation''​ are only valid on the VCIs spawned by the studio ​owner.\\+''​SetPosition''​''​SetRotation''​''​SetLocalPosition''​''​SetLocalRotation'' ​and "​SetFieldOfView" ​are **only executable from VCIs spawned by the room owner themself.\\ **\\ 
 + 
 +** *2**\\ 
 +Bellow is the list of the cameras that can have the FOV specified. You cannot specify a value that exceeds the value acquirable with GetMinFieldOfView and GetMaxFieldOfView. 
 + 
 +^ Camera name ^ FOV setting ^ 
 +| Camera monitor | No | 
 +| Handy camera | Yes | 
 +| Tracking camera | Yes | 
 +| Switching camera | No |
  
 ---- ----
ライン 159: ライン 171:
 It's a case-by-case,​ but it is recommended to use **when Has function is false, then return** idiom.\\ It's a case-by-case,​ but it is recommended to use **when Has function is false, then return** idiom.\\
 While there is no big deal with **when true, then do this** strategy, it tends to result in variables being kept inside the scope of the if statement. It could also result in if statements nested inside the if statement.\\ While there is no big deal with **when true, then do this** strategy, it tends to result in variables being kept inside the scope of the if statement. It could also result in if statements nested inside the if statement.\\
-**When Has function is false, then don't do this** is more definitive, so we recommend you to bring this in the front.\\+**When Has function is false, then don't do this" ​is more definitive, so we recommend you to bring this in the front.\\
 This way of writing a program is called the Guard.\\ This way of writing a program is called the Guard.\\
  
 ---- ----
 +
  
  
en/vci/script/reference/exportstudio.txt · 最終更新: 2019/11/08 11:02 by h-eguchi

ページ用ツール