Steeveeo: Added VTIObjectInstantiate line. Also updated to new behavior on VTIObjectToggle.

2024-03-26T04:20:28Z

Added VTIObjectInstantiate line. Also updated to new behavior on VTIObjectToggle.

← Older revision		Revision as of 04:20, 26 March 2024
Line 46:		Line 46:
	\| [[VTIAnimTrigger]] \|\| Sets an Animator's Trigger input when Fired.		\| [[VTIAnimTrigger]] \|\| Sets an Animator's Trigger input when Fired.
	\|-		\|-
	\| [[VTIObjectToggle]] \|\| When Fired, this Driver will enable the target GameObject, wait for <syntaxhighlight lang="csharp" inline>ResetTime</syntaxhighlight> seconds, and then disable it again.		\| [[VTIObjectToggle]] \|\| When Fired, this Driver will enable the target GameObject, wait for <syntaxhighlight lang="csharp" inline>ResetTime</syntaxhighlight> seconds, and then optionally disable it again.
			\|-
			\| [[VTIObjectInstantiate]] \|\| Will instantiate a prefab copy when fired within a certain (zero-able) range of either the Streamer or the Target. These copies are not syncable, so do not use them for persistent items.
	\|-		\|-
	\| [[VTIRadialTripObjectToggle]] \|\| A version of [[VTIObjectToggle]] that will "arm" when Fired, and then wait for a Player to get within a set radius before enabling the target GameObject. Will report unready while Armed and not tripped.		\| [[VTIRadialTripObjectToggle]] \|\| A version of [[VTIObjectToggle]] that will "arm" when Fired, and then wait for a Player to get within a set radius before enabling the target GameObject. Will report unready while Armed and not tripped.

Steeveeo: Initial writeup.

2024-02-13T07:43:16Z

Initial writeup.

New page

[[Category:VTI]]

[[File:VTIDriver Inspector.png|thumb]]

In the [[VTI World Kit]], a Driver is a script that acts as an "Endpoint" for when an [[VTI Events|Event]] is received and fired. When attached to the same GameObject as a [[VTI Targets|VTITarget]] component, it will receive Event data when said target is Fired by [[VRChat Twitch Integration|VTI]].

Multiple Drivers can exist under the same [[VTI Targets|Target]], allowing multiple actions to be taken upon firing without needing a bespoke custom Driver.

All Drivers are, and must be, derived from the <syntaxhighlight lang="csharp" inline>VTIDriverBase</syntaxhighlight> base class. The base class includes all the below properties and methods when inherited.

== Properties ==
{| class="wikitable"
|+ Properties
|-
! Property !! Type !! Usage
|-
| UserName || string || The Twitch User Name of the user who triggered this [[VTI Events|Event]].
|-
| Message || string || The User Message, if applicable, that was sent with this [[VTI Events|Event]].
|-
| TriggerCause || string || The reason why this was triggered. Use this when Allow Event Type Rebinding is enabled on the [[VTI Targets|VTITarget]] to dynamically handle user-changed bindings.
|-
| TriggerAmount || int || What "value" is associated with this Event, i.e. how many bits cheered, subs gifted, tier subscribed, etc.
|-
| IsReady || bool || A helper variable to easily mark a Driver as "busy" and unable to refire. Unless overridden in the derived Driver, <syntaxhighlight lang="csharp" inline>VTICheckReady()</syntaxhighlight> will default to just returning this value.
|}

== Methods ==
{| class="wikitable"
|+ Methods
|-
! Method !! Return !! Usage
|-
| VTICheckReady() || bool || This method will be called by VTI just before attempting to fire the parent [[VTI Targets|VTITarget]]. Return <syntaxhighlight lang="csharp" inline>true</syntaxhighlight> if this is ready to be fired.
|-
| VTIEventPlay() || void || This method will be called by VTI when its parent [[VTI Targets|VTITarget]] is Fired.
|}

== Packaged Drivers ==

{| class="wikitable"
|+ Drivers Included With VTI
|-
! Driver !! Usage
|-
| [[VTIAnimTrigger]] || Sets an Animator's Trigger input when Fired.
|-
| [[VTIObjectToggle]] || When Fired, this Driver will enable the target GameObject, wait for <syntaxhighlight lang="csharp" inline>ResetTime</syntaxhighlight> seconds, and then disable it again.
|-
| [[VTIRadialTripObjectToggle]] || A version of [[VTIObjectToggle]] that will "arm" when Fired, and then wait for a Player to get within a set radius before enabling the target GameObject. Will report unready while Armed and not tripped.
|-
| [[VTIRunMethod]] || Utilizes <syntaxhighlight lang="csharp" inline>SendCustomEvent()</syntaxhighlight> to trigger a named method on the target UdonBehaviour when Fired. When User Messaging is enabled, this Driver will attempt to set the string variables <syntaxhighlight lang="csharp" inline>UserName</syntaxhighlight> and <syntaxhighlight lang="csharp" inline>Message</syntaxhighlight> on the target UdonBehaviour.
|}

== Custom Drivers ==
The [[VTI World Kit]] is designed to be easily extensible by both world designers and programmers alike. To this end, custom Drivers are highly recommended and are built to be fairly simple to create. A custom Driver need only implement one method, <syntaxhighlight lang="csharp" inline>VTIEventPlay()</syntaxhighlight>. All other functionality can be added around that, or is already handled by the VTIDriverBase base class.

For an in-depth tutorial on creating a custom Driver, see [[Creating Custom VTI Drivers]].

VTI Drivers - Revision history

Steeveeo: Added VTIObjectInstantiate line. Also updated to new behavior on VTIObjectToggle.

Steeveeo: Initial writeup.