VTI Targets - Revision history

Steeveeo: Added section about network ownership.

2024-02-16T10:47:13Z

Added section about network ownership.

← Older revision		Revision as of 10:47, 16 February 2024
Line 46:		Line 46:
	==== Readiness Validation ====		==== Readiness Validation ====
	Before firing, the [[VTI Event Handler]] will call <syntaxhighlight lang="csharp" inline>VTICheckCanFire()</syntaxhighlight> against the queued VTITarget. This will first check the current time against the Cooldown property, and then will loop through all attached [[VTI Drivers\|Driver]] component and call <syntaxhighlight lang="csharp" inline>VTICheckReady()</syntaxhighlight> on each. If any Driver returns <syntaxhighlight lang="csharp" inline>false</syntaxhighlight>, or the Cooldown has not yet elapsed, the Event is skipped and the process repeats for the next in line.		Before firing, the [[VTI Event Handler]] will call <syntaxhighlight lang="csharp" inline>VTICheckCanFire()</syntaxhighlight> against the queued VTITarget. This will first check the current time against the Cooldown property, and then will loop through all attached [[VTI Drivers\|Driver]] component and call <syntaxhighlight lang="csharp" inline>VTICheckReady()</syntaxhighlight> on each. If any Driver returns <syntaxhighlight lang="csharp" inline>false</syntaxhighlight>, or the Cooldown has not yet elapsed, the Event is skipped and the process repeats for the next in line.

			==== Network Ownership ====
			As a final step before firing, the [[VTI World Kit]] will attempt to take [https://creators.vrchat.com/worlds/udon/networking/ Ownership] of the GameObject. In order to prevent desynced cooldowns from double-firing or overriding another Streamer's [[VTI Events\|Events]], the VTITarget script will also refuse ownership transfer if it is still in use. Objects that the [[VTI World Kit]] cannot take Ownership of will stay on the queue until Ownership can be obtained. If this results in an [[VTI Events\|Event]] that never fires, check to make sure you don't have other things trying to keep Ownership of that object, e.g. scripts on a Pickup with the VRCObjectSync component attached.

	== User Messaging ==		== User Messaging ==

Steeveeo: Lots more info for VTITarget.

2024-02-13T06:57:11Z

Lots more info for VTITarget.

@@ Line 4: / Line 4: @@
 The VTITarget component is one of the core scripts for the [[VTI World Kit]]. It is used to identify a GameObject as something that can be interacted with  by Twitch viewers when running [[VRChat Twitch Integration]].
 == Properties ==
@@ Line 45: / Line 37: @@
 |-
 | VTIFire() || void || Trigger this Target. Forwards [[VTI Events|Event]] data to all attached [[VTI Drivers|Drivers]] and calls <syntaxhighlight lang="csharp" inline>Driver.VTIEventPlay()</syntaxhighlight> on each.
 |}

Steeveeo: More fleshing out of VTITarget.

2024-02-13T06:27:16Z

More fleshing out of VTITarget.

