diff --git a/editor/events/overview.mdx b/editor/events/overview.mdx index 1bda7a46..bfe8dfb2 100644 --- a/editor/events/overview.mdx +++ b/editor/events/overview.mdx @@ -1,12 +1,19 @@ --- title: 'Events Overview' sidebarTitle: 'Overview' -description: '' +description: "⚠️ DEPRECATED: Use Data Binding instead of Events" --- +import { YouTube } from "/snippets/youtube.mdx"; - - If you're using [Data Binding](/editor/data-binding), you can listen for triggers or value changes from your code without needing Events. - + + **DEPRECATION NOTICE:** This entire page documents the legacy Events system. + **For new projects:** Use [Data Binding](/runtimes/data-binding) instead. + **For existing projects:** Plan to migrate from Events to Data Binding as soon + as possible. **This content is provided for legacy support only.** + + + + Events are a way to send signals to your runtime code to execute a block of code at the right moment. They enhance the communication between designers and developers by passing along useful information. With them, we can do things like go to a URL, play a sound, have some HTML appear, or do anything else we may want to accomplish via code. diff --git a/game-runtimes/unity/rive-events.mdx b/game-runtimes/unity/rive-events.mdx index 2ae42fd4..e8507927 100644 --- a/game-runtimes/unity/rive-events.mdx +++ b/game-runtimes/unity/rive-events.mdx @@ -6,9 +6,11 @@ noindex: true import LegacyDataBindingNotice from '/snippets/unity/legacy-databinding-notice.mdx'; import LegacyApiNotice from '/snippets/unity/legacy-api-notice.mdx'; +import { YouTube } from "/snippets/youtube.mdx"; + For more information on Rive Events see the respective runtime and editor documentation. diff --git a/runtimes/rive-events.mdx b/runtimes/rive-events.mdx index 9d200293..2ecf7c7a 100644 --- a/runtimes/rive-events.mdx +++ b/runtimes/rive-events.mdx @@ -13,6 +13,8 @@ import { YouTube } from "/snippets/youtube.mdx"; as possible. **This content is provided for legacy support only.** + + With Rive events, you have the ability to subscribe to meaningful signals that get reported from animations, state machines, and Rive listeners, all created at design time from the Rive editor. These signals can be subscribed to at runtime and have a specific name, type, and various custom metadata that may accompany the event to help inform the context surrounding its meaning. For more on the Events feature in general, check out the [Events](/editor/events/overview) page in the editor section of the docs. The Event system has also been expanded to support [Audio Events ](/editor/events/audio-events)to trigger audio to play in the editor and at runtime.