SetEntityEnabledAction

struct · iOS 18.0+ · SDK 27.1

struct SetEntityEnabledAction

An action that enables or disables the targeted entity and its descendants when played as an animation. This action toggles the ``SetEntityEnabledAction/targetEntity`` ``Entity/isEnabled`` flag. Use the animation generated from this action within an animation group to determine when the entity should be enabled, and visible in the scene. The example below creates an animation which disables the entity after five seconds. In this example, the target entity starts enabled. ```swift // Create an action entity resolution. // // The animation will be played from the parent entity. let childEntity: ActionEntityResolution = .entityNamed("childEntity") // Create an action to disable the entity. let disableEntityAction = SetEntityEnabledAction(targetEntity: childEntity, isEnabled: false) // Create a small positive duration value. let duration: TimeInterval = 1 / 30.0 // Create an animation to disable the target entity. let disableEntityAnimation = try AnimationResource .makeActionAnimation(for: disableEntityAction, duration: duration, delay: 5.0) // Play the sequence animation that plays the actions. rootEntity.playAnimation(disableEntityAnimation) ``` @Video( source: setentityenabled-action, alt: "A screen recording of a red cube in a living room scene. At the start, the cube is visibly enabled in the scene. After some time, the cube is disabled; it's no longer visible in the scene.", poster: setentityenabled-action-poster ) - Note: Animations do not play on entities that are disabled. In order to disable, and enable the target entity, play this action on another entity, such as a root entity, or its parent. - Important: This action does not animate a bound property, such as ``BindTarget/transform``. - Tip: This action performs instantaneously, consider supplying a small positive duration value when creating the animation.

Members (5)

get isEnabled(): boolean

var isEnabled: Bool

set isEnabled(value: boolean)

var isEnabled: Bool

static init(targetEntity: ActionEntityResolution, isEnabled: boolean): SetEntityEnabledAction

init(targetEntity: ActionEntityResolution = .sourceEntity, isEnabled: Bool)

get targetEntity(): ActionEntityResolution

var targetEntity: ActionEntityResolution

set targetEntity(value: ActionEntityResolution)

var targetEntity: ActionEntityResolution

All RealityFoundation types →