button_device class | Unreal Editor for Fortnite Documentation

This page is not available in the language you have chosen. It will be displayed in English by default. If you would like to view it in a different language, you can try selecting another language.

Used to create a button which can trigger other devices when an agent interacts with it.


Verse `using` statement	`using { /Fortnite.com/Devices }`

Inheritance Hierarchy

This class is derived from the following hierarchy, starting with creative_object:

Name	Description
`creative_object`	Base class for creative devices and props.
`creative_device_base`	Base class for creative_device.

Members

This class has both data members and functions.

Data

Data Member Name	Type	Description
`InteractedWithEvent`	`listenable(payload)`	Signaled when an `agent` successfully interacts with the button for `GetInteractionTime` seconds. Sends the `agent` that interacted with the button.

Functions

Function Name	Description
`Disable`	Disables this device.
`Enable`	Enables this device.
`GetInteractionTime`	Returns the duration of the interaction required to activate this device (in seconds).
`GetMaxTriggerCount`	Returns the maximum amount of times this button can be interacted with before it will be disabled. `GetTriggerMaxCount` will be between `0` and `10`. `0` indicates no limit on trigger count.
`GetTransform`	Returns the transform of the `creative_object` with units in cm. You must check `creative_object.IsValid` before calling this if there is a possibility the object has been disposed or destroyed by gameplay. Otherwise a runtime error will result.
`GetTriggerCountRemaining`	Returns the number of times that this button can still be interacted with before it will be disabled. Will return `0` if `GetMaxTriggerCount` is unlimited.
`MoveTo`	Moves the `creative_object` to the specified `Position` and `Rotation` over the specified time, in seconds. If an animation is currently playing on the `creative_object` it will be stopped and put into the `AnimationNotSet` state.
`MoveTo`	Moves the `creative_object` to the specified `Transform` over the specified time, in seconds. If an animation is currently playing on the `creative_object` it will be stopped and put into the `AnimationNotSet` state.
`SetInteractionText`	Sets the text that displays when an `agent` is close to this button and looks at it. `Text` is limited to `64` characters.
`SetInteractionTime`	Sets the duration of the interaction required to activate this device (in seconds).
`SetMaxTriggerCount`	Sets the maximum amount of times this button can be interacted with before it will be disabled. `MaxCount` must be between `0` and `10`. `0` indicates no limit on trigger count.
`TeleportTo`	Teleports the `creative_object` to the specified `Position` and `Rotation`.
`TeleportTo`	Teleports the `creative_object` to the specified location defined by `Transform`, also applies rotation and scale accordingly.