en:vci:script:reference:vcimodule

vci_module (Reference(Auto exported))

vci_module (Reference(Auto exported))

ExportVci

vci module

-- global
vci

AddMethod

static function(mi: usertype)

Dispatch

function(typeName: string, method: string, bytes: usertype)

GetKey

function()
Return
string

studio

ExportStudio

me

ExportMe

assets

ExportAssets

state

ExportState

message

ExportMessage

ExportStudio

Studio information

GetKey

function()
Return
string

shared

ExportShared

ExportShared

Global Sync Variable

Bind

function(name: string, callback: usertype)

Set

function(name: string, value: usertype)

Add

function(name: string, value: usertype)

Get

function(name: string)
Return
usertype

GetKey

function()
Return
string

ExportMe

Local machine information

GetKey

function()
Return
string

FrameCount

number

Time

TimeSpan

UnscaledTime

TimeSpan

ExportAssets

Assets stored in VCI

ClearUpdates

function()

GetSubItem

function(name: string)
Return
ExportTransform

GetKey

function()
Return
string

IsMine

bool

audio

ExportAudio

SetMaterialColorFromIndex

function(index: number, color: Color)

_ALL_SetMaterialColorFromIndex

function(index: number, color: Color)

SetMaterialColorFromName

function(name: string, color: Color)

_ALL_SetMaterialColorFromName

function(name: string, color: Color)

SetMaterialTextureOffsetFromIndex

function(index: number, offset: Vector2)

_ALL_SetMaterialTextureOffsetFromIndex

function(index: number, offset: Vector2)

SetMaterialTextureOffsetFromName

function(name: string, offset: Vector2)

_ALL_SetMaterialTextureOffsetFromName

function(name: string, offset: Vector2)

PlayAnimationFromIndex

function(index: number, isloop: bool)

_ALL_PlayAnimationFromIndex

function(index: number, isloop: bool)

PlayAnimationFromName

function(name: string, isloop: bool)

_ALL_PlayAnimationFromName

function(name: string, isloop: bool)

StopAnimation

function()

_ALL_StopAnimation

function()

PlayAudioFromIndex

function(index: number)

_ALL_PlayAudioFromIndex

function(index: number)

PlayAudioFromName

function(name: string)

_ALL_PlayAudioFromName

function(name: string)

PauseAudioFromIndex

function(index: number, isPause: bool)

_ALL_PauseAudioFromIndex

function(index: number, isPause: bool)

PauseAudioFromName

function(name: string, isPause: bool)

_ALL_PauseAudioFromName

function(name: string, isPause: bool)

StopAudioFromIndex

function(index: number)

_ALL_StopAudioFromIndex

function(index: number)

StopAudioFromName

function(name: string)

_ALL_StopAudioFromName

function(name: string)

HapticPulseOnGrabbingController

function(target: string, strength: number, duration: number)

_ALL_HapticPulseOnGrabbingController

function(target: string, strength: number, duration: number)

HapticPulseOnTouchingController

function(target: string, strength: number, duration: number)

_ALL_HapticPulseOnTouchingController

function(target: string, strength: number, duration: number)

ExportState

Item Sync Variable

Set

function(name: string, value: usertype)

Add

function(name: string, value: usertype)

Get

function(name: string)
Return
usertype

GetKey

function()
Return
string

ExportAudio

Audio

GetKey

function()
Return
string

Play

function(name: string, volumeScale: number, isLoop: bool)

_ALL_Play

function(name: string, volumeScale: number, isLoop: bool)

PlayFromIndex

function(index: number, volumeScale: number, isLoop: bool)

_ALL_PlayFromIndex

function(index: number, volumeScale: number, isLoop: bool)

PlayOneShot

function(name: string, volumeScale: number)

_ALL_PlayOneShot

function(name: string, volumeScale: number)

PlayOneShotFromIndex

function(index: number, volumeScale: number)

_ALL_PlayOneShotFromIndex

function(index: number, volumeScale: number)

Stop

function(name: string)

_ALL_Stop

function(name: string)

StopFromIndex

function(index: number)

_ALL_StopFromIndex

function(index: number)

Pause

function(name: string, isPause: bool)

_ALL_Pause

function(name: string, isPause: bool)

PauseFromIndex

function(index: number, isPause: bool)

_ALL_PauseFromIndex

function(index: number, isPause: bool)

ExportMessage

Message (event) system

__new

function(enqueue: usertype, target: usertype)
Return
ExportMessage

On

function(messageName: string, callback: usertype)

Emit

function(messageName: string, value: usertype)

GetKey

function()
Return
string

ExportTransform

SubItem

__new

function(enqueue: usertype, item: usertype, target: usertype, bind: usertype)
Return
ExportTransform

GetName

function()
Return
string

GetLocalPosition

function()
Return
Vector3

GetPosition

function()
Return
Vector3

GetLocalRotation

function()
Return
Quaternion

GetRotation

function()
Return
Quaternion

GetLocalScale

function()
Return
Vector3

GetRight

function()
Return
Vector3

GetUp

function()
Return
Vector3

GetForward

function()
Return
Vector3

GetLocalToWorldMatrix

function()
Return
Matrix4x4

GetKey

function()
Return
string

IsMine

bool

SetPosition

function(position: Vector3)

SetRotation

function(rotation: Quaternion)

SetLocalPosition

function(localPosition: Vector3)

SetLocalRotation

function(localRotation: Quaternion)

SetLocalScale

function(localScale: Vector3)

SetVelocity

function(velocity: Vector3)

SetAngularVelocity

function(angularVelocity: Vector3)

AddForce

function(force: Vector3)
en/vci/script/reference/vcimodule.txt · Last modified: 2021/11/18 17:58 by numa

Page Tools