Events¶
The Events module.
Interact¶
-
Event_Interact
()¶
outputs: none
flow inputs: unnamed
flow outputs: unnamed
Fired when a VRChat player interacts with this object.
OnAnimatorIK¶
-
Event_OnAnimatorIK
()¶
outputs: layerIndex (Int32
)
flow inputs: unnamed
flow outputs: unnamed
OnCollisionEnter¶
-
Event_OnCollisionEnter
()¶
outputs: other (Collision
)
flow inputs: unnamed
flow outputs: unnamed
OnCollisionEnter2D¶
-
Event_OnCollisionEnter2D
()¶
outputs: other (Collision2D
)
flow inputs: unnamed
flow outputs: unnamed
OnCollisionExit¶
-
Event_OnCollisionExit
()¶
outputs: other (Collision
)
flow inputs: unnamed
flow outputs: unnamed
OnCollisionExit2D¶
-
Event_OnCollisionExit2D
()¶
outputs: other (Collision2D
)
flow inputs: unnamed
flow outputs: unnamed
OnCollisionStay¶
-
Event_OnCollisionStay
()¶
outputs: other (Collision
)
flow inputs: unnamed
flow outputs: unnamed
OnCollisionStay2D¶
-
Event_OnCollisionStay2D
()¶
outputs: other (Collision2D
)
flow inputs: unnamed
flow outputs: unnamed
OnControllerColliderHit¶
-
Event_OnControllerColliderHit
()¶
outputs: hit (ControllerColliderHit
)
flow inputs: unnamed
flow outputs: unnamed
OnDeserialization¶
-
Event_OnDeserialization
()¶
outputs: none
flow inputs: unnamed
flow outputs: unnamed
OnDrop¶
-
Event_OnDrop
()¶
outputs: none
flow inputs: unnamed
flow outputs: unnamed
Fired when a VRChat player drops this object after being held.
OnJointBreak¶
-
Event_OnJointBreak
()¶
outputs: breakForce (Single
)
flow inputs: unnamed
flow outputs: unnamed
OnJointBreak2D¶
-
Event_OnJointBreak2D
()¶
outputs: brokenJoint (Joint2D
)
flow inputs: unnamed
flow outputs: unnamed
OnMouseUpAsButton¶
-
Event_OnMouseUpAsButton
()¶
outputs: none
flow inputs: unnamed
flow outputs: unnamed
OnOwnershipTransferred¶
-
Event_OnOwnershipTransferred
()¶
outputs: none
flow inputs: unnamed
flow outputs: unnamed
Fired when the ownership of this object is transferred via some mechanic.
OnParticleCollision¶
-
Event_OnParticleCollision
()¶
outputs: other (GameObject
)
flow inputs: unnamed
flow outputs: unnamed
OnParticleTrigger¶
-
Event_OnParticleTrigger
()¶
outputs: none
flow inputs: unnamed
flow outputs: unnamed
OnPickup¶
-
Event_OnPickup
()¶
outputs: none
flow inputs: unnamed
flow outputs: unnamed
Fired when this object is picked up by a VRChat player.
OnPickupUseDown¶
-
Event_OnPickupUseDown
()¶
outputs: none
flow inputs: unnamed
flow outputs: unnamed
Fired when this object is held and the Use button is pressed. Fires on button down.
OnPickupUseUp¶
-
Event_OnPickupUseUp
()¶
outputs: none
flow inputs: unnamed
flow outputs: unnamed
Fired when this object is held and the Use button is pressed. Fires on button up.
OnPlayerJoined¶
-
Event_OnPlayerJoined
()¶
outputs: player (VRCPlayerApi
)
flow inputs: unnamed
flow outputs: unnamed
Fired when a VRChat player joins the instance. Outputs the player that joined.
OnPlayerLeft¶
-
Event_OnPlayerLeft
()¶
outputs: player (VRCPlayerApi
)
flow inputs: unnamed
flow outputs: unnamed
Fired when a VRChat player leaves the instance. Outputs the player that left.
OnPreSerialization¶
-
Event_OnPreSerialization
()¶
outputs: none
flow inputs: unnamed
flow outputs: unnamed
OnRenderImage¶
-
Event_OnRenderImage
()¶
outputs: src (RenderTexture
), dest (RenderTexture
)
flow inputs: unnamed
flow outputs: unnamed
OnSpawn¶
-
Event_OnSpawn
()¶
outputs: none
flow inputs: unnamed
flow outputs: unnamed
Fired when this object spawns for the local player. Unbuffered, so late joiners do not get this event. Only fires when the object is spawned via network instantiation. Will not fire if the object is present in the base scene.
OnStationEntered¶
-
Event_OnStationEntered
()¶
outputs: none
flow inputs: unnamed
flow outputs: unnamed
Fired when a VRChat player enters the station on this object.
OnStationExited¶
-
Event_OnStationExited
()¶
outputs: none
flow inputs: unnamed
flow outputs: unnamed
Fired when a VRChat player exits the station on this object.
OnTransformChildrenChanged¶
-
Event_OnTransformChildrenChanged
()¶
outputs: none
flow inputs: unnamed
flow outputs: unnamed
OnTransformParentChanged¶
-
Event_OnTransformParentChanged
()¶
outputs: none
flow inputs: unnamed
flow outputs: unnamed
OnTriggerEnter¶
-
Event_OnTriggerEnter
()¶
outputs: other (Collider
)
flow inputs: unnamed
flow outputs: unnamed
OnTriggerEnter2D¶
-
Event_OnTriggerEnter2D
()¶
outputs: other (Collider2D
)
flow inputs: unnamed
flow outputs: unnamed
OnTriggerExit¶
-
Event_OnTriggerExit
()¶
outputs: other (Collider
)
flow inputs: unnamed
flow outputs: unnamed
OnTriggerExit2D¶
-
Event_OnTriggerExit2D
()¶
outputs: other (Collider2D
)
flow inputs: unnamed
flow outputs: unnamed
OnTriggerStay¶
-
Event_OnTriggerStay
()¶
outputs: other (Collider
)
flow inputs: unnamed
flow outputs: unnamed
OnTriggerStay2D¶
-
Event_OnTriggerStay2D
()¶
outputs: other (Collider2D
)
flow inputs: unnamed
flow outputs: unnamed
OnVideoEnd¶
-
Event_OnVideoEnd
()¶
outputs: none
flow inputs: unnamed
flow outputs: unnamed
Fired when the video player on this object is finished playing, either via the end of the video or via player interaction.
OnVideoPause¶
-
Event_OnVideoPause
()¶
outputs: none
flow inputs: unnamed
flow outputs: unnamed
Fired when the video player on this object is paused.
OnVideoPlay¶
-
Event_OnVideoPlay
()¶
outputs: none
flow inputs: unnamed
flow outputs: unnamed
Fired when the video player on this object starts playback, either via the start of a new video in a queue, unpausing, or via player interaction.
OnVideoStart¶
-
Event_OnVideoStart
()¶
outputs: none
flow inputs: unnamed
flow outputs: unnamed
Fired when the video player on this object starts playback from a stopped state.
OnWillRenderObject¶
-
Event_OnWillRenderObject
()¶
outputs: none
flow inputs: unnamed
flow outputs: unnamed