← Older revision		Revision as of 06:27, 13 February 2024
Line 4:		Line 4:

	The VTITarget component is one of the core scripts for the [[VTI World Kit]]. It is used to identify a GameObject as something that can be interacted with by Twitch viewers when running [[VRChat Twitch Integration]].		The VTITarget component is one of the core scripts for the [[VTI World Kit]]. It is used to identify a GameObject as something that can be interacted with by Twitch viewers when running [[VRChat Twitch Integration]].

			== Event Firing ==
			When the [[VTI Event Handler]] receives an [[VTI Events\|Event]] from the [[VTI Companion App]], it will enqueue it under the ID of the triggered Target. Once that Event is at the top of the Queue, the Event Handler will attempt to dispatch the Event data to the Target and then call <syntaxhighlight lang="csharp" inline>VTIFire()</syntaxhighlight>.

			Once Fired, the VTITarget will forward the Event data to each [[VTI Drivers\|Driver]] component within the same GameObject as the VTITarget component, and then call <syntaxhighlight lang="csharp" inline>VTIEventPlay()</syntaxhighlight> on each Driver.

			=== Readiness Validation ===
			Before firing, the [[VTI Event Handler]] will call <syntaxhighlight lang="csharp" inline>VTICheckCanFire()</syntaxhighlight> against the queued VTITarget. This will first check the current time against the Cooldown property, and then will loop through all attached [[VTI Drivers\|Driver]] component and call <syntaxhighlight lang="csharp" inline>VTICheckReady()</syntaxhighlight> on each. If any Driver returns <syntaxhighlight lang="csharp" inline>false</syntaxhighlight>, or the Cooldown has not yet elapsed, the Event is skipped and the process repeats for the next in line.

	== Properties ==		== Properties ==
	{\| class="wikitable"		{\| class="wikitable"
	\|+ ~~VTITarget~~		\|+ Properties
	\|-		\|-
	! Property !! Usage		! Property !! Usage
Line 17:		Line 25:
	\| Description \|\| A short sentence describing the usage of this Target. Used in the [[VTI Companion App]]'s Target editor and when generating Channel Point Rewards.		\| Description \|\| A short sentence describing the usage of this Target. Used in the [[VTI Companion App]]'s Target editor and when generating Channel Point Rewards.
	\|-		\|-
	\| Cooldown \|\| The number of seconds to wait before this Target can be fired again. Set this to at least as long as the events run by any attached [[~~VTI Driver\|~~VTI Drivers]] unless they are capable of being interrupted or overlapped.		\| Cooldown \|\| The number of seconds to wait before this Target can be fired again. Set this to at least as long as the events run by any attached [[VTI Drivers]] unless they are capable of being interrupted or overlapped.
	\|-		\|-
	\| Allow Message Input \|\| Enable this when any attached [[~~VTI Driver\|~~VTI Drivers]] expect User Messaging in order to function.		\| Allow Message Input \|\| Enable this when any attached [[VTI Drivers]] expect User Messaging in order to function.
	\|-		\|-
	\| Allow Event Type Rebinding \|\| If any attached [[~~VTI Driver\|~~VTI Drivers]] are specifically tailored to one specific event, disable this. For example: a Driver that expects a chat command with a specific argument will likely not work when set to SUBCRIBE_GIFT.		\| Allow Event Type Rebinding \|\| If any attached [[VTI Drivers]] are specifically tailored to one specific event, disable this. For example: a Driver that expects a chat command with a specific argument will likely not work when set to SUBCRIBE_GIFT.
	\|-		\|-
	\| Default Event Type \|\| What Twitch Event this Target should be fired on. This presents as a dropdown for all [https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types EventSub Subscription Types] currently supported by [[VRChat Twitch Integration\|VTI]].		\| Default Event Type \|\| What Twitch Event this Target should be fired on. This presents as a dropdown for all [https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types EventSub Subscription Types] currently supported by [[VRChat Twitch Integration\|VTI]].
	\|-		\|-
	\| Default Twitch Binding Settings \|\| This section is dynamically displayed based on which Event Type is selected. Use this area to tune exactly what parameters are required to fire this Target.		\| Default Twitch Binding Settings \|\| This section is dynamically displayed based on which Event Type is selected. Use this area to tune exactly what parameters are required to fire this Target.
			\|}

			== Methods ==
			{\| class="wikitable"
			\|+ Methods
			\|-
			! Method !! Return !! Usage
			\|-
			\| VTICheckCanFire() \|\| bool \|\| Check whether or not this Target is off cooldown and all attached [[VTI Drivers\|Drivers]] are reporting Ready.
			\|-
			\| VTIFire() \|\| void \|\| Trigger this Target. Forwards [[VTI Events\|Event]] data to all attached [[VTI Drivers\|Drivers]] and calls <syntaxhighlight lang="csharp" inline>Driver.VTIEventPlay()</syntaxhighlight> on each.
	\|}		\|}

Steeveeo: Initial setup save.

2024-02-13T05:26:41Z

Initial setup save.

New page

[[Category:VTI]]

[[File:VTITarget Inspector.png|thumb|400px|VTITarget's Inspector]]

The VTITarget component is one of the core scripts for the [[VTI World Kit]]. It is used to identify a GameObject as something that can be interacted with by Twitch viewers when running [[VRChat Twitch Integration]].

== Properties ==
{| class="wikitable"
|+ VTITarget
|-
! Property !! Usage
|-
| ID || The Unique Identifier for this Target. Used internally to dispatch [[VTI Events|Events]]. Must not match any other VTITargets in the scene or a warning will be thrown.
|-
| Display Name || The User-Friendly name for this Target. Used in the [[VTI Companion App]]'s Target editor and when generating Channel Point Rewards. Does not need to be unique.
|-
| Description || A short sentence describing the usage of this Target. Used in the [[VTI Companion App]]'s Target editor and when generating Channel Point Rewards.
|-
| Cooldown || The number of seconds to wait before this Target can be fired again. Set this to at least as long as the events run by any attached [[VTI Driver|VTI Drivers]] unless they are capable of being interrupted or overlapped.
|-
| Allow Message Input || Enable this when any attached [[VTI Driver|VTI Drivers]] expect User Messaging in order to function.
|-
| Allow Event Type Rebinding || If any attached [[VTI Driver|VTI Drivers]] are specifically tailored to one specific event, disable this. For example: a Driver that expects a chat command with a specific argument will likely not work when set to SUBCRIBE_GIFT.
|-
| Default Event Type || What Twitch Event this Target should be fired on. This presents as a dropdown for all [https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types EventSub Subscription Types] currently supported by [[VRChat Twitch Integration|VTI]].
|-
| Default Twitch Binding Settings || This section is dynamically displayed based on which Event Type is selected. Use this area to tune exactly what parameters are required to fire this Target.
|}