Documentation Index
Fetch the complete documentation index at: https://mintlify.com/rive-app/rive-ios/llms.txt
Use this file to discover all available pages before exploring further.
Overview
Rive events are notifications triggered during animation playback. The SDK provides three event classes: RiveEvent (base class), RiveGeneralEvent, and RiveOpenUrlEvent.
RiveEvent
The base class for all Rive events.
Methods
name
Returns the name of the event.
Returns: The event name as a string.
type
Returns the type identifier of the event.
Returns: An integer representing the event type.
delay
Returns the delay in seconds since the event was actually fired. This is applicable when events are fired from timeline animations.
Returns: The delay in seconds as a float.
properties
- (NSDictionary<NSString*, id>*)properties
RiveGeneralEvent
A general-purpose event that inherits from RiveEvent. Use this for custom events defined in your Rive animations.
@interface RiveGeneralEvent : RiveEvent
@end
RiveOpenUrlEvent
A specialized event for opening URLs, commonly used for interactive elements like buttons or links.
Methods
url
Returns the URL to open.
Returns: The URL string.
target
Returns the target value for opening the link (e.g., “_blank”, “_self”).
Returns: The target string.
Usage
// Listen for events from a state machine
let viewModel = RiveViewModel(fileName: "interactive_animation")
viewModel.setView(riveView) { view in
view.stateMachine?.addEventListener { event in
if let urlEvent = event as? RiveOpenUrlEvent {
print("Open URL: \(urlEvent.url())")
print("Target: \(urlEvent.target())")
// Open the URL
if let url = URL(string: urlEvent.url()) {
UIApplication.shared.open(url)
}
} else if let generalEvent = event as? RiveGeneralEvent {
print("General event: \(generalEvent.name())")
print("Properties: \(generalEvent.properties())")
}
// Access common properties
print("Event type: \(event.type())")
print("Event delay: \(event.delay())")
}
}
RiveEventReport
An auxiliary class for event reporting.
@interface RiveEventReport : NSObject
- (float)secondsDelay;
@end
Methods
secondsDelay
Returns the delay in seconds for the event report.