RealityFoundation · IOS API REFERENCE

ActionEventType

struct · iOS 18.0+ · SDK 27.1

struct ActionEventType

A set of events that an action responds to. Actions can respond to specific events with one or more custom event handlers that you associate with each event type. RealityKit calls the event handlers when the animation time enters, exits, or continues within a time interval for an ``ActionEventDefinition``. A time interval for an event begins at its starting time and spans up to, but doesn't include, the event's starting time plus its duration.

Members (9)

get · iOS 18.0+

terminated

TypeScript

get terminated(): ActionEventType

Swift declaration

static var terminated: ActionEventType { get }

An event that takes place when the animation ends.

get · iOS 18.0+

ended

TypeScript

get ended(): ActionEventType

Swift declaration

static var ended: ActionEventType { get }

An event that takes place when the action event exits its time interval. End is also raised when the animation terminates before the action event completes.

get · iOS 18.0+

paused

TypeScript

get paused(): ActionEventType

Swift declaration

static var paused: ActionEventType { get }

An event that takes place when the animation pauses.

get · iOS 18.0+

resumed

TypeScript

get resumed(): ActionEventType

Swift declaration

static var resumed: ActionEventType { get }

An event that takes place when the animation resumes after a pause.

get · iOS 18.0+

skipped

TypeScript

get skipped(): ActionEventType

Swift declaration

static var skipped: ActionEventType { get }

An event that takes place when the system misses an action event's time interval. RealityKit generates a skip event under the following conditions: - The current time is greater than or equal to the event's ending time. - The previous frame's time is less than the event's starting time.

get · iOS 18.0+

started

TypeScript

get started(): ActionEventType

Swift declaration

static var started: ActionEventType { get }

An event that takes place when a new action event begins.

get · iOS 18.0+

updated

TypeScript

get updated(): ActionEventType

Swift declaration

static var updated: ActionEventType { get }

An event that takes place after an action event starts and is within its time interval.

init · iOS 18.0+

init

TypeScript

init(rawValue: number): ActionEventType

Swift declaration

init(rawValue: UInt)

Creates an action event type from a raw value. - Parameters: - rawValue: The backing data value for force effect inputs.

get · iOS 18.0+

rawValue

TypeScript

getRawValue($self: ActionEventType): number

Swift declaration

let rawValue: UInt

The backing storage for action event types.

Skipped declarations

No declarations were skipped in this snapshot.

All RealityFoundation types